nAddress Class Reference

internet address More...

#include <nSocket.h>

Collaboration diagram for nAddress:

[legend]

List of all members.

Public Types
enum	{ size = sizeof( nAddressBase ) }
Public Member Functions
	nAddress ()
	constructor
	~nAddress ()
	destructor
nAddress const &	ToString (tString &string) const
	turns address to complete string
tString	ToString () const
	turns address to complete string
int	FromString (const char *string)
	turns complete string into address
void	FromHostent (int l, const char *addr)
	copy address from hostent data
nAddress &	SetHostname (const char *hostname)
	Sets the hostname part of the address (with DNS lookup).
tString	GetHostname (void) const
	Gets the hostname part of the address (with DNS lookup).
nAddress const &	GetHostname (tString &hostname) const
	Gets the hostname part of the address (with DNS lookup).
nAddress &	SetAddress (const char *address)
	Sets the hostname part of the address.
tString	GetAddress (void) const
	Gets the hostname part of the address.
nAddress const &	GetAddress (tString &address) const
	Gets the hostname part of the address.
nAddress &	SetPort (int port)
	Sets the port of the address.
int	GetPort (void) const
	Gets the port of the address.
nAddress const &	GetPort (int &port) const
	Gets the port of the address.
bool	IsSet () const
	returns true only if address is not INETADDR_ANY
	operator struct sockaddr * ()
	conversion to sockaddr
	operator struct sockaddr const * () const
	conversion to sockaddr
bool	operator== (nAddress const &other) const
	comparison operator
bool	operator!= (nAddress const &other) const
	comparison operator
unsigned int	GetAddressLength (void) const
	Gets the length of the stored address.
Static Public Member Functions
static int	Compare (const nAddress &a1, const nAddress &a2)
	compares two addresses
Private Attributes
nAddressBase	addr_
	the lowlevel network address
unsigned int	addrLen_
	the length of the really stored address

---

Detailed Description

internet address

Definition at line 66 of file nSocket.h.

---

Member Enumeration Documentation

anonymous enum

Enumerator:

size

Definition at line 112 of file nSocket.h.

{ size = sizeof( nAddressBase ) };

---

Constructor & Destructor Documentation

nAddress::nAddress

(

void

)

constructor

Definition at line 1013 of file nSocket.cpp.

References addr_, nAddressBase::addr_in, addrLen_, and size.

Referenced by SetHostname().

