nServerInfoBase Class Reference

Basic server information: everything you need to connect. More...

#include <nServerInfo.h>

Inheritance diagram for nServerInfoBase:

[legend]

Collaboration diagram for nServerInfoBase:

[legend]

List of all members.

Public Member Functions
	nServerInfoBase ()
virtual	~nServerInfoBase ()
bool	operator== (const nServerInfoBase &other) const
bool	operator!= (const nServerInfoBase &other) const
void	NetWrite (nMessage &m) const
	writes data to network message
void	NetRead (nMessage &m)
	reads data from network message
void	NetWriteThis (nMessage &m) const
	writes data to network message
void	NetReadThis (nMessage &m)
	reads data from network message
void	GetFrom (nSocket const *socket)
	fills data from this server and the given socket
nConnectError	Connect (nLoginType loginType=Login_All, const nSocket *socket=NULL)
	connect to this server ( using the specified socket )
void	CopyFrom (const nServerInfoBase &other)
	copies server info
nServerInfoBase &	operator= (const nServerInfoBase &other)
const tString &	GetName () const
	returns the server's name
tString const &	GetConnectionName (void) const
	Gets the internet name of the server ("192.168.10.10", "atron.dyndns.org").
nServerInfoBase const &	GetConnectionName (tString &connectionName) const
	Gets the internet name of the server ("192.168.10.10", "atron.dyndns.org").
unsigned int	GetPort (void) const
	Gets the network port the server listens on.
nServerInfoBase const &	GetPort (unsigned int &port) const
	Gets the network port the server listens on.
nAddress const &	GetAddress (void) const
	Gets the network address of the server.
nServerInfoBase const &	GetAddress (nAddress &address) const
	Gets the network address of the server.
nServerInfoBase const &	ClearAddress () const
	Clears the network address of the server ( so it gets requeried ).
Protected Member Functions
virtual void	DoNetWrite (nMessage &m) const
	writes data to network message
virtual void	DoNetRead (nMessage &m)
	reads data from network message
virtual void	DoGetFrom (nSocket const *socket)
	fills data from this server and the given socket
virtual const tString &	DoGetName () const
	returns the server's name
nServerInfoBase &	SetConnectionName (tString const &connectionName)
	Sets the internet name of the server ("192.168.10.10", "atron.dyndns.org").
nServerInfoBase &	SetPort (unsigned int port)
	Sets the network port the server listens on.
Private Member Functions
nAddress &	AccessAddress (void) const
	Accesses the network address of the server.
nServerInfoBase &	SetAddress (nAddress const &address)
	Sets the network address of the server.
Private Attributes
tString	connectionName_
	the internet name of the server ("192.168.10.10", "atron.dyndns.org")
unsigned int	port_
	the network port the server listens on
std::auto_ptr< nAddress >	address_
	the network address of the server

---

Detailed Description

Basic server information: everything you need to connect.

Definition at line 47 of file nServerInfo.h.

---

Constructor & Destructor Documentation

nServerInfoBase::nServerInfoBase

(

)

Definition at line 2367 of file nServerInfo.cpp.

        : connectionName_(""),
          port_(0)
{
}

nServerInfoBase::~nServerInfoBase

(

)

[virtual]

Definition at line 2382 of file nServerInfo.cpp.

{
}

---

Member Function Documentation

bool nServerInfoBase::operator==

(

const nServerInfoBase &

other

)

const

Definition at line 2395 of file nServerInfo.cpp.

References GetAddress(), and port_.

Referenced by operator!=().

{
    return GetAddress() == other.GetAddress() && port_ == other.port_;
}

Here is the call graph for this function:

Here is the caller graph for this function:

bool nServerInfoBase::operator!=

(

const nServerInfoBase &

other

)

const

Definition at line 2409 of file nServerInfo.cpp.

References operator==().

{
    return ! operator == ( other );
}

Here is the call graph for this function:

void nServerInfoBase::NetWrite

(

nMessage &

message

)

const [inline]

writes data to network message

Parameters:

message

message to write info to

Definition at line 410 of file nServerInfo.h.

References DoNetWrite().

Referenced by nServerInfo::GiveBigServerInfoCommon(), nServerInfo::GiveSmallServerInfo(), and nServerInfo::TellMasterAboutMe().

{
    DoNetWrite( message );
}

Here is the call graph for this function:

Here is the caller graph for this function:

void nServerInfoBase::NetRead

(

nMessage &

message

)

[inline]

reads data from network message

Parameters:

mesage

