ucommon
Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes
ost::IPV4Address Class Reference

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

#include <address.h>

Inheritance diagram for ost::IPV4Address:
Inheritance graph
[legend]

Public Member Functions

struct in_addr getAddress (void)
 Provide a low level system usable struct in_addr object from the contents of IPV4Address.
struct in_addr getAddress (size_t i)
 Provide a low level system usable struct in_addr object from the contents of IPV4Address.
size_t getAddressCount ()
 Returns the number of internet addresses that an IPV4Address object contains.
char * getHostname (void)
 Provide a string representation of the value (Internet Address) held in the IPV4Address object.
 IPV4Address (IPV4Validator *validator=((void *) 0))
 Create an Internet Address object with an empty (0.0.0.0) address.
 IPV4Address (struct in_addr addr, IPV4Validator *validator=((void *) 0))
 Convert the system internet address data type (struct in_addr) into a Common C++ IPV4Address object.
 IPV4Address (char *address, IPV4Validator *validator=((void *) 0))
 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++ IPV4Address object.
 IPV4Address (IPV4Address &rhs)
 Copy constructor.
bool isInetAddress (void)
 May be used to verify if a given IPV4Address returned by another function contains a "valid" address, or "0.0.0.0" which is often used to mark "invalid" IPV4Address values.
bool operator! ()
bool operator!= (IPV4Address &a)
 Compare two internet addresses to see if they are not equal (if they each refer to unique and different physical ip addresses).
IPV4Addressoperator= (char *str)
IPV4Addressoperator= (struct in_addr addr)
IPV4Addressoperator= (IPV4Address &rhs)
IPV4Addressoperator= (unsigned long addr)
 Allows assignment from the return of functions like inet_addr() or htonl()
IPV4Addressoperator= (unsigned int addr)
bool operator== (IPV4Address &a)
 Compare two internet addresses to see if they are equal (if they specify the physical address of the same internet host).
virtual ~IPV4Address ()
 Destructor.

Protected Member Functions

void setAddress (char *host)
 Used to specify a host name or numeric internet address.
bool setIPAddress (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 in_addr * ipaddr

Static Protected Attributes

static Mutex mutex

Detailed Description

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

Specific classes, such as IPV4Host, IPV4Mask, etc, are defined from IPV4Address 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 "IPV4Host" can be kept type-safe from a "connection" accidently being made to something that was declared a "IPV4Broadcast".

Author:
David Sugar <dyfet@ostel.com> Internet Address binary data type.

Definition at line 332 of file address.h.


Constructor & Destructor Documentation

ost::IPV4Address::IPV4Address ( IPV4Validator validator = ((void *) 0))

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

Parameters:
validatoroptional validator function object, intended for derived classes.
ost::IPV4Address::IPV4Address ( struct in_addr  addr,
IPV4Validator validator = ((void *) 0) 
)

Convert the system internet address data type (struct in_addr) into a Common C++ IPV4Address object.

Parameters:
addrstruct of system used binary internet address.
validatoroptional validator function object, intended for derived classes.
ost::IPV4Address::IPV4Address ( char *  address,
IPV4Validator validator = ((void *) 0) 
)

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++ IPV4Address object.

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

Member Function Documentation

struct in_addr ost::IPV4Address::getAddress ( void  ) [read]

Provide a low level system usable struct in_addr object from the contents of IPV4Address.

This is needed for services such as bind() and connect().

Returns:
system binary coded internet address.
struct in_addr ost::IPV4Address::getAddress ( size_t  i) [read]

Provide a low level system usable struct in_addr object from the contents of IPV4Address.

This is needed for services such as bind() and connect().

Parameters:
ifor IPV4Addresses 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::IPV4Address::getAddressCount ( ) [inline]

Returns the number of internet addresses that an IPV4Address object contains.

This usually only happens with IPV4Host objects where multiple IP addresses are returned for a DNS lookup

Definition at line 454 of file address.h.

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

Returns:
string representation of IPV4Address.

May be used to verify if a given IPV4Address returned by another function contains a "valid" address, or "0.0.0.0" which is often used to mark "invalid" IPV4Address values.

Returns:
true if address != 0.0.0.0.
bool ost::IPV4Address::operator!= ( IPV4Address a)

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==

bool ost::IPV4Address::operator== ( IPV4Address a)

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 IPV4Address object, this will return true if all of the IP addresses in the smaller are in the larger in any order.

void ost::IPV4Address::setAddress ( 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
bool ost::IPV4Address::setIPAddress ( 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

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