EVETCPConnection Class Reference

EVE derivation of TCP connection. More...

#include "EVETCPConnection.h"

Inheritance diagram for EVETCPConnection:

Collaboration diagram for EVETCPConnection:

Public Types
enum	packet_direction { PACKET_INBOUND, PACKET_OUTBOUND }
	Dumps buffer to file. More...
Public Types inherited from TCPConnection
enum	state_t { STATE_DISCONNECTED, STATE_CONNECTING, STATE_CONNECTED, STATE_DISCONNECTING }

Public Member Functions
	EVETCPConnection ()
	Creates empty EVE connection. More...
virtual	~EVETCPConnection ()
void	QueueRep (const PyRep *rep, bool compress=true)
	Queues given PyRep into send queue. More...
PyRep *	PopRep ()
	Pops PyRep from receive queue. More...
void	DumpBuffer (Buffer *buf, packet_direction packet_direction)
Public Member Functions inherited from TCPConnection
	TCPConnection ()
	Creates new connection in STATE_DISCONNECTED. More...
virtual	~TCPConnection ()
	Cleans connection up. More...
uint32	GetrIP () const
uint16	GetrPort () const
std::string	GetAddress ()
state_t	GetState () const
bool	Connect (uint32 rIP, uint16 rPort, char *errbuf=0)
	Connects to specified address. More...
void	AsyncConnect (uint32 rIP, uint16 rPort)
	Schedules asynchronous connect to specified address. More...
void	Disconnect ()
	Schedules disconnect of current connection. More...
bool	Send (Buffer **data)
	Enqueues data to be sent. More...

Static Public Attributes
static const uint32	TIMEOUT_MS = 10 * 60 * 1000
	Time (in milliseconds) after which the connection is dropped if no data were received. More...
static const uint32	PACKET_SIZE_LIMIT = 1024 * 1024
	Hardcoded limit of packet size (NetClient.dll). More...

Protected Member Functions
	EVETCPConnection (Socket *sock, uint32 rIP, uint16 rPort)
	Creates new EVE connection from existing socket. More...
bool	RecvData (char *errbuf=0)
	Receives data and puts them into receive queue. More...
bool	ProcessReceivedData (char *errbuf=0)
	Processes received data. More...
void	ClearBuffers ()
	Clears send and receive buffers. More...
Protected Member Functions inherited from TCPConnection
	TCPConnection (Socket *sock, uint32 rIP, uint16 rPort)
	Creates connection from an existing socket. More...
void	StartLoop ()
	Starts working thread. More...
void	WaitLoop ()
	Blocks calling thread until working thread terminates. More...
virtual bool	Process ()
	Does all stuff that needs to be periodically done to keep connection alive. More...
virtual bool	SendData (char *errbuf=0)
	Sends data in send queue. More...
void	DoDisconnect ()
	Disconnects socket. More...
void	TCPConnectionLoop ()
	Loop for worker threads. More...

Protected Attributes
Timer	mTimeoutTimer
	Timer used to implement timeout. More...
Mutex	mMInQueue
	Mutex to protect received data queue. More...
StreamPacketizer	mInQueue
	Received data queue. More...
Protected Attributes inherited from TCPConnection
Mutex	mMSock
Socket *	mSock
state_t	mSockState
uint32	mrIP
uint16	mrPort
Mutex	mMLoopRunning
Mutex	mMSendQueue
std::deque< Buffer * >	mSendQueue
Buffer *	mRecvBuf

Friends
class	EVETCPServer

Additional Inherited Members
Static Protected Member Functions inherited from TCPConnection
static void *	TCPConnectionLoop (void *arg)
	Loop for worker threads. More...

Detailed Description

EVE derivation of TCP connection.

Author

Zhur, Bloody.Rabbit

Definition at line 37 of file EVETCPConnection.h.

Member Enumeration Documentation

enum EVETCPConnection::packet_direction

Dumps buffer to file.

Parameters

[in]	buf	Buffer
[in]	direction	Direction of packet inBound/outBound

Enumerator
PACKET_INBOUND
PACKET_OUTBOUND

Definition at line 75 of file EVETCPConnection.h.

    {
        PACKET_INBOUND,
        PACKET_OUTBOUND
    };

Constructor & Destructor Documentation

EVETCPConnection::EVETCPConnection

(

)

Creates empty EVE connection.

Definition at line 38 of file EVETCPConnection.cpp.

: TCPConnection(),
  mTimeoutTimer( TIMEOUT_MS )
{
}

virtual EVETCPConnection::~EVETCPConnection ( )