message to read from

Definition at line 425 of file nServerInfo.h.

References DoNetRead().

Referenced by nServerInfo::GetBigServerInfoCommon(), nServerInfo::GetSmallServerInfo(), and nServerInfo::GiveBigServerInfoMaster().

{
    DoNetRead( message );
}

Here is the call graph for this function:

Here is the caller graph for this function:

void nServerInfoBase::NetWriteThis

(

nMessage &

m

)

const

writes data to network message

Parameters:

m

message to write to

Reimplemented in nServerInfo.

Definition at line 2519 of file nServerInfo.cpp.

References connectionName_, and port_.

Referenced by DoNetWrite(), nServerInfo::NetReadThis(), and nServerInfo::QueryServer().

{
    m << port_;            // write the port
    m << connectionName_;  // and the name
}

Here is the caller graph for this function:

void nServerInfoBase::NetReadThis

(

nMessage &

m

)

reads data from network message

Parameters:

m

message to read from

Reimplemented in nServerInfo.

Definition at line 2544 of file nServerInfo.cpp.

References connectionName_, tString::Len(), port_, S_GlobalizeName(), S_LocalizeName(), nMessage::SenderID(), tString::Size(), sn_AcceptingFromBroadcast, sn_AcceptingFromMaster, sn_GetAdr(), sn_IsMaster, sn_ReadFiltered(), and tString::SubStr().

Referenced by DoNetRead().

