UCommon
ost::IPV6Address Class Reference

The network name and address objects are all derived from a common IPV6Address base class. More...

#include <address.h>

Inheritance diagram for ost::IPV6Address:

Public Member Functions

struct in6_addr getAddress (size_t i) const
 Provide a low level system usable struct in_addr object from the contents of IPV6Address.
 
struct in6_addr getAddress (void) 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.
 
const char * getHostname (void) const
 Provide a string representation of the value (Internet Address) held in the 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.
 
 IPV6Address (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.
 
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.
 
 operator bool () const
 
bool operator! () const
 
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).
 
IPV6Addressoperator= (const char *str)
 
IPV6Addressoperator= (const IPV6Address &rhs)
 
IPV6Addressoperator= (struct in6_addr addr)
 
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).
 
virtual ~IPV6Address ()
 Destructor.
 

Protected Member Functions

void setAddress (const char *host)
 Used to specify a host name or numeric internet address.
 
bool setIPAddress (const char *host)
 Sets the IP address from a string representation of the numeric address, ie "127.0.0.1".
 

Protected Attributes

size_t addr_count
 
char * hostname
 
struct in6_addr * ipaddr
 

Static Protected Attributes

static Mutex mutex
 

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.nosp@m.@ost.nosp@m.el.co.nosp@m.m

Internet Address binary data type.

Definition at line 777 of file address.h.

Constructor & Destructor Documentation

◆ IPV6Address() [1/3]

ost::IPV6Address::IPV6Address ( const IPV6Validator * validator = NULL)

Create an Internet Address object with an empty (0.0.0.0) address.

Parameters
validatoroptional validator function object, intended for derived classes.

◆ IPV6Address() [2/3]

ost::IPV6Address::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.

Parameters
addrstruct of system used binary internet address.
validatoroptional validator function object, intended for derived classes.

◆ IPV6Address() [3/3]

ost::IPV6Address::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.

Parameters
addressnull terminated C string.
validatoroptional validator function object, intended for derived classes.

Member Function Documentation

◆ getAddress() [1/2]

struct in6_addr ost::IPV6Address::getAddress ( size_t i) 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().

Parameters
ifor 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.

◆ getAddress() [2/2]

struct in6_addr ost::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.

◆ getAddressCount()

size_t ost::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

Definition at line 899 of file address.h.

◆ getHostname()

const char * ost::IPV6Address::getHostname ( void ) const

Provide a string representation of the value (Internet Address) held in the IPV6Address object.

Returns
string representation of IPV6Address.

◆ isInetAddress()

bool ost::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.

◆ operator bool()

ost::IPV6Address::operator bool ( ) const
inline

Definition at line 907 of file address.h.

◆ operator!()

bool ost::IPV6Address::operator! ( ) const
inline

Definition at line 911 of file address.h.

◆ operator!=()

bool ost::IPV6Address::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).

This is implimented in terms of operator==

◆ operator==()

bool ost::IPV6Address::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).

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.

◆ setAddress()

void ost::IPV6Address::setAddress ( const char * host)
protected

Used to specify a host name or numeric internet address.

Parameters
hostThe string representation of the IP address or a hostname, , if NULL, it will default to INADDR_ANY

◆ setIPAddress()

bool ost::IPV6Address::setIPAddress ( const char * host)
protected

Sets the IP address from a string representation of the numeric address, ie "127.0.0.1".

Parameters
hostThe string representation of the IP address
Returns
true if successful

Field Documentation

◆ addr_count

size_t ost::IPV6Address::addr_count
protected

Definition at line 789 of file address.h.

◆ hostname

char* ost::IPV6Address::hostname
mutableprotected

Definition at line 790 of file address.h.

◆ ipaddr

struct in6_addr* ost::IPV6Address::ipaddr
protected

Definition at line 788 of file address.h.

◆ mutex

Mutex ost::IPV6Address::mutex
staticprotected

Definition at line 794 of file address.h.


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