inlinevirtual

Definition at line 52 of file EVETCPConnection.h.

{ /* do nothing here */ }

EVETCPConnection::EVETCPConnection ( Socket *  sock, uint32  rIP, uint16  rPort  )

protected

Creates new EVE connection from existing socket.

Parameters

[in]	sock	Socket to be used for connection.
[in]	rIP	Remote IP the socket is connected to.
[in]	rPort	Remote TCP port the socket is connected to.

Definition at line 44 of file EVETCPConnection.cpp.

: TCPConnection( sock, rIP, rPort ),
  mTimeoutTimer( TIMEOUT_MS )
{
}

Member Function Documentation

void EVETCPConnection::ClearBuffers ( )

protectedvirtual

Clears send and receive buffers.

Reimplemented from TCPConnection.

Definition at line 135 of file EVETCPConnection.cpp.

References StreamPacketizer::ClearBuffers(), TCPConnection::ClearBuffers(), mInQueue, mMInQueue, mTimeoutTimer, and Timer::Start().

{
    TCPConnection::ClearBuffers();
    mTimeoutTimer.Start();
    MutexLock lock( mMInQueue );
    mInQueue.ClearBuffers();
}

Here is the call graph for this function:

void EVETCPConnection::DumpBuffer	(	Buffer *	buf,
		packet_direction	packet_direction
	)

Definition at line 143 of file EVETCPConnection.cpp.

References Buffer::begin(), Buffer::end(), and PACKET_INBOUND.

{
    /*
    FILE *logpacket;
    char timestamp[16];
    time_t rawtime = time(0);
    tm *now = localtime(&rawtime);
    strftime(timestamp,16,"%y%m%d_%H%M%S",now);

    logpacket = fopen(strcat("c:\\logs\\",strcat(timestamp,".txt")), "w");
    Buffer:: size_type index;
    for(index=0; index<= packet->size(); index++)
    {
        fputs(packet->Get(index), logpacket);
    }
    */

    FILE *logpacket;
    char timestamp[16];
    time_t rawtime = time(0);
    tm *now = localtime(&rawtime);
    strftime(timestamp,16,"%y%m%d_%H%M%S",now);

    std::string path = EVEMU_ROOT "/packet_log/";
    path += timestamp;
    if(packet_direction == PACKET_INBOUND)
        path += "_client_";
    else
        path += "_server_";
    path += ".txt";
    logpacket = fopen(path.c_str(), "w");

    Buffer::iterator<uint8> cur = buf->begin<uint8>();
    for (; cur != buf->end<uint8>(); ++cur) {
        uint8 test = *cur;
        fputc(test, logpacket);
    }
    fclose(logpacket);
}

Here is the call graph for this function:

PyRep * EVETCPConnection::PopRep

(

)

Pops PyRep from receive queue.

Returns

Popped PyRep; NULL if nothing was received.

Definition at line 84 of file EVETCPConnection.cpp.

References InflateUnmarshal(), mInQueue, mMInQueue, PACKET_SIZE_LIMIT, StreamPacketizer::PopPacket(), SafeDelete(), Buffer::size(), and sLog.

Referenced by EVEClientSession::PopPacket().

{
    PyRep* res(nullptr);

    MutexLock lock( mMInQueue );
    Buffer* packet = mInQueue.PopPacket();

    if (packet != nullptr) {
        if ( PACKET_SIZE_LIMIT < packet->size() ) {
            sLog.Error( "Network", "Packet length %lu exceeds hardcoded packet length limit %u.", packet->size(), PACKET_SIZE_LIMIT );
        } else {
           // if (is_log_enabled(DEBUG__DEBUG))
           //     DumpBuffer( packet, PACKET_INBOUND );
            res = InflateUnmarshal( *packet );
        }
    }

    SafeDelete( packet );
    return res;
}

Here is the call graph for this function:

Here is the caller graph for this function:

bool EVETCPConnection::ProcessReceivedData ( char *  errbuf = 0 )

protectedvirtual

Processes received data.

This function must be overloaded by children to process received data. Called every time a chunk of new data is received. Please note that receive buffer is overwritten every time data is received.

Parameters

[out]

errbuf

Buffer which receives description of error.

Returns

True if processing ran fine, false if not.

Implements TCPConnection.

Definition at line 105 of file EVETCPConnection.cpp.

References StreamPacketizer::InputData(), mInQueue, mMInQueue, TCPConnection::mRecvBuf, mTimeoutTimer, StreamPacketizer::Process(), and Timer::Start().

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

    MutexLock lock( mMInQueue );

    // put bytes into packetizer
    mInQueue.InputData( *mRecvBuf );
    // process packetizer
    mInQueue.Process();
    mTimeoutTimer.Start();

    return true;
}

Here is the call graph for this function:

void EVETCPConnection::QueueRep	(	const PyRep *	rep,
		bool	compress = true
	)

Queues given PyRep into send queue.

Parameters

[in]

rep

PyRep to be queued.

Definition at line 50 of file EVETCPConnection.cpp.

References Buffer::end(), MarshalDeflate(), PACKET_SIZE_LIMIT, PySafeDecRef, Buffer::ResizeAt(), SafeDelete(), TCPConnection::Send(), Buffer::size(), and sLog.

Referenced by EVEClientSession::_HandleCommand(), Client::_LoginFail(), Client::_VerifyCrypto(), Client::_VerifyFuncResult(), Client::_VerifyLogin(), EVEClientSession::QueuePacket(), and EVEClientSession::Reset().

{
    Buffer* pBuffer = new Buffer();

    // make room for length
    const Buffer::iterator<uint32> bufLen = pBuffer->end<uint32>();
    pBuffer->ResizeAt( bufLen, 1 );

    if (PACKET_SIZE_LIMIT < pBuffer->size()) {
        sLog.Error( "Network", "Packet length %u exceeds hardcoded packet length limit %lu.", pBuffer->size(), PACKET_SIZE_LIMIT );
        SafeDelete( pBuffer );
        return;
    }

    bool success(false);
    if (compress)
        success = MarshalDeflate(rep, *pBuffer);
    else
        success = MarshalDeflate(rep, *pBuffer, PACKET_SIZE_LIMIT);

    if (success) {
       // if (is_log_enabled(DEBUG__DEBUG))
       //     DumpBuffer( pBuffer, PACKET_OUTBOUND );
        // write length
        *bufLen = ( pBuffer->size() - sizeof( uint32 ) );
        Send( &pBuffer );
    } else {
        sLog.Error( "Network", "Failed to marshal new packet." );
    }

    PySafeDecRef(rep);
    SafeDelete( pBuffer );
}

Here is the call graph for this function:

Here is the caller graph for this function:

bool EVETCPConnection::RecvData ( char *  errbuf = 0 )

protectedvirtual

Receives data and puts them into receive queue.

Parameters

[out]

errbuf

Buffer which receives description of error.

Returns

True if receive was OK, false if not.

Reimplemented from TCPConnection.

Definition at line 121 of file EVETCPConnection.cpp.

References Timer::Check(), mTimeoutTimer, TCPConnection::RecvData(), snprintf, and TCPCONN_ERRBUF_SIZE.

{
    if( !TCPConnection::RecvData( errbuf ) )
        return false;

    if( mTimeoutTimer.Check() ) {
        if (errbuf != nullptr)
            snprintf( errbuf, TCPCONN_ERRBUF_SIZE, "Connection timeout" );
        return false;
    }

    return true;
}

Here is the call graph for this function:

Friends And Related Function Documentation

friend class EVETCPServer

friend

Definition at line 40 of file EVETCPConnection.h.

Member Data Documentation

StreamPacketizer EVETCPConnection::mInQueue

protected

Received data queue.

Definition at line 103 of file EVETCPConnection.h.

Referenced by ClearBuffers(), PopRep(), and ProcessReceivedData().

Mutex EVETCPConnection::mMInQueue

protected

Mutex to protect received data queue.

Definition at line 101 of file EVETCPConnection.h.

Referenced by ClearBuffers(), PopRep(), and ProcessReceivedData().

Timer EVETCPConnection::mTimeoutTimer

protected

Timer used to implement timeout.

Definition at line 98 of file EVETCPConnection.h.

Referenced by ClearBuffers(), ProcessReceivedData(), and RecvData().

const uint32 EVETCPConnection::PACKET_SIZE_LIMIT = 1024 * 1024

static

Hardcoded limit of packet size (NetClient.dll).

Definition at line 46 of file EVETCPConnection.h.

Referenced by PopRep(), and QueueRep().

const uint32 EVETCPConnection::TIMEOUT_MS = 10 * 60 * 1000

static

Time (in milliseconds) after which the connection is dropped if no data were received.

Definition at line 44 of file EVETCPConnection.h.

---

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

• /backups/local/src/eve/EvEmu_Crucible/src/eve-common/network/EVETCPConnection.h
• /backups/local/src/eve/EvEmu_Crucible/src/eve-common/network/EVETCPConnection.cpp