{
    m >> port_;                            // get the port
    sn_ReadFiltered( m, connectionName_ ); // get the connection name

    if ( ( sn_IsMaster || sn_AcceptingFromBroadcast || sn_AcceptingFromMaster ) && connectionName_.Len()>1 ) // no valid name (must come directly from the server who does not know his own address)
    {
        // resolve DNS
        connectionName_ = S_LocalizeName( connectionName_ );
    }
    else
    {
#ifdef DEBUG_X
        if ( connectionName_.Len() > 1 )
        {
            std::cout << "Overwriting source from " << connectionName_ << ".\n";
        }
#endif

        sn_GetAdr( m.SenderID(), connectionName_ );

        // remove the port
        for (int i=connectionName_.Size()-1; i>=0; i--)
            if (':' == connectionName_[i])
            {
                connectionName_ = connectionName_.SubStr( 0, i );
            }

        S_GlobalizeName( connectionName_ );
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

void nServerInfoBase::GetFrom

(

nSocket const *

socket

)

[inline]

fills data from this server and the given socket

Parameters:

socket

socket to get bare network information from

Definition at line 440 of file nServerInfo.h.

References DoGetFrom().

Referenced by nServerInfo::GiveBigServerInfo(), nServerInfo::GiveSmallServerInfo(), and nServerInfo::TellMasterAboutMe().

{
    DoGetFrom( socket );
}

Here is the call graph for this function:

Here is the caller graph for this function:

nConnectError nServerInfoBase::Connect	(	nLoginType	loginType = Login_All,
		const nSocket *	socket = NULL
	)

connect to this server ( using the specified socket )

Returns:

error code

Definition at line 2424 of file nServerInfo.cpp.

References GetAddress(), nTIMEOUT, sn_Connect(), and ToString().

Referenced by ConnectToServerCore(), nServerInfo::GetFromMaster(), and nServerInfo::TellMasterAboutMe().

{
    // refuse to connect without address
    if ( !GetAddress().IsSet() )
    {
        // well, not really a timeout. But we would timeout if we tried to connect.
        return nTIMEOUT;
    }

    //unsigned int portBack = sn_clientPort;
    //sn_clientPort = port_;
    if ( GetAddress().ToString().StartsWith( "*.*.*.*" ) )
    {
        throw tGenericException( tOutput("$network_message_dns_error_inter"),tOutput("$network_message_dns_error_title"));
    }

    nConnectError error = sn_Connect( GetAddress(), loginType, socket );
    //sn_clientPort = portBack;

    return error;
}

Here is the call graph for this function:

Here is the caller graph for this function:

void nServerInfoBase::CopyFrom

(

const nServerInfoBase &

other

)

copies server info

Parameters:

other

Definition at line 2456 of file nServerInfo.cpp.

References connectionName_, and port_.

Referenced by nServerInfo::GetBigServerInfoCommon(), and operator=().

{
    port_               = other.port_;
    connectionName_     = other.connectionName_;
}

Here is the caller graph for this function:

nServerInfoBase & nServerInfoBase::operator=

(

const nServerInfoBase &

other

)

Parameters:

other

Returns:

Definition at line 2473 of file nServerInfo.cpp.

References CopyFrom().

{
    CopyFrom( other );
    return *this;
}

Here is the call graph for this function:

const tString & nServerInfoBase::GetName

(

void

)

const [inline]

returns the server's name

Returns:

this server's name

Definition at line 346 of file nServerInfo.h.

References DoGetName().

Referenced by gServerFavoritesHolder::AddFavorite(), ConnectToServerCore(), nServerInfo::GetFromMaster(), gServerMenuItem::Render(), and nServerInfo::TellMasterAboutMe().

{
    return DoGetName();
}

Here is the call graph for this function:

Here is the caller graph for this function:

void nServerInfoBase::DoNetWrite

(

nMessage &

m

)

const [protected, virtual]

writes data to network message

Parameters:

m

message to write to

Reimplemented in nServerInfo.

Definition at line 2489 of file nServerInfo.cpp.

References NetWriteThis().

Referenced by nServerInfo::DoNetWrite(), and NetWrite().

{
    NetWriteThis( m );
}

Here is the call graph for this function:

Here is the caller graph for this function:

void nServerInfoBase::DoNetRead

(

nMessage &

m

)

[protected, virtual]

reads data from network message

Parameters:

m

message to read from

Reimplemented in nServerInfo.

Definition at line 2504 of file nServerInfo.cpp.

References NetReadThis().

Referenced by nServerInfo::DoNetRead(), and NetRead().

{
    NetReadThis( m );
}

Here is the call graph for this function:

Here is the caller graph for this function:

void nServerInfoBase::DoGetFrom

(

nSocket const *

socket

)

[protected, virtual]

fills data from this server and the given socket

Parameters:

socket

socket to get bare network information from

Reimplemented in nServerInfo.

Definition at line 2592 of file nServerInfo.cpp.

References connectionName_, nSocket::GetAddress(), nAddress::GetPort(), net_dns, port_, and sn_GetServerPort().

Referenced by nServerInfo::DoGetFrom(), and GetFrom().

{
    // better not set connection name, the message recipient can figure it out more reliably
    connectionName_ = net_dns;

    if ( ! socket )
    {
        port_ = sn_GetServerPort();
    }
    else
    {
        // fill port information from socket
        nAddress const & address = socket->GetAddress();
        port_ = address.GetPort();
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

const tString & nServerInfoBase::DoGetName

(

void

)

const [protected, virtual]

returns the server's name

Returns:

this server's name

Reimplemented in nServerInfo.

Definition at line 2952 of file nServerInfo.cpp.

References connectionName_.

Referenced by GetName().

{
    return connectionName_;
}

Here is the caller graph for this function:

tString const & nServerInfoBase::GetConnectionName

(

void

)

const [inline]

Gets the internet name of the server ("192.168.10.10", "atron.dyndns.org").

Returns:

the internet name of the server ("192.168.10.10", "atron.dyndns.org")

Definition at line 455 of file nServerInfo.h.

References connectionName_.

Referenced by gServerFavoritesHolder::AddFavorite(), nServerInfo::GetSmallServerInfo(), gServerFavoritesHolder::IsFavorite(), Poll(), nServerInfo::Save(), sg_NetworkError(), and ToString().

{
    return this->connectionName_;
}

Here is the caller graph for this function:

nServerInfoBase const & nServerInfoBase::GetConnectionName

(

tString &

connectionName

)

const [inline]

Gets the internet name of the server ("192.168.10.10", "atron.dyndns.org").

Parameters:

connectionName

the internet name of the server ("192.168.10.10", "atron.dyndns.org") to fill

Returns:

A reference to this to allow chaining

Definition at line 471 of file nServerInfo.h.

References connectionName_.

{
    connectionName = this->connectionName_;
    return *this;
}

unsigned nServerInfoBase::GetPort

(

void

)

const [inline]

Gets the network port the server listens on.

Returns:

the network port the server listens on

Definition at line 504 of file nServerInfo.h.

References port_.

Referenced by gServerFavoritesHolder::AddFavorite(), nServerInfo::GetSmallServerInfo(), gServerFavoritesHolder::IsFavorite(), Poll(), nServerInfo::Save(), sg_NetworkError(), and ToString().

{
    return this->port_;
}

Here is the caller graph for this function:

nServerInfoBase const& nServerInfoBase::GetPort

(

unsigned int &

port

)

const [inline]

Gets the network port the server listens on.

nAddress const & nServerInfoBase::GetAddress

(

void

)

const

Gets the network address of the server.

Returns:

the network address of the server

Definition at line 2851 of file nServerInfo.cpp.

References AccessAddress().

Referenced by Connect(), nServerInfo::Load(), nServerInfo::NetReadThis(), operator==(), nServerInfo::QueryServer(), nServerInfo::StartQueryAll(), and nServerInfo::TellMasterAboutMe().

{
    return this->AccessAddress();
}

Here is the call graph for this function:

Here is the caller graph for this function:

nServerInfoBase const & nServerInfoBase::GetAddress

(

nAddress &

address

)

const

Gets the network address of the server.

Parameters:

address

the network address of the server to fill

Returns:

A reference to this to allow chaining

Definition at line 2867 of file nServerInfo.cpp.

References AccessAddress().

{
    address = this->AccessAddress();
    return *this;
}

Here is the call graph for this function:

nServerInfoBase const & nServerInfoBase::ClearAddress

(

)

const

Clears the network address of the server ( so it gets requeried ).

Returns:

A reference to this to allow chaining

Definition at line 2883 of file nServerInfo.cpp.

References address_.

Referenced by nServerInfo::StartQueryAll().

{
    std::auto_ptr< nAddress > clearedAddress;
    address_ = clearedAddress;
    return *this;
}

Here is the caller graph for this function:

nAddress & nServerInfoBase::AccessAddress

(

void

)

const [private]

Accesses the network address of the server.

Returns:

the network address of the server as a modifiable reference

Definition at line 2918 of file nServerInfo.cpp.

References address_, con, tNEW, and ToString().

Referenced by GetAddress(), and SetAddress().

{
    // create address if it is not already there
    if ( !this->address_.get() )
    {
        std::auto_ptr< nAddress > address( tNEW( nAddress ) );

        // fill it with hostname and port
        address->SetHostname( this->GetConnectionName() );
        address->SetPort( this->GetPort() );

        this->address_ = address;

#ifdef DEBUG
        tString unresolved = ToString( *this );
        tString resolved = this->address_->ToString();
        if ( unresolved != resolved )
            con << "Address of server " << unresolved << " determined to be " << resolved << "\n";
#endif
    }

    return *this->address_;
}

Here is the call graph for this function:

Here is the caller graph for this function:

nServerInfoBase & nServerInfoBase::SetAddress

(

nAddress const &

address

)

[private]

Sets the network address of the server.

Parameters:

address

the network address of the server to set

Returns:

A reference to this to allow chaining

Definition at line 2901 of file nServerInfo.cpp.

References AccessAddress().

{
    AccessAddress() = address;
    return *this;
}

Here is the call graph for this function:

nServerInfoBase & nServerInfoBase::SetConnectionName

(

tString const &

connectionName

)

[inline, protected]

Sets the internet name of the server ("192.168.10.10", "atron.dyndns.org").

Parameters:

connectionName

the internet name of the server ("192.168.10.10", "atron.dyndns.org") to set

Returns:

A reference to this to allow chaining

Definition at line 488 of file nServerInfo.h.

References connectionName_.

Referenced by nServerInfo::Load(), and nServerInfoRedirect::nServerInfoRedirect().

{
    this->connectionName_ = connectionName;
    return *this;
}

Here is the caller graph for this function:

nServerInfoBase& nServerInfoBase::SetPort

(

unsigned int

port

)

[inline, protected]

Sets the network port the server listens on.

Referenced by nServerInfo::Load(), and nServerInfoRedirect::nServerInfoRedirect().

Here is the caller graph for this function:

---

Member Data Documentation

tString nServerInfoBase::connectionName_ [private]

the internet name of the server ("192.168.10.10", "atron.dyndns.org")

Definition at line 79 of file nServerInfo.h.

Referenced by CopyFrom(), DoGetFrom(), DoGetName(), GetConnectionName(), NetReadThis(), NetWriteThis(), and SetConnectionName().

unsigned int nServerInfoBase::port_ [private]

the network port the server listens on

Definition at line 80 of file nServerInfo.h.

Referenced by CopyFrom(), DoGetFrom(), GetPort(), NetReadThis(), NetWriteThis(), and operator==().

std::auto_ptr< nAddress > nServerInfoBase::address_ [mutable, private]

the network address of the server

Definition at line 81 of file nServerInfo.h.

Referenced by AccessAddress(), and ClearAddress().

---

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

• src/network/nServerInfo.h
• src/network/nServerInfo.cpp

---