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:

Collaboration diagram for ost::IPV4Address:

Public Member Functions
	IPV4Address (const IPV4Validator *validator=NULL)
	Create an Internet Address object with an empty (0.0.0.0) address. More...
	IPV4Address (struct in_addr addr, const IPV4Validator *validator=NULL)
	Convert the system internet address data type (struct in_addr) into a Common C++ IPV4Address object. More...
	IPV4Address (const char *address, const IPV4Validator *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++ IPV4Address object. More...
	IPV4Address (const IPV4Address &rhs)
	Copy constructor. More...
virtual	~IPV4Address ()
	Destructor. 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...
IPV4Address &	operator= (const char *str)
IPV4Address &	operator= (struct in_addr addr)
IPV4Address &	operator= (const IPV4Address &rhs)
IPV4Address &	operator= (in_addr_t addr)
	Allows assignment from the return of functions like inet_addr() or htonl() More...
	operator bool () const
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

Private Attributes
const IPV4Validator *	validator

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

Internet Address binary data type.

Definition at line 362 of file address.h.

Constructor & Destructor Documentation

IPV4Address() [1/4]

ost::IPV4Address::IPV4Address

(

const IPV4Validator *

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.

Definition at line 97 of file address.cpp.

IPV4Address() [2/4]

ost::IPV4Address::IPV4Address	(	struct in_addr	addr,
		const IPV4Validator *	validator = NULL
	)

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

Parameters

addr	struct of system used binary internet address.
validator	optional validator function object, intended for derived classes.

Definition at line 112 of file address.cpp.

References ucommon::addr(), addr_count, ipaddr, and validator.

Here is the call graph for this function:

IPV4Address() [3/4]

ost::IPV4Address::IPV4Address	(	const char *	address,
		const IPV4Validator *	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++ IPV4Address object.

Parameters

address	null terminated C string.
validator	optional validator function object, intended for derived classes.

Definition at line 103 of file address.cpp.

References setAddress().

Here is the call graph for this function:

IPV4Address() [4/4]

ost::IPV4Address::IPV4Address

(

const IPV4Address &

rhs

)

Copy constructor.

Definition at line 123 of file address.cpp.

References addr_count, and ipaddr.

~IPV4Address()

ost::IPV4Address::~IPV4Address ( )

virtual

Destructor.

Definition at line 130 of file address.cpp.

References ost::delString(), hostname, and ipaddr.

Here is the call graph for this function:

Member Function Documentation

getAddress() [1/2]

struct in_addr ost::IPV4Address::getAddress

(

size_t

i

)

const

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.

Definition at line 147 of file address.cpp.

getAddress() [2/2]

struct in_addr ost::IPV4Address::getAddress

(

void

)

const

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.

Definition at line 142 of file address.cpp.

Referenced by ost::UDPTransmit::cConnect(), ost::UDPReceive::connect(), ost::DCCPSocket::connect(), ost::TCPStream::connect(), ost::IPV4Host::operator&=(), ost::UDPBroadcast::setPeer(), ost::UDPSocket::setPeer(), and ost::TCPSession::TCPSession().

getAddressCount()

size_t ost::IPV4Address::getAddressCount ( ) const

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

Referenced by ost::DCCPSocket::connect(), ost::TCPStream::connect(), and ost::TCPSession::TCPSession().

getHostname()

const char * ost::IPV4Address::getHostname

(

void

)

const

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

Returns

string representation of IPV4Address.

Definition at line 415 of file address.cpp.

References ost::delString(), ost::Mutex::enterMutex(), hostname, ipaddr, ost::Mutex::leaveMutex(), mutex, and ost::newString().

Here is the call graph for this function:

isInetAddress()

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

Returns

true if address != 0.0.0.0.

Definition at line 152 of file address.cpp.

References ucommon::addr(), and ipaddr.

Here is the call graph for this function:

operator bool()

ost::IPV4Address::operator bool ( ) const

inline

Definition at line 496 of file address.h.

operator!()

bool ost::IPV4Address::operator! ( ) const

inline

Definition at line 500 of file address.h.

operator!=()

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

This is implimented in terms of operator==

Definition at line 252 of file address.cpp.

operator=() [1/4]

IPV4Address & ost::IPV4Address::operator=

(

const char *

str

)

Definition at line 161 of file address.cpp.

References setAddress(), and ucommon::str().

Here is the call graph for this function:

operator=() [2/4]

IPV4Address & ost::IPV4Address::operator=

(

const IPV4Address &

rhs

)

Definition at line 210 of file address.cpp.

References addr_count, ost::delString(), hostname, ipaddr, and validator.

Here is the call graph for this function:

operator=() [3/4]

IPV4Address & ost::IPV4Address::operator=

(

in_addr_t

addr

)

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

Definition at line 186 of file address.cpp.

References ucommon::addr(), addr_count, ost::delString(), hostname, ipaddr, and validator.

Here is the call graph for this function:

operator=() [4/4]

IPV4Address & ost::IPV4Address::operator=

(

struct in_addr

addr

)

Definition at line 171 of file address.cpp.

References ucommon::addr(), addr_count, ost::delString(), hostname, ipaddr, and validator.

Here is the call graph for this function:

operator==()

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

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.

Definition at line 227 of file address.cpp.

References addr_count, and ipaddr.

setAddress()

void ost::IPV4Address::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

Definition at line 319 of file address.cpp.

References addr_count, ost::delString(), ost::Mutex::enterMutex(), hostname, ipaddr, ost::Mutex::leaveMutex(), mutex, setIPAddress(), stricmp(), and validator.

Referenced by IPV4Address(), ost::IPV4Host::IPV4Host(), and operator=().

Here is the call graph for this function:

setIPAddress()

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

Definition at line 293 of file address.cpp.

References ucommon::addr(), and validator.

Referenced by ost::IPV4Mask::IPV4Mask(), and setAddress().

Here is the call graph for this function:

Member Data Documentation

addr_count

size_t ost::IPV4Address::addr_count

protected

Definition at line 374 of file address.h.

Referenced by IPV4Address(), ost::IPV4Host::operator&=(), operator=(), operator==(), and setAddress().

hostname

char* ost::IPV4Address::hostname

mutableprotected

Definition at line 375 of file address.h.

Referenced by getHostname(), ost::IPV4Host::operator&=(), operator=(), setAddress(), and ~IPV4Address().

ipaddr

struct in_addr* ost::IPV4Address::ipaddr

protected

Definition at line 373 of file address.h.

Referenced by getHostname(), IPV4Address(), isInetAddress(), ost::IPV4Host::operator&=(), operator=(), operator==(), setAddress(), and ~IPV4Address().

mutex

Mutex ost::IPV4Address::mutex

staticprotected

Definition at line 379 of file address.h.

Referenced by getHostname(), and setAddress().

validator

const IPV4Validator* ost::IPV4Address::validator

private

Definition at line 370 of file address.h.

Referenced by IPV4Address(), operator=(), setAddress(), and setIPAddress().

---

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

• inc/commoncpp/address.h
• commoncpp/address.cpp