A class for representing an IP address in an OS independent way. More...

#include <AsyncIpAddress.h>

Public Types
typedef struct in_addr	Ip4Addr
	The type for the OS specific representation of an IP address. More...

Public Member Functions
	IpAddress (void)
	Default constructor for the IpAddress class. More...

	IpAddress (const std::string &addr)
	Constructor for the IpAddress class. More...

	IpAddress (const Ip4Addr &addr)
	Constructor for the IpAddress class. More...

	IpAddress (const IpAddress &addr)
	Copy contructor. More...

	~IpAddress (void)
	Destructor. More...

Ip4Addr	ip4Addr (void) const
	Return the IP address in OS specific representation. More...

bool	isUnicast (void) const
	Check if this is a unicast IP address. More...

bool	isWithinSubet (const std::string &subnet) const
	Check if the IP address is within the given netmask. More...

bool	isEmpty (void) const
	Check if an invalid IP address has been assigned. More...

void	clear (void)
	Invalidate the IP address value. More...

std::string	toString (void) const
	Return the string representation of the IP address. More...

bool	setIpFromString (const std::string &str)
	Set the IP address from a string. More...

IpAddress &	operator= (const IpAddress &rhs)
	Assignment operator. More...

bool	operator== (const IpAddress &rhs) const
	Equality operator. More...

bool	operator!= (const IpAddress &rhs) const
	Unequality operator. More...

bool	operator< (const IpAddress &rhs) const
	Less than operator. More...

Friends
std::ostream &	operator<< (std::ostream &os, const Async::IpAddress &ip)
	Output stream operator. More...

std::istream &	operator>> (std::istream &is, Async::IpAddress &ip)
	Input stream operator. More...

Detailed Description

A class for representing an IP address in an OS independent way.

Definition at line 104 of file AsyncIpAddress.h.

Member Typedef Documentation

typedef struct in_addr Async::IpAddress::Ip4Addr

The type for the OS specific representation of an IP address.

Definition at line 110 of file AsyncIpAddress.h.

Constructor & Destructor Documentation

Async::IpAddress::IpAddress ( void )

Default constructor for the IpAddress class.

Async::IpAddress::IpAddress ( const std::string & addr )

Constructor for the IpAddress class.

Parameters

addr	The string representation of an IP address

Async::IpAddress::IpAddress ( const Ip4Addr & addr )

Constructor for the IpAddress class.

Parameters

addr	The IP address in OS specific representation

Async::IpAddress::IpAddress ( const IpAddress & addr )

inline

Copy contructor.

Parameters

addr	An IpAddress object to construct the new object from

Definition at line 133 of file AsyncIpAddress.h.

Async::IpAddress::~IpAddress ( void )

inline

Destructor.

Definition at line 138 of file AsyncIpAddress.h.

Member Function Documentation

void Async::IpAddress::clear ( void )

inline

Invalidate the IP address value.

Definition at line 172 of file AsyncIpAddress.h.

References setIpFromString(), and toString().

Ip4Addr Async::IpAddress::ip4Addr ( void ) const

inline

Return the IP address in OS specific representation.

Returns: The IP address

Definition at line 144 of file AsyncIpAddress.h.

References isUnicast(), and isWithinSubet().

bool Async::IpAddress::isEmpty ( void ) const

inline

Check if an invalid IP address has been assigned.

Returns: Return true if this is an invalid address or false if a valid address has been assigned.

Definition at line 167 of file AsyncIpAddress.h.

bool Async::IpAddress::isUnicast ( void ) const

Check if this is a unicast IP address.

Returns: Return true if this is a unicast address or false if it is some other type.

Referenced by ip4Addr().

bool Async::IpAddress::isWithinSubet ( const std::string & subnet ) const

Check if the IP address is within the given netmask.

Parameters

subnet The subnet to use in the check. The subnet should be given on the form a.b.c.d/m (e.g. 192.168.1.0/24).

Returns: Return true if within the given subnet or false if it is not.

Referenced by ip4Addr().

bool Async::IpAddress::operator!= ( const IpAddress & rhs ) const

inline

Unequality operator.

Parameters

rhs	Right hand side expression

Returns: Returns true if the right hand side object is unequal to this object, or else returns false.

Definition at line 215 of file AsyncIpAddress.h.

bool Async::IpAddress::operator< ( const IpAddress & rhs ) const

inline

Less than operator.

Parameters

rhs	Right hand side expression

Returns: Returns true if the right hand side object is less than this object, or else returns false.

Definition at line 226 of file AsyncIpAddress.h.

References operator<<, and operator>>.

IpAddress& Async::IpAddress::operator= ( const IpAddress & rhs )

inline

Assignment operator.

Parameters

rhs	The address object to assign to this object

Returns: Returns the new IP address

Definition at line 192 of file AsyncIpAddress.h.

bool Async::IpAddress::operator== ( const IpAddress & rhs ) const

inline

Equality operator.

Parameters

rhs	Right hand side expression

Returns: Returns true if the right hand side object is equal to this object, or else returns false.

Definition at line 204 of file AsyncIpAddress.h.

bool Async::IpAddress::setIpFromString ( const std::string & str )

Set the IP address from a string.

Parameters

str	The string to parse (e.g. "192.168.0.1")

Returns: Returns true on success or else false

Referenced by clear().

std::string Async::IpAddress::toString ( void ) const

Return the string representation of the IP address.

Returns: The IP address string

Referenced by clear().

Friends And Related Function Documentation

std::ostream& operator<<	(	std::ostream &	os,
		const Async::IpAddress &	ip
	)

friend

Output stream operator.

Parameters

os	The stream to output data to
ip	The IP address to output to the stream

Referenced by operator<().

std::istream& operator>>	(	std::istream &	is,
		Async::IpAddress &	ip
	)

friend

Input stream operator.

Parameters

is	The stream to input data from
ip	The IP address object to store information in

Referenced by operator<().

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

AsyncIpAddress.h

Public Types

Public Member Functions

Friends

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation