|
|
The network name and address objects are all derived from a common InetAddress base class. Specific classes, such as InetHostAddress, InetMaskAddress, etc, are defined from InetAddress 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 "InetHostAddress" can be kept type-safe from a "connection" accidently being made to something that was declared a "InetBroadcastAddress".
struct in_addr * ipaddr | ipaddr |
[protected]
size_t addr_count | addr_count |
[protected]
static Mutex mutex | mutex |
[protected]
bool setIPAddress (const char *host)
| setIPAddress |
[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
void setAddress (const char *host)
| setAddress |
[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 |
InetAddress (const InetAddrValidator *validator = NULL)
| InetAddress |
Create an Internet Address object with an empty (0.0.0.0) address.
Parameters:
optional | validator function object, intended for derived classes. |
InetAddress (struct in_addr addr, const InetAddrValidator *validator = NULL)
| InetAddress |
Convert the system internet address data type (struct in_addr) into a Common C++ InetAddress object.
Parameters:
addr | struct of system used binary internet address. |
optional | validator function object, intended for derived classes. |
InetAddress (const char *address, const InetAddrValidator *validator = NULL)
| InetAddress |
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++ InetAddress object.
Parameters:
address | null terminated C string. |
optional | validator function object, intended for derived classes. |
InetAddress (const InetAddress &rhs)
| InetAddress |
Copy constructor
~InetAddress ()
| ~InetAddress |
[virtual]
Destructor
const char * getHostname (void)
| getHostname |
[const]
Provide a string representation of the value (Internet Address) held in the InetAddress object.
Returns: string representation of InetAddress.
bool isInetAddress (void)
| isInetAddress |
[const]
May be used to verify if a given InetAddress returned by another function contains a "valid" address, or "0.0.0.0" which is often used to mark "invalid" InetAddress values.
Returns: true if address != 0.0.0.0.
struct in_addr getAddress (void)
| getAddress |
[const]
Provide a low level system usable struct in_addr object from the contents of InetAddress. This is needed for services such as bind() and connect().
Returns: system binary coded internet address.
struct in_addr getAddress (size_t i)
| getAddress |
[const]
Provide a low level system usable struct in_addr object from the contents of InetAddress. This is needed for services such as bind() and connect().
Parameters:
i | for InetAddresses 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 getAddressCount ()
| getAddressCount |
[const]
Returns the number of internet addresses that an InetAddress object contains. This usually only happens with InetHostAddress objects where multiple IP addresses are returned for a DNS lookup
InetAddress & operator= (const char *str)
| operator= |
InetAddress & operator= (struct in_addr addr)
| operator= |
InetAddress & operator= (const InetAddress &rhs)
| operator= |
InetAddress & operator= (unsigned long addr)
| operator= |
Allows assignment from the return of functions like inet_addr() or htonl()
inline bool operator! ()
| operator! |
[const]
bool operator== (const InetAddress &a)
| operator== |
[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 InetAddress object, this will return true if all of the IP addresses in the smaller are in the larger in any order.
bool operator!= (const InetAddress &a)
| operator!= |
[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==