BaseTCPServer Class Reference

Generic class for TCP server. More...

#include "TCPServer.h"

Inheritance diagram for BaseTCPServer:

Collaboration diagram for BaseTCPServer:

Public Member Functions
	BaseTCPServer ()
	Creates empty TCP server. More...
virtual	~BaseTCPServer ()
	Cleans server up. More...
uint16	GetPort () const
bool	IsOpen () const
bool	Open (uint16 port, char *errbuf=0)
	Start listening on specified port. More...
void	Close ()
	Stops started listening. More...

Protected Member Functions
void	StartLoop ()
	Starts worker thread. More...
void	WaitLoop ()
	Waits for worker thread to terminate. More...
virtual bool	Process ()
	Does periodical stuff to keep the server alive. More...
void	ListenNewConnections ()
	Accepts all new connections. More...
virtual void	CreateNewConnection (Socket *sock, uint32 rIP, uint16 rPort)=0
	Processes new connection. More...
void	TCPServerLoop ()
	Loop for worker threads. More...

Static Protected Member Functions
static void *	TCPServerLoop (void *arg)
	Loop for worker threads. More...

Protected Attributes
Mutex	mMSock
Socket *	mSock
uint16	mPort
Mutex	mMLoopRunning

Detailed Description

Generic class for TCP server.

Author

Zhur, Bloody.Rabbit

Definition at line 42 of file TCPServer.h.

Constructor & Destructor Documentation

BaseTCPServer::BaseTCPServer

(

)

Creates empty TCP server.

Definition at line 37 of file TCPServer.cpp.

: mSock( nullptr ),
  mPort( 0 )
{
}

BaseTCPServer::~BaseTCPServer ( )

virtual

Cleans server up.

Definition at line 43 of file TCPServer.cpp.

References Close(), sThread, and WaitLoop().

{
    // Close socket
    Close();
    // Wait until worker thread terminates
    WaitLoop();
    /*  delete thread here and remove from list */
    sThread.RemoveThread(pthread_self());
}

Here is the call graph for this function:

Member Function Documentation

void BaseTCPServer::Close

(

)

Stops started listening.

Definition at line 118 of file TCPServer.cpp.

References mMSock, mPort, mSock, and SafeDelete().

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

{
    MutexLock lock(mMSock);
    SafeDelete(mSock);
    mPort = 0;
}

Here is the call graph for this function:

Here is the caller graph for this function:

virtual void BaseTCPServer::CreateNewConnection ( Socket *  sock, uint32  rIP, uint16  rPort  )

protectedpure virtual

Processes new connection.

This function must be overloaded by children to process new connections. Called every time a new connection is accepted.

Implemented in EVETCPServer.

Referenced by ListenNewConnections().

Here is the caller graph for this function:

uint16 BaseTCPServer::GetPort ( ) const

inline

Returns

TCP port the server listens on.

Definition at line 55 of file TCPServer.h.

References mPort.

{ return mPort; }

bool BaseTCPServer::IsOpen

(

)

const

Returns

True if listening has been opened, false if not.

Definition at line 53 of file TCPServer.cpp.

References Mutex::Lock(), mMSock, mSock, and Mutex::Unlock().

Referenced by Open(), and Process().

{
    mMSock.Lock();
    bool ret = (mSock != nullptr);
    mMSock.Unlock();
    return ret;
}

Here is the call graph for this function:

Here is the caller graph for this function:

void BaseTCPServer::ListenNewConnections ( )

protected

Accepts all new connections.

Definition at line 156 of file TCPServer.cpp.

References Socket::accept(), CreateNewConnection(), Socket::fcntl(), mMSock, mSock, and Socket::setopt().

Referenced by Process().

