zeus::TIPAddress Class Reference

#include <IPAddress.h>

Inheritance diagram for zeus::TIPAddress:

Public Member Functions
	TIPAddress ()
	TIPAddress (const IString &rHostAddress, Uint uiPort)
virtual	~TIPAddress ()
virtual Uint	getPort () const
virtual TString	getHostAddress () const
virtual bool	isEqual (const TIPAddress &rAddress) const
virtual TIPAddress *	createNewAddress ()=0
virtual TString	getHostName () const =0
virtual bool	getRawAddress (IList< Uint16 > &rArray) const =0
virtual bool	isValid () const =0
virtual const struct sockaddr &	getSocketAddress () const =0
virtual Int	getSocketAddressSize () const =0
virtual int	getSocketFamily () const =0
virtual void	reset ()=0
virtual void	setPort (Uint uiPort)
bool	operator== (const TIPAddress &rAddress) const
Public Member Functions inherited from zeus::TZObject
	TZObject ()
	TZObject (const TString &strName)
	TZObject (const IString &strName)
Uint	getHash () const
TString	toString () const
virtual TString	getObjName () const
virtual void	setObjName (const TString &name)
virtual Retval MQUALIFIER	askForInterface (const InterfaceID &rInterfaceID, IZUnknown *&rpIface)
virtual void MQUALIFIER	addRef () const
virtual void MQUALIFIER	release () const

Static Public Member Functions
static Retval	createAddress (const IString &rstrAddr, Uint uiPort, TIPAddress *&rpAddress)

Protected Attributes
Uint	m_uiPort
	Port addresse. More...
TString	m_strHostAddress
	IP Addresse. More...
Protected Attributes inherited from zeus::TZObject
Uint	m_uiID

Additional Inherited Members
Protected Member Functions inherited from zeus::TZObject
virtual	~TZObject ()
	TZObject (const TZObject &rObject)
TZObject &	operator= (const TZObject &rObject)
Int	getRefCounter () const

Detailed Description

This class implememts the datatype to wrapp a IP address. IPv4 and IPv6 are supported.

Constructor & Destructor Documentation

TIPAddress() [1/2]

TIPAddress::TIPAddress

(

)

Creates an empty address object

TIPAddress() [2/2]

TIPAddress::TIPAddress	(	const IString &	rHostAddress,
		Uint	uiPort
	)

Creates an address out of the ip address and the port

Parameters

rHostAddress	: Host address as a string
uiPort	: Port

~TIPAddress()

TIPAddress::~TIPAddress ( )

virtual

Destroys the address object

Member Function Documentation

createAddress()

Retval TIPAddress::createAddress ( const IString &  rstrAddr, Uint  uiPort, TIPAddress *&  rpAddress  )

static

Creates a new IP address out of a host address and port number. The host address can also be a host name only.

::isalpha(rstrAddr.getChar(0))

createNewAddress()

virtual TIPAddress* zeus::TIPAddress::createNewAddress ( )

pure virtual

Creates and returns a new address. This is abstract since the IPv4 or IPv6 address can be created

Implemented in zeus::TIPv6Address, zeus::TBTAddress, and zeus::TIPv4Address.

getHostAddress()

TString zeus::TIPAddress::getHostAddress ( ) const

inlinevirtual

Returns the host address

getHostName()

virtual TString zeus::TIPAddress::getHostName ( ) const

pure virtual

Returns the host name of this ip. This is done with a reverse lookup.

Implemented in zeus::TIPv6Address, zeus::TBTAddress, and zeus::TIPv4Address.

getPort()

Uint zeus::TIPAddress::getPort ( ) const

inlinevirtual

Returns the port

getRawAddress()

virtual bool zeus::TIPAddress::getRawAddress ( IList< Uint16 > &  rArray ) const

pure virtual

Returns the raw byte address of the ip address

Parameters

rArray

: Return parameter

Return values

true	: IP address returned
false	error returning address (invalid address)

Implemented in zeus::TIPv6Address, zeus::TBTAddress, and zeus::TIPv4Address.

getSocketAddress()

virtual const struct sockaddr& zeus::TIPAddress::getSocketAddress ( ) const

pure virtual

returns the socket address

Implemented in zeus::TIPv6Address, zeus::TBTAddress, and zeus::TIPv4Address.

getSocketAddressSize()

virtual Int zeus::TIPAddress::getSocketAddressSize ( ) const

pure virtual

returns the size of the socket address

Implemented in zeus::TIPv6Address, zeus::TBTAddress, and zeus::TIPv4Address.

getSocketFamily()

virtual int zeus::TIPAddress::getSocketFamily ( ) const

pure virtual

returns the family of the socket address

Implemented in zeus::TIPv6Address, zeus::TBTAddress, and zeus::TIPv4Address.

isEqual()

bool zeus::TIPAddress::isEqual ( const TIPAddress &  rAddress ) const

inlinevirtual

checks if the address is equal to this address.

Parameters

rAddress

: Address instance

Return values

true	: Addresses are equal
false	Addresses are not equal

isValid()

virtual bool zeus::TIPAddress::isValid ( ) const

pure virtual

checks if the address is valid

Implemented in zeus::TIPv6Address, zeus::TBTAddress, and zeus::TIPv4Address.

operator==()

bool zeus::TIPAddress::operator== ( const TIPAddress &  rAddress ) const

inline

reset()

virtual void zeus::TIPAddress::reset ( )

pure virtual

resets the address depending on the internal socket structure

Implemented in zeus::TIPv6Address, zeus::TBTAddress, and zeus::TIPv4Address.

setPort()

void zeus::TIPAddress::setPort ( Uint  uiPort )

inlinevirtual

sets the new port of an address

Reimplemented in zeus::TIPv6Address, and zeus::TIPv4Address.

Member Data Documentation

m_strHostAddress

TString zeus::TIPAddress::m_strHostAddress

protected

IP Addresse.

m_uiPort

Uint zeus::TIPAddress::m_uiPort

protected

Port addresse.

---

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

• IPAddress.h
• IPAddress.cpp