This object is used to hold the actual and valid internet address of a specific host machine that will be accessed through a socket. More...

#include <address.h>

Inheritance diagram for IPV4Host:

[legend]

Collaboration diagram for IPV4Host:

[legend]

Public Member Functions
	IPV4Host (const char *host=NULL)
	Create a new host address for a specific internet host. More...

	IPV4Host (struct in_addr addr)
	Convert a system socket binary address such as may be returned through the accept() call or getsockpeer() into an internet host address object. More...

IPV4Address &	operator= (unsigned long addr)
	Allows assignment from the return of functions like inet_addr() or htonl() More...

IPV4Host &	operator&= (const IPV4Mask &mask)
	Mask the internet host address object with a network mask address. More...

const char *	getHostname (void) const
	Provide a string representation of the value (Internet Address) held in the IPV4Address object. More...

bool	isInetAddress (void) const
	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. More...

struct in_addr	getAddress (void) const
	Provide a low level system usable struct in_addr object from the contents of IPV4Address. More...

struct in_addr	getAddress (size_t i) const
	Provide a low level system usable struct in_addr object from the contents of IPV4Address. More...

size_t	getAddressCount () const
	Returns the number of internet addresses that an IPV4Address object contains. More...

bool	operator! () const

bool	operator== (const IPV4Address &a) const
	Compare two internet addresses to see if they are equal (if they specify the physical address of the same internet host). More...

bool	operator!= (const IPV4Address &a) const
	Compare two internet addresses to see if they are not equal (if they each refer to unique and different physical ip addresses). More...

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". More...

void	setAddress (const char *host)
	Used to specify a host name or numeric internet address. More...

Protected Attributes
struct in_addr *	ipaddr

size_t	addr_count

char *	hostname

Static Protected Attributes
static Mutex	mutex

Static Private Attributes
static IPV4Host	_host_

Friends
class __EXPORT	IPV4Mask

__EXPORT IPV4Host	operator& (const IPV4Host &addr, const IPV4Mask &mask)

Detailed Description

This object is used to hold the actual and valid internet address of a specific host machine that will be accessed through a socket.

Author: David Sugar dyfet.nosp@m.@ost.nosp@m.el.co.nosp@m.m Address of a specific Internet host machine.

Definition at line 561 of file address.h.

Constructor & Destructor Documentation

IPV4Host::IPV4Host ( const char * host = NULL )

Create a new host address for a specific internet host.

The internet host can be specified in a null terminated ASCII string and include either the physical host address or the DNS name of a host machine. Hence, an IPV4Host ("www.voxilla.org") can be directly declaired in this manner.

Defaults to the IP address that represents the interface matching "gethostname()".

Parameters

host	dns or physical address of an Internet host.

IPV4Host::IPV4Host ( struct in_addr addr )

Convert a system socket binary address such as may be returned through the accept() call or getsockpeer() into an internet host address object.

Parameters

addr	binary address of internet host.

Member Function Documentation

struct in_addr IPV4Address::getAddress ( void ) const

inherited

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 IPV4Address::getAddress ( size_t i ) const

inherited

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

i	for 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 IPV4Address::getAddressCount ( ) const

inlineinherited

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 472 of file address.h.

const char* IPV4Address::getHostname ( void ) const

inherited

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

Returns: string representation of IPV4Address.

bool IPV4Address::isInetAddress ( void ) const

inherited

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 IPV4Address::operator! ( ) const

inlineinherited

Definition at line 487 of file address.h.

bool IPV4Address::operator!= ( const IPV4Address & a ) const

inherited

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

IPV4Host& IPV4Host::operator&= ( const IPV4Mask & mask )

Mask the internet host address object with a network mask address.

This is commonly used to coerce an address by subnet.

IPV4Address& IPV4Host::operator= ( unsigned long addr )

inline

Allows assignment from the return of functions like inet_addr() or htonl()

Definition at line 594 of file address.h.

bool IPV4Address::operator== ( const IPV4Address & a ) const

inherited

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 IPV4Address::setAddress ( const char * host )

protectedinherited

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 IPV4Address::setIPAddress ( const char * host )

protectedinherited

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

Friends And Related Function Documentation

friend class __EXPORT IPV4Mask

friend

Definition at line 603 of file address.h.

__EXPORT IPV4Host operator&	(	const IPV4Host &	addr,
		const IPV4Mask &	mask
	)

friend

Field Documentation

IPV4Host IPV4Host::_host_

staticprivate

Definition at line 564 of file address.h.

size_t IPV4Address::addr_count

protectedinherited

Definition at line 362 of file address.h.

char* IPV4Address::hostname

mutableprotectedinherited

Definition at line 363 of file address.h.

struct in_addr* IPV4Address::ipaddr

protectedinherited

Definition at line 361 of file address.h.

Mutex IPV4Address::mutex

staticprotectedinherited

Definition at line 367 of file address.h.

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

address.h

Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Static Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Field Documentation