{
    Socket* sock(nullptr);
    sockaddr_in from = sockaddr_in();
    from.sin_family = AF_INET;
    unsigned int fromlen = sizeof( from );
    MutexLock lock( mMSock );

    while ((sock = mSock->accept((sockaddr*)&from, &fromlen))) {
        sock->fcntl( F_SETFL, O_NONBLOCK );
        unsigned int bufsize = 64 * 1024; // 64kbyte receive buffer, up from default of 8k
        sock->setopt( SOL_SOCKET, SO_RCVBUF, &bufsize, sizeof( bufsize ) );
        // New TCP connection, this must consume the socket.
        CreateNewConnection( sock, from.sin_addr.s_addr, ntohs( from.sin_port ) );
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

bool BaseTCPServer::Open	(	uint16	port,
		char *	errbuf = 0
	)

Start listening on specified port.

Parameters

[in]	port	Port on which listening should be started.
[out]	errbuf	Error buffer which receives description of error.

Returns

True if listening has been started successfully, false if not.

Definition at line 61 of file TCPServer.cpp.

References _log, Socket::bind(), Socket::fcntl(), IsOpen(), Socket::listen(), Mutex::Lock(), mMSock, mPort, mSock, SafeDelete(), Socket::setopt(), snprintf, SOCKET_ERROR, StartLoop(), TCPSRV_ERRBUF_SIZE, Mutex::Unlock(), and WaitLoop().

Referenced by main().

{
    if (errbuf != nullptr)
        errbuf[0] = 0;

    // mutex lock
    MutexLock lock( mMSock );

    if (IsOpen()) {
        _log(TCP_SERVER__ERROR, "Open() - Listening socket already open" );
        if (errbuf != nullptr)
            snprintf( errbuf, TCPSRV_ERRBUF_SIZE, "Listening socket already open" );
        return false;
    } else {
        mMSock.Unlock();
        WaitLoop();
        mMSock.Lock();
    }

    // Setting up TCP port for new TCP connections
    mSock = new Socket( AF_INET, SOCK_STREAM, 0 );

    unsigned int reuse_addr = 1;
    mSock->setopt( SOL_SOCKET, SO_REUSEADDR, &reuse_addr, sizeof( reuse_addr ) );

    // Setup internet address information.
    // This is used with the bind() call
    sockaddr_in address = sockaddr_in();
    memset( &address, 0, sizeof( address ) );
    address.sin_family = AF_INET;
    address.sin_port = htons( port );
    address.sin_addr.s_addr = htonl( INADDR_ANY );

    if (mSock->bind((sockaddr*)&address, sizeof(address)) < 0) {
        _log(TCP_SERVER__ERROR, "Open()::bind() < 0" );
        if (errbuf)
            snprintf( errbuf, TCPSRV_ERRBUF_SIZE, "%s", strerror( errno ) );
        SafeDelete( mSock );
        return false;
    }

    unsigned int bufsize = 64 * 1024; // 64kbyte receive buffer, up from default of 8k
    mSock->setopt( SOL_SOCKET, SO_RCVBUF, &bufsize, sizeof( bufsize ) );
    mSock->fcntl( F_SETFL, O_NONBLOCK );
    if (mSock->listen() == SOCKET_ERROR) {
        _log(TCP_SERVER__ERROR, "Open()::listen() failed, Error: %s", strerror( errno ) );
        if (errbuf)
            snprintf( errbuf, TCPSRV_ERRBUF_SIZE, "%s", strerror( errno ) );
        SafeDelete( mSock );
        return false;
    }

    mPort = port;
    StartLoop();
    return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

bool BaseTCPServer::Process ( )

protectedvirtual

Does periodical stuff to keep the server alive.

Returns

True if the server should be further processed, false if not (eg. error occurred).

Definition at line 146 of file TCPServer.cpp.

References IsOpen(), ListenNewConnections(), and mMSock.

Referenced by TCPServerLoop().

{
    MutexLock lock( mMSock );
    if (IsOpen()) {
        ListenNewConnections();
        return true;
    }
    return false;
}

Here is the call graph for this function:

Here is the caller graph for this function:

void BaseTCPServer::StartLoop ( )

protected

Starts worker thread.

This function just starts worker thread; it doesn't check whether there already is one running!

Definition at line 125 of file TCPServer.cpp.

References sThread, and TCPServerLoop().

Referenced by Open().

{
    /* since there is only one instance of BaseTCPServer, we can create thread here instead
     * of sending to Thread class for creation and management
     * update this to use Thread class management (sThread) if management here becomes a problem.
     */
    sThread.CreateThread(TCPServerLoop, this);
    /*
    pthread_t thread;
    pthread_create( &thread, nullptr, TCPServerLoop, this );
    _log(THREAD__WARNING, "StartLoop() - Created thread ID 0x%X for TCPServerLoop", thread);
    sThread.AddThread(thread);*/
}

Here is the call graph for this function:

Here is the caller graph for this function:

void * BaseTCPServer::TCPServerLoop ( void *  arg )

staticprotected

Loop for worker threads.

This function only casts arg to BaseTCPServer and calls member TCPServerLoop().

Parameters

[in]

arg

Pointer to BaseTCPServer.

Definition at line 173 of file TCPServer.cpp.

References TCPServerLoop().

Referenced by TCPServerLoop().

{
    BaseTCPServer* tcps = reinterpret_cast< BaseTCPServer* >( arg );
    assert( tcps != nullptr );

    tcps->TCPServerLoop();

    return nullptr;
}

Here is the call graph for this function:

Here is the caller graph for this function:

void BaseTCPServer::TCPServerLoop ( )

protected

Loop for worker threads.

Definition at line 183 of file TCPServer.cpp.

References GetTickCount(), Mutex::Lock(), mMLoopRunning, Process(), Sleep(), TCPSRV_LOOP_GRANULARITY, and Mutex::Unlock().

Referenced by StartLoop().

{
    mMLoopRunning.Lock();
    uint32 start = GetTickCount();
    while (Process()) {
        // do the stuff for thread sleeping
        start = GetTickCount() - start;
        if (TCPSRV_LOOP_GRANULARITY > start)
            Sleep(TCPSRV_LOOP_GRANULARITY - start);
        start = GetTickCount();
    }
    mMLoopRunning.Unlock();
}

Here is the call graph for this function:

Here is the caller graph for this function:

void BaseTCPServer::WaitLoop ( )

protected

Waits for worker thread to terminate.

Definition at line 139 of file TCPServer.cpp.

References Mutex::Lock(), mMLoopRunning, and Mutex::Unlock().

Referenced by Open(), and ~BaseTCPServer().

{
    //wait for running loop to stop.
    mMLoopRunning.Lock();
    mMLoopRunning.Unlock();
}

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

Mutex BaseTCPServer::mMLoopRunning

mutableprotected

Worker thread acquires this mutex before it starts processing; used for thread synchronization.

Definition at line 127 of file TCPServer.h.

Referenced by TCPServerLoop(), and WaitLoop().

Mutex BaseTCPServer::mMSock

mutableprotected

Mutex to protect socket and associated variables.

Definition at line 120 of file TCPServer.h.

Referenced by Close(), IsOpen(), ListenNewConnections(), Open(), and Process().

uint16 BaseTCPServer::mPort

protected

Port the socket is listening on.

Definition at line 124 of file TCPServer.h.

Referenced by Close(), GetPort(), and Open().

Socket* BaseTCPServer::mSock

protected

Socket used for listening.

Definition at line 122 of file TCPServer.h.

Referenced by Close(), IsOpen(), ListenNewConnections(), and Open().

---

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

• /backups/local/src/eve/EvEmu_Crucible/src/eve-core/network/TCPServer.h
• /backups/local/src/eve/EvEmu_Crucible/src/eve-core/network/TCPServer.cpp