{
    // clear address data, it's only POD
    memset( &addr_, 0, size );
    addrLen_ = size;

    // set to unspecific IP4 address
    addr_.addr_in.sin_addr.s_addr = INADDR_ANY;
    addr_.addr_in.sin_family = AF_INET;

Here is the caller graph for this function:

nAddress::~nAddress

(

void

)

destructor

Definition at line 1034 of file nSocket.cpp.

{

---

Member Function Documentation

const nAddress & nAddress::ToString

(

tString &

string

)

const

turns address to complete string

Parameters:

string

the string to fill

Returns:

reference to this for chaining

Definition at line 1050 of file nSocket.cpp.

References addr_, nAddressBase::addr_in, ANET_AddrToString(), and GetPort().

Referenced by nSocket::Bind(), nSocket::Close(), nServerInfo::GetBigServerInfoCommon(), nSocket::Read(), and nSocket::Write().

{
    if( addr_.addr_in.sin_addr.s_addr != INADDR_ANY )
        string = ANET_AddrToString( *this );
    else
    {
        string = "*.*.*.*";
        string << ":" << GetPort();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

tString nAddress::ToString

(

void

)

const

turns address to complete string

Returns:

the string represendation of the address

Definition at line 1072 of file nSocket.cpp.

{
    // delegate
    tString ret;
    ToString( ret );

int nAddress::FromString

(

const char *

string

)

turns complete string into address

Parameters:

string

the string represendation of the address

Returns:

0 on success

Definition at line 1091 of file nSocket.cpp.

References nAddressBase::addr, addr_, nAddressBase::addr_in, SetHostname(), SetPort(), tString::StrPos(), tString::SubStr(), tERR_ERROR, and tString::ToInt().

Referenced by operator>>().

{
    int ha1, ha2, ha3, ha4, hp;
    int ipaddr;

    tString source( string );

    // parse IP address if the passed name looks like one
    if (string[0] >= '0' && string[0] <= '9')
    {
        // parse IP address
        sscanf(string, "%d.%d.%d.%d:%d", &ha1, &ha2, &ha3, &ha4, &hp);
        ipaddr = (ha1 << 24) | (ha2 << 16) | (ha3 << 8) | ha4;

        // store values in address
        addr_.addr   .sa_family = AF_INET;
        addr_.addr_in.sin_addr.s_addr = htonl(ipaddr);
        addr_.addr_in.sin_port = htons(hp);
        return 0;
    }
    else
    {
        addr_.addr   .sa_family = AF_INET;

        // find colon
        int colonPos = source.StrPos(":");
        if ( colonPos > 0 )
        {
            tString addr = source.SubStr( 0, colonPos );

            // extract port
            SetPort( source.ToInt( colonPos + 1 ) );

            // extract hostname
            if ( addr == "*.*.*.*" )
                addr_.addr_in.sin_addr.s_addr = INADDR_ANY;
            else
                SetHostname( addr );

            return 0;
        }
        else
        {
            tERR_ERROR( "Invalid string representation ( IP:PORT ): " << string );

            return -1;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

void nAddress::FromHostent	(	int	length,
		const char *	addr
	)

copy address from hostent data

Parameters:

	info	the addrinfo structure to copy the address from
	l	length of address
	addr	pointer to address

Definition at line 1178 of file nSocket.cpp.

References nAddressBase::addr, addr_, nAddressBase::addr_in, addrLen_, and tASSERT.

Referenced by ANET_GetHostList().

{
    // check address size
    tASSERT( length == 4 );

    // copy the address over
    addr_.addr   .sa_family = AF_INET;
    addr_.addr_in.sin_addr.s_addr = *reinterpret_cast< int const * >( addr );

    // store length

Here is the caller graph for this function:

nAddress & nAddress::SetHostname

(

const char *

hostname

)

Sets the hostname part of the address (with DNS lookup).

Parameters:

hostname

the hostname to set

Returns:

reference to this for chaining

Definition at line 1260 of file nSocket.cpp.

References nAddressBase::addr, addr_, nAddressBase::addr_in, GetPort(), nAddress(), PartialIPAddress(), tRecorder::PlaybackStrict(), tRecorder::Record(), section, and sn_InitOSNetworking().

Referenced by FromString().

{
    // initialize networking at OS level
    sn_InitOSNetworking();

    // parse IP address if the passed name looks like one
    if (hostname[0] >= '0' && hostname[0] <= '9')
    {
        PartialIPAddress (hostname, &addr_.addr, GetPort(), 0x7f000001 );
        return *this;
    }

    // read address from recording
    static char const * section = "SINGLEHOSTNAME";
    if ( !tRecorder::PlaybackStrict( section, *this ) )
    {
        // look up hostname ( TODO: error handling )
        struct hostent *hostentry;
        hostentry = gethostbyname (hostname);
        if (hostentry)
        {
            // store values
            addr_.addr   .sa_family = AF_INET;
            addr_.addr_in.sin_addr.s_addr = *(int *)hostentry->h_addr_list[0];
        }
        else
        {
            // invalidate
            *this = nAddress();
        }
    }

    // write address to recording
    tRecorder::Record( section, *this );

Here is the call graph for this function:

Here is the caller graph for this function:

tString nAddress::GetHostname

(

void

)

const

Gets the hostname part of the address (with DNS lookup).

Returns:

the hostname part of the address

Definition at line 1242 of file nSocket.cpp.

{
    tString ret;
    GetHostname( ret );

const nAddress & nAddress::GetHostname

(

tString &

hostname

)

const

Gets the hostname part of the address (with DNS lookup).

Parameters:

hostname

the hostname to fill

Returns:

reference to this for chaining

Definition at line 1202 of file nSocket.cpp.

References addr_, nAddressBase::addr_in, tString::Clear(), tRecorder::PlaybackStrict(), tRecorder::Record(), section, size, and sn_InitOSNetworking().

{
    // initialize networking at OS level
    sn_InitOSNetworking();

    int haddr;
    haddr = ntohl(addr_.addr_in.sin_addr.s_addr);

    hostname.Clear();
    hostname << ((haddr >> 24) & 0xff) << "." << ((haddr >> 16) & 0xff) << "." << ((haddr >> 8) & 0xff) << "." << (haddr & 0xff);

    // read hostname from recording
    static char const * section = "HOSTBYADDR";
    if ( !tRecorder::PlaybackStrict( section, hostname ) )
    {
        struct hostent *hostentry;

        hostentry = gethostbyaddr ( reinterpret_cast< const char * >( &addr_ ), size, AF_INET);
        if (hostentry)
        {
            hostname = tString( (char *)hostentry->h_name );
        }
    }

    // write hostname to recording
    tRecorder::Record( section, hostname );

Here is the call graph for this function:

nAddress & nAddress::SetAddress

(

const char *

hostname

)

Sets the hostname part of the address.

Parameters:

address

the raw IP to set

Returns:

reference to this for chaining

Definition at line 1350 of file nSocket.cpp.

References nAddressBase::addr, addr_, GetPort(), PartialIPAddress(), sn_InitOSNetworking(), and tVERIFY.

{
    // initialize networking at OS level
    sn_InitOSNetworking();

    // parse IP address if the passed name looks like one
    tVERIFY(hostname[0] >= '0' && hostname[0] <= '9')

    PartialIPAddress (hostname, &addr_.addr, GetPort(), 0x7f000001 );

Here is the call graph for this function:

tString nAddress::GetAddress

(

void

)

const

Gets the hostname part of the address.

Returns:

the raw IP part of the address

Definition at line 1332 of file nSocket.cpp.

{
    tString ret;
    GetAddress( ret );

const nAddress & nAddress::GetAddress

(

tString &

hostname

)

const

Gets the hostname part of the address.

Parameters:

address

the raw IP to fill

Returns:

reference to this for chaining

Definition at line 1309 of file nSocket.cpp.

References addr_, nAddressBase::addr_in, and sn_InitOSNetworking().

{
    // initialize networking at OS level
    sn_InitOSNetworking();

    int haddr;
    haddr = ntohl(addr_.addr_in.sin_addr.s_addr);

    hostname << ((haddr >> 24) & 0xff) << "." << ((haddr >> 16) & 0xff) << "." << ((haddr >> 8) & 0xff) << "." << (haddr & 0xff);

Here is the call graph for this function:

nAddress & nAddress::SetPort

(

int

port

)

Sets the port of the address.

Parameters:

port

the port to set

Returns:

reference to this for chaining

Definition at line 1373 of file nSocket.cpp.

References addr_, and nAddressBase::addr_in.

Referenced by ANET_GetHostList(), FromString(), nSocket::Open(), and nSocket::Reset().

{
    // store the port
    addr_.addr_in.sin_port = htons(port);

Here is the caller graph for this function:

int nAddress::GetPort

(

void

)

const

Gets the port of the address.

Returns:

port of this address

Definition at line 1391 of file nSocket.cpp.

References addr_, and nAddressBase::addr_in.

Referenced by nServerInfoBase::DoGetFrom(), GetPort(), nSocket::Reset(), SetAddress(), SetHostname(), and ToString().

{

Here is the caller graph for this function:

const nAddress & nAddress::GetPort

(

int &

port

)

const

Gets the port of the address.

Parameters:

port

port of this address to fill

Returns:

reference to this for chaining

Definition at line 1407 of file nSocket.cpp.

References GetPort().

{
    port = GetPort();

Here is the call graph for this function:

bool nAddress::IsSet

(

)

const

returns true only if address is not INETADDR_ANY

Returns:

true only if address was set to something valid

Definition at line 1425 of file nSocket.cpp.

References addr_, and nAddressBase::addr_in.

Referenced by nServerInfo::TellMasterAboutMe().

{

Here is the caller graph for this function:

int nAddress::Compare	(	const nAddress &	a1,
		const nAddress &	a2
	)			[static]

compares two addresses

Parameters:

	a1	first address to compare
	a2	second address to compare

Returns:

Definition at line 1442 of file nSocket.cpp.

References nAddressBase::addr, addr_, and nAddressBase::addr_in.

Referenced by nSocket::Bind(), CountSameConnection(), CountSameIP(), operator!=(), operator==(), and rec_peer().

{
    if (a1.addr_.addr.sa_family != a2.addr_.addr.sa_family)
        return -1;

    if (a1.addr_.addr_in.sin_addr.s_addr != a2.addr_.addr_in.sin_addr.s_addr)
        return -1;

    if (a1.addr_.addr_in.sin_port != a2.addr_.addr_in.sin_port)
        return 1;

Here is the caller graph for this function:

nAddress::operator struct sockaddr *

(

)

[inline]

conversion to sockaddr

Definition at line 97 of file nSocket.h.

References nAddressBase::addr, and addr_.

nAddress::operator struct sockaddr const *

(

)

const [inline]

conversion to sockaddr

Definition at line 98 of file nSocket.h.

References nAddressBase::addr, and addr_.

bool nAddress::operator==

(

nAddress const &

other

)

const [inline]

comparison operator

Definition at line 101 of file nSocket.h.

References Compare().

    {
        return Compare( *this, other ) == 0;
    }

Here is the call graph for this function:

bool nAddress::operator!=

(

nAddress const &

other

)

const [inline]

comparison operator

Definition at line 107 of file nSocket.h.

References Compare().

    {
        return Compare( *this, other ) != 0;
    }

Here is the call graph for this function:

unsigned int nAddress::GetAddressLength

(

void

)

const

Gets the length of the stored address.

Returns:

the length of the stored address

Definition at line 1466 of file nSocket.cpp.

References addrLen_.

Referenced by nSocket::Bind(), nSocket::Read(), and nSocket::Write().

{

Here is the caller graph for this function:

---

Member Data Documentation

nAddressBase nAddress::addr_ [private]

the lowlevel network address

Definition at line 116 of file nSocket.h.

Referenced by Compare(), FromHostent(), FromString(), GetAddress(), GetHostname(), GetPort(), IsSet(), nAddress(), operator struct sockaddr *(), operator struct sockaddr const *(), SetAddress(), SetHostname(), SetPort(), and ToString().

unsigned int nAddress::addrLen_ [private]

the length of the really stored address

Definition at line 117 of file nSocket.h.

Referenced by FromHostent(), GetAddressLength(), and nAddress().

---

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

• src/network/nSocket.h
• src/network/nSocket.cpp

---