nBasicNetworkSystem Class Reference

basic network system: manages sockets More...

#include <nSocket.h>

Collaboration diagram for nBasicNetworkSystem:

[legend]

List of all members.

Public Member Functions
	nBasicNetworkSystem ()
	constructor
	~nBasicNetworkSystem ()
	destructor
nSocket *	Init (void)
	initializes the network
void	Shutdown (void)
	shuts donw the network
bool	Select (REAL dt)
	waits the specified time for data to arrive on the sockets
nSocketListener &	AccessListener (void)
	Accesses listening sockets.
nBasicNetworkSystem &	SetListener (nSocketListener const &listener)
	Sets listening sockets.
nSocketListener const &	GetListener (void) const
	Gets listening sockets.
nSocket const &	GetControlSocket (void) const
	Gets network control socket.
Private Member Functions
	nBasicNetworkSystem (const nBasicNetworkSystem &)
nBasicNetworkSystem &	operator= (const nBasicNetworkSystem &)
nSocket &	AccessControlSocket (void)
	Accesses network control socket.
Private Attributes
nSocketListener	listener_
	listening sockets
nSocket	controlSocket_
	network control socket

---

Detailed Description

basic network system: manages sockets

Definition at line 221 of file nSocket.h.

---

Constructor & Destructor Documentation

nBasicNetworkSystem::nBasicNetworkSystem

(

void

)

constructor

Definition at line 2530 of file nSocket.cpp.

