ost::IPV6Address - The network name and address objects are all derived from a common IPV6Address base
Contents
Constructor & Destructor Documentation
ost::IPV6Address::IPV6Address(constIPV6Validator*validator=NULL)
Create an Internet Address object with an empty (0.0.0.0) address.
Parametersvalidator optional validator function object, intended for derived classes.
ost::IPV6Address::IPV6Address(structin6_addraddr,constIPV6Validator*validator=NULL)
Convert the system internet address data type (struct in_addr) into a Common C++ IPV6Address object.
Parametersaddr struct of system used binary internet address.
validator optional validator function object, intended for derived classes.
ost::IPV6Address::IPV6Address(constchar*address,constIPV6Validator*validator=NULL)
Convert a null terminated ASCII host address string (example: '127.0.0.1') or host address name (example:
'www.voxilla.org') directly into a Common C++ IPV6Address object.
Parametersaddress null terminated C string.
validator optional validator function object, intended for derived classes.
ost::IPV6Address::IPV6Address(constIPV6Address&rhs)
Copy constructor.
virtualost::IPV6Address::~IPV6Address()[virtual]
Destructor.
Detailed Description
The network name and address objects are all derived from a common IPV6Address base class.
Specific classes, such as IPV4Host, IPV6Mask, etc, are defined from IPV6Address entirely so that the
manner a network address is being used can easily be documented and understood from the code and to avoid
common errors and accidental misuse of the wrong address object. For example, a 'connection' to something
that is declared as a 'IPV6Host' can be kept type-safe from a 'connection' accidently being made to
something that was declared a 'IPV6Broadcast'.
Author
David Sugar dyfet@ostel.com
Internet Address binary data type.
Member Data Documentation
size_tost::IPV6Address::addr_count[protected]char*ost::IPV6Address::hostname[mutable],[protected]structin6_addr*ost::IPV6Address::ipaddr[protected]Mutexost::IPV6Address::mutex[static],[protected]
Member Function Documentation
structin6_addrost::IPV6Address::getAddress(size_ti)const
Provide a low level system usable struct in_addr object from the contents of IPV6Address. This is needed
for services such as bind() and connect().
Parametersi for IPV6Addresses with multiple addresses, returns the address at this index. User should call
getAddressCount() to determine the number of address the object contains.
Returns
system binary coded internet address. If parameter i is out of range, the first address is returned.
structin6_addrost::IPV6Address::getAddress(void)const
Provide a low level system usable struct in_addr object from the contents of IPV6Address. This is needed
for services such as bind() and connect().
Returns
system binary coded internet address.
size_tost::IPV6Address::getAddressCount()const[inline]
Returns the number of internet addresses that an IPV6Address object contains. This usually only happens
with IPV6Host objects where multiple IP addresses are returned for a DNS lookup
constchar*ost::IPV6Address::getHostname(void)const
Provide a string representation of the value (Internet Address) held in the IPV6Address object.
Returns
string representation of IPV6Address.
boolost::IPV6Address::isInetAddress(void)const
May be used to verify if a given IPV6Address returned by another function contains a 'valid' address, or
'0.0.0.0' which is often used to mark 'invalid' IPV6Address values.
Returns
true if address != 0.0.0.0.
boolost::IPV6Address::operator!()const[inline]boolost::IPV6Address::operator!=(constIPV6Address&a)const
Compare two internet addresses to see if they are not equal (if they each refer to unique and different
physical ip addresses). This is implimented in terms of operator==
IPV6Address&ost::IPV6Address::operator=(constchar*str)IPV6Address&ost::IPV6Address::operator=(constIPV6Address&rhs)IPV6Address&ost::IPV6Address::operator=(structin6_addraddr)boolost::IPV6Address::operator==(constIPV6Address&a)const
Compare two internet addresses to see if they are equal (if they specify the physical address of the same
internet host). If there is more than one IP address in either IPV6Address object, this will return true
if all of the IP addresses in the smaller are in the larger in any order.
voidost::IPV6Address::setAddress(constchar*host)[protected]
Used to specify a host name or numeric internet address.
Parametershost The string representation of the IP address or a hostname, , if NULL, it will default to
INADDR_ANY
boolost::IPV6Address::setIPAddress(constchar*host)[protected]
Sets the IP address from a string representation of the numeric address, ie '127.0.0.1'.
Parametershost The string representation of the IP address
Returns
true if successful
Name
ost::IPV6Address - The network name and address objects are all derived from a common IPV6Address base
class.
Synopsis
#include <address.h>
Inherited by ost::IPV6Broadcast, ost::IPV6Host, ost::IPV6Mask, and ost::IPV6Multicast.
PublicMemberFunctionsIPV6Address (const IPV6Validator *validator=NULL)
Create an Internet Address object with an empty (0.0.0.0) address.
IPV6Address (struct in6_addr addr, const IPV6Validator *validator=NULL)
Convert the system internet address data type (struct in_addr) into a Common C++ IPV6Address object.
IPV6Address (const char *address, const IPV6Validator *validator=NULL)
Convert a null terminated ASCII host address string (example: '127.0.0.1') or host address name
(example: 'www.voxilla.org') directly into a Common C++ IPV6Address object.
IPV6Address (const IPV6Address &rhs)
Copy constructor.
virtual ~IPV6Address ()
Destructor.
const char * getHostname (void) const
Provide a string representation of the value (Internet Address) held in the IPV6Address object.
bool isInetAddress (void) const
May be used to verify if a given IPV6Address returned by another function contains a 'valid' address,
or '0.0.0.0' which is often used to mark 'invalid' IPV6Address values.
struct in6_addr getAddress (void) const
Provide a low level system usable struct in_addr object from the contents of IPV6Address.
struct in6_addr getAddress (size_t i) const
Provide a low level system usable struct in_addr object from the contents of IPV6Address.
size_t getAddressCount () const
Returns the number of internet addresses that an IPV6Address object contains.
IPV6Address & operator= (const char *str)
IPV6Address & operator= (struct in6_addr addr)
IPV6Address & operator= (const IPV6Address &rhs)
bool operator! () const
bool operator== (const IPV6Address &a) const
Compare two internet addresses to see if they are equal (if they specify the physical address of the
same internet host).
bool operator!= (const IPV6Address &a) const
Compare two internet addresses to see if they are not equal (if they each refer to unique and
different physical ip addresses).
ProtectedMemberFunctions
bool setIPAddress (const char *host)
Sets the IP address from a string representation of the numeric address, ie '127.0.0.1'.
void setAddress (const char *host)
Used to specify a host name or numeric internet address.
ProtectedAttributes
struct in6_addr * ipaddr
size_t addr_count
char * hostnameStaticProtectedAttributes
static Mutexmutex