ariba::addressing::ip_address Class Reference

#include <source/ariba/utility/addressing/ip_address.hpp>

Inherits address_convenience< ip_address >.

Collaboration diagram for ariba::addressing::ip_address:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 ip_address ()
 ip_address (const ip_address &copy)
 ip_address (const address &addr)
 ip_address (const address_v4 &addr)
 ip_address (const address_v6 &addr)
 ip_address (const std::string &text)
 ip_address (const char *text)
 ip_address (const uint8_t *bytes, size_t size)
int compare_to (const ip_address &rhs) const
 implements comparison operators
bool is_bytes_size_static () const
 returns true, if this address has a fixed size in bytes
size_t to_bytes_size () const
 returns the number of bytes used for serialization of this address
void to_bytes (uint8_t *bytes) const
 converts this address to a binary representation
bool assign (const uint8_t *bytes, size_t size)
 Assigns an address using a bunch of bytes.
std::string to_string () const
 convert address to a string that can be used to reconstruct the address
bool assign (const std::string &text)
 Assigns an address using a human-readable.
bool assign (const ip_address &rhs)
 Assigns an address.
bool is_multicast () const
bool is_loopback () const
bool is_link_local () const
bool is_multicast_link_local () const
bool is_multicast_node_local () const
bool is_multicast_site_local () const
bool is_any () const
bool is_v4_compatible () const
bool is_v4_mapped ()
bool is_v4 () const
bool is_v6 () const
const address & asio () const
void asio (const address &addr)

Static Public Member Functions

static const std::string & type_name ()
static const uint16_t type_id ()

Private Attributes

address addr

Static Private Attributes

static const std::string type_name_ip = "ip"


Detailed Description

TODO: Doc

Author:
Sebastian Mies <mies@tm.uka.de>

Definition at line 22 of file ip_address.hpp.


Constructor & Destructor Documentation

ariba::addressing::ip_address::ip_address (  )  [inline]

Definition at line 28 of file ip_address.hpp.

ariba::addressing::ip_address::ip_address ( const ip_address copy  )  [inline]

Definition at line 31 of file ip_address.hpp.

ariba::addressing::ip_address::ip_address ( const address &  addr  )  [inline]

Definition at line 35 of file ip_address.hpp.

ariba::addressing::ip_address::ip_address ( const address_v4 &  addr  )  [inline]

Definition at line 39 of file ip_address.hpp.

ariba::addressing::ip_address::ip_address ( const address_v6 &  addr  )  [inline]

Definition at line 43 of file ip_address.hpp.

ariba::addressing::ip_address::ip_address ( const std::string &  text  )  [inline]

Definition at line 47 of file ip_address.hpp.

References assign().

ariba::addressing::ip_address::ip_address ( const char *  text  )  [inline]

Definition at line 51 of file ip_address.hpp.

References assign().

ariba::addressing::ip_address::ip_address ( const uint8_t *  bytes,
size_t  size 
) [inline]

Definition at line 55 of file ip_address.hpp.

References assign().


Member Function Documentation

void ariba::addressing::ip_address::asio ( const address &  addr  )  [inline]

Definition at line 201 of file ip_address.hpp.

const address& ariba::addressing::ip_address::asio (  )  const [inline]

bool ariba::addressing::ip_address::assign ( const ip_address rhs  )  [inline]

Assigns an address.

Definition at line 123 of file ip_address.hpp.

References addr.

bool ariba::addressing::ip_address::assign ( const std::string &  text  )  [inline]

Assigns an address using a human-readable.

Definition at line 115 of file ip_address.hpp.

References addr.

bool ariba::addressing::ip_address::assign ( const uint8_t *  bytes,
size_t  size 
) [inline]

Assigns an address using a bunch of bytes.

Definition at line 91 of file ip_address.hpp.

References addr.

Referenced by ariba::addressing::tcpip_endpoint::assign(), and ip_address().

int ariba::addressing::ip_address::compare_to ( const ip_address rhs  )  const [inline]

implements comparison operators

Definition at line 62 of file ip_address.hpp.

References addr.

Referenced by ariba::addressing::tcpip_endpoint::compare_to().

bool ariba::addressing::ip_address::is_any (  )  const [inline]

Definition at line 172 of file ip_address.hpp.

References addr.

bool ariba::addressing::ip_address::is_bytes_size_static (  )  const [inline]

returns true, if this address has a fixed size in bytes

Definition at line 70 of file ip_address.hpp.

bool ariba::addressing::ip_address::is_link_local (  )  const [inline]

Definition at line 150 of file ip_address.hpp.

References addr.

Referenced by ariba::communication::AddressDiscovery::discover_ip_addresses().

bool ariba::addressing::ip_address::is_loopback (  )  const [inline]

Definition at line 145 of file ip_address.hpp.

References addr.

Referenced by ariba::communication::AddressDiscovery::discover_ip_addresses().

bool ariba::addressing::ip_address::is_multicast (  )  const [inline]

Definition at line 140 of file ip_address.hpp.

References addr.

bool ariba::addressing::ip_address::is_multicast_link_local (  )  const [inline]

Definition at line 155 of file ip_address.hpp.

References addr.

bool ariba::addressing::ip_address::is_multicast_node_local (  )  const [inline]

Definition at line 161 of file ip_address.hpp.

References addr.

bool ariba::addressing::ip_address::is_multicast_site_local (  )  const [inline]

Definition at line 167 of file ip_address.hpp.

References addr.

bool ariba::addressing::ip_address::is_v4 (  )  const [inline]

Definition at line 187 of file ip_address.hpp.

References addr.

bool ariba::addressing::ip_address::is_v4_compatible (  )  const [inline]

Definition at line 177 of file ip_address.hpp.

References addr.

bool ariba::addressing::ip_address::is_v4_mapped (  )  [inline]

Definition at line 182 of file ip_address.hpp.

References addr.

bool ariba::addressing::ip_address::is_v6 (  )  const [inline]

Definition at line 191 of file ip_address.hpp.

References addr.

void ariba::addressing::ip_address::to_bytes ( uint8_t *  bytes  )  const [inline]

converts this address to a binary representation

Definition at line 80 of file ip_address.hpp.

References addr.

Referenced by ariba::addressing::tcpip_endpoint::to_bytes().

size_t ariba::addressing::ip_address::to_bytes_size (  )  const [inline]

returns the number of bytes used for serialization of this address

Definition at line 75 of file ip_address.hpp.

References addr.

Referenced by ariba::addressing::tcpip_endpoint::to_bytes(), ariba::addressing::tcpip_endpoint::to_bytes_size(), and ariba::addressing::endpoint_set::to_bytes_size().

std::string ariba::addressing::ip_address::to_string (  )  const [inline]

convert address to a string that can be used to reconstruct the address

Definition at line 110 of file ip_address.hpp.

References addr.

Referenced by ariba::transport::convert(), boost::hash< ariba::addressing::ip_address >::operator()(), and ariba::addressing::tcpip_endpoint::to_string().

static const uint16_t ariba::addressing::ip_address::type_id (  )  [inline, static]

Definition at line 134 of file ip_address.hpp.

static const std::string& ariba::addressing::ip_address::type_name (  )  [inline, static]

Definition at line 130 of file ip_address.hpp.

References type_name_ip.


Member Data Documentation

const std::string ariba::addressing::ip_address::type_name_ip = "ip" [static, private]

Definition at line 25 of file ip_address.hpp.

Referenced by type_name().


The documentation for this class was generated from the following files:

Generated on Fri Aug 14 23:39:14 2009 for Ariba by  doxygen 1.5.8