{

nBasicNetworkSystem::~nBasicNetworkSystem

(

void

)

destructor

Definition at line 2544 of file nSocket.cpp.

References Shutdown().

{
    // shut down the system

Here is the call graph for this function:

nBasicNetworkSystem::nBasicNetworkSystem

(

const nBasicNetworkSystem &

)

[private]

---

Member Function Documentation

nSocket * nBasicNetworkSystem::Init

(

void

)

initializes the network

Returns:

Definition at line 2560 of file nSocket.cpp.

References controlSocket_, nSocket::IsOpen(), nSocket::Open(), sn_InitOSNetworking(), and Sys_Error().

{
    // test if network was already initialized
    if ( controlSocket_.IsOpen() )
        return &controlSocket_;

    // initialize networking at OS level
    sn_InitOSNetworking();

    if ( 0 != controlSocket_.Open() )
        Sys_Error("ANET_Init: Unable to open control socket\n");

    return &controlSocket_;

    //struct hostent *local;
    //char      buff[MAXHOSTNAMELEN]="\0";
    //struct sockaddr addr;
    //char *colon;

    /* not for armagetron
       if (COM_CheckParm ("-noudp"))
       return -1;
    */

    // determine my name & address
    //int myAddr = 0;
    //int hostnameres = gethostname(buff, MAXHOSTNAMELEN);
    //if ( 0 == hostnameres )
    //{
    //   local = gethostbyname(buff);
    //   if ( local )
    //   {
    //        myAddr = *reinterpret_cast<int *>(local->h_addr_list[0]);
    //   }
    //   else
    //    {
    //        Con_Printf ("ANET_Init: Unable to determine IP adress.\n");
    //    }
    //}
    //else
    //{
    //    Con_Printf ("ANET_Init: Unable to determine hostname.\n");
    // }

    // fallback: use loopback
    //if ( myAddr == 0 )
    //{
    //    myAddr = inet_addr("127.0.0.1");
    //}

    //tString hostname;

    // if the armagetron hostname isn't set, set it to the clamped machine name
    //if (strcmp(hostname, "UNNAMED") == 0 && buff[0] && hostnameres == 0 )
    //{
    //    buff[15] = 0;
    //    hostname=buff;
    //}

    //ANET_GetSocketAddr (controlSocket_, &addr);
    //my_tcpip_address=ANET_AddrToString (&addr);
    //colon = strrchr (my_tcpip_address, ':');
    //if (colon)
    //    *colon = 0;

    //  Con_Printf("UDP Initialized\n");
    //tcpipAvailable = true;

Here is the call graph for this function:

void nBasicNetworkSystem::Shutdown

(

void

)

shuts donw the network

Definition at line 2697 of file nSocket.cpp.

References nSocket::Close(), controlSocket_, nSocketListener::Listen(), and listener_.

Referenced by main(), and ~nBasicNetworkSystem().

{
    // stop listening
    listener_.Listen(false);

    // close the control socket

Here is the call graph for this function:

Here is the caller graph for this function:

bool nBasicNetworkSystem::Select

(

REAL

dt

)

waits the specified time for data to arrive on the sockets

Parameters:

dt

the time in seconds to wait at max

Returns:

true if data came in

Definition at line 2641 of file nSocket.cpp.

References controlSocket_, nSocket::GetSocket(), nSocketListener::GetSockets(), listener_, max(), NULL, tRecorder::PlaybackStrict(), tRecorder::Record(), section, and tDelay().

Referenced by main(), sg_HostGame(), update_settings(), and gNetIdler::Wait().

{
    int retval = 0;
    static char const * section = "NETSELECT";
    if ( !tRecorder::PlaybackStrict( section, retval ) )
    {
        if ( controlSocket_.GetSocket() < 0 )
        {
            tDelay( int( dt * 1000000 ) );
            return false;
        }

        fd_set rfds; // set of sockets to wathc
        struct timeval tv; // time value to pass to select()

        FD_ZERO( &rfds );

        // watch the control socket
        FD_SET( controlSocket_.GetSocket(), &rfds );
        // con << "Watching " << controlSocket_.GetSocket();

        int max = controlSocket_.GetSocket();

        // watch listening sockets
        for( nSocketListener::SocketArray::const_iterator iter = listener_.GetSockets().begin(); iter != listener_.GetSockets().end(); ++iter )
        {
            FD_SET( (*iter).GetSocket(), &rfds );
            if ( (*iter).GetSocket() > max )
                max = (*iter).GetSocket();
            // con << ", " << (*iter).GetSocket();
        }

        // set time
        tv.tv_sec  = static_cast< long int >( dt );
        tv.tv_usec = static_cast< long int >( (dt-tv.tv_sec)*1000000 );

        // delegate to system select
        retval = select(max+1, &rfds, NULL, NULL, &tv);
    }
    tRecorder::Record( section, retval );

    // con << " : " << retval << "\n";

    // return result

Here is the call graph for this function:

Here is the caller graph for this function:

nSocketListener & nBasicNetworkSystem::AccessListener

(

void

)

Accesses listening sockets.

Returns:

listening sockets as a modifiable reference

Definition at line 923 of file nSocket.cpp.

References listener_.

Referenced by sg_HostGame(), and sn_Listen().

{

Here is the caller graph for this function:

nBasicNetworkSystem& nBasicNetworkSystem::SetListener

(

nSocketListener const &

listener

)

Sets listening sockets.

nSocketListener const & nBasicNetworkSystem::GetListener

(

void

)

const

Gets listening sockets.

Returns:

listening sockets

Definition at line 871 of file nSocket.cpp.

References listener_.

Referenced by nServerInfo::TellMasterAboutMe().

{

Here is the caller graph for this function:

nSocket const & nBasicNetworkSystem::GetControlSocket

(

void

)

const

Gets network control socket.

Returns:

network control socket

Definition at line 938 of file nSocket.cpp.

References controlSocket_.

{

nBasicNetworkSystem& nBasicNetworkSystem::operator=

(

const nBasicNetworkSystem &

)

[private]

nSocket & nBasicNetworkSystem::AccessControlSocket

(

void

)

[private]

Accesses network control socket.

Returns:

network control socket as a modifiable reference

Definition at line 990 of file nSocket.cpp.

References controlSocket_.

{

---

Member Data Documentation

nSocketListener nBasicNetworkSystem::listener_ [private]

listening sockets

Definition at line 242 of file nSocket.h.

Referenced by AccessListener(), GetListener(), Select(), and Shutdown().

nSocket nBasicNetworkSystem::controlSocket_ [private]

network control socket

Definition at line 243 of file nSocket.h.

Referenced by AccessControlSocket(), GetControlSocket(), Init(), Select(), and Shutdown().

---

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

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

---