ost::IPV6Mask(3) Library Functions Manual ost::IPV6Mask(3)NAME
ost::IPV6Mask -
Internet addresses used specifically as masking addresses (such as '
255.255.255.0') are held in the IPV6Mask derived object.
SYNOPSIS
#include <address.h>
Inherits ost::IPV6Address.
Public Member Functions
IPV6Mask (const char *mask)
Create the mask from a null terminated ASCII string such as '255.255.255.128'.
Friends
__EXPORT IPV6Host operator& (const IPV6Host &addr, const IPV6Mask &mask)
Masks are usually used to coerce host addresses into a specific router or class domain.
Additional Inherited Members
Detailed Description
Internet addresses used specifically as masking addresses (such as '
255.255.255.0') are held in the IPV6Mask derived object.
The separate class is used so that C++ type casting can automatically determine when an IPV6Address object is really a mask address object
rather than simply using the base class. This also allows manipulative operators for address masking to operate only when presented with a
Masked address as well as providing cleaner and safer source.
Author:
David Sugar dyfet@ostel.com Internet Address Mask such as subnet masks.
Constructor &; Destructor Documentation
ost::IPV6Mask::IPV6Mask (const char *mask)
Create the mask from a null terminated ASCII string such as '255.255.255.128'. Parameters:
mask null terminated ASCII mask string.
Friends And Related Function Documentation
__EXPORT IPV6Host operator& (const IPV6Host &addr, const IPV6Mask &mask) [friend]
Masks are usually used to coerce host addresses into a specific router or class domain. This can be done by taking the Inet Host Address
object and 'and'ing it with an address mask. This operation can be directly expressed in C++ through the & operator.
Returns:
a internet host address that has been masked.
Parameters:
addr host address to be masked by subnet.
mask inetnet mask address object to mask by.
Author
Generated automatically by Doxygen for GNU CommonC++ from the source code.
GNU CommonC++ Sat Jun 23 2012 ost::IPV6Mask(3)
Check Out this Related Man Page
ost::IPV6Address(3) Library Functions Manual ost::IPV6Address(3)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.
Public Member Functions
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.
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).
Protected Member Functions
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.
Protected Attributes
struct in6_addr * ipaddr
size_t addr_count
char * hostname
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@ostel.com Internet Address binary data type.
Constructor &; Destructor Documentation
ost::IPV6Address::IPV6Address (const IPV6Validator *validator = NULL)
Create an Internet Address object with an empty (0.0.0.0) address. Parameters:
validator optional validator function object, intended for derived classes.
ost::IPV6Address::IPV6Address (struct in6_addraddr, const IPV6Validator *validator = NULL)
Convert the system internet address data type (struct in_addr) into a Common C++ IPV6Address object. Parameters:
addr struct of system used binary internet address.
validator optional validator function object, intended for derived classes.
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:
address null terminated C string.
validator optional validator function object, intended for derived classes.
ost::IPV6Address::IPV6Address (const IPV6Address &rhs)
Copy constructor.
virtual ost::IPV6Address::~IPV6Address () [virtual]
Destructor.
Member Function Documentation
struct in6_addr ost::IPV6Address::getAddress (void) const [read]
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.
struct in6_addr ost::IPV6Address::getAddress (size_ti) const [read]
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:
i 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.
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
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.
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.
bool ost::IPV6Address::operator! () const [inline]
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==
IPV6Address& ost::IPV6Address::operator= (const char *str)
IPV6Address& ost::IPV6Address::operator= (struct in6_addraddr)
IPV6Address& ost::IPV6Address::operator= (const IPV6Address &rhs)
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.
void ost::IPV6Address::setAddress (const char *host) [protected]
Used to specify a host name or numeric internet address. Parameters:
host The string representation of the IP address or a hostname, , if NULL, it will default to INADDR_ANY
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:
host The string representation of the IP address
Returns:
true if successful
Member Data Documentation
size_t ost::IPV6Address::addr_count [protected]
char* ost::IPV6Address::hostname [mutable], [protected]
struct in6_addr* ost::IPV6Address::ipaddr [protected]
Mutex ost::IPV6Address::mutex [static], [protected]
Author
Generated automatically by Doxygen for GNU CommonC++ from the source code.
GNU CommonC++ Sat Jun 23 2012 ost::IPV6Address(3)