EVEClientSession Class Reference

Client session from server's side. More...

#include "EVESession.h"

Inheritance diagram for EVEClientSession:

Collaboration diagram for EVEClientSession:

Public Types
typedef TCPConnection::state_t	state_t

Public Member Functions
	EVEClientSession (EVETCPConnection **n)
virtual	~EVEClientSession ()
	Destroys contained connection. More...
state_t	GetState () const
std::string	GetAddress () const
void	Reset ()
	Resets session. More...
void	QueuePacket (PyPacket *packet)
	Queues new packet, retaking ownership. More...
PyPacket *	PopPacket ()
	Pops new packet from queue. More...
void	CloseClientConnection ()
	Disconnects client from the server. More...

Protected Member Functions
virtual void	_GetVersion (VersionExchangeServer &version)=0
	Obtains version. More...
virtual uint32	_GetQueuePosition ()=0
virtual bool	_VerifyVersion (VersionExchangeClient &version)=0
	Verifies version. More...
virtual bool	_VerifyVIPKey (const std::string &vipKey)=0
	Verifies VIP key. More...
virtual bool	_VerifyCrypto (CryptoRequestPacket &cr)=0
	Verifies crypto. More...
virtual bool	_VerifyLogin (CryptoChallengePacket &ccp)=0
	Verifies login. More...
virtual bool	_VerifyFuncResult (CryptoHandshakeResult &result)=0
	Verifies function result. More...

Protected Attributes
EVETCPConnection *const	mNet

Private Member Functions
PyPacket *	_HandleVersion (PyRep *rep)
PyPacket *	_HandleCommand (PyRep *rep)
PyPacket *	_HandleCrypto (PyRep *rep)
PyPacket *	_HandleAuthentication (PyRep *rep)
PyPacket *	_HandleFuncResult (PyRep *rep)
PyPacket *	_HandlePacket (PyRep *rep)

Private Attributes
PyPacket *(EVEClientSession::*	mPacketHandler )(PyRep *rep)

Detailed Description

Client session from server's side.

Defines what server needs to do when dealing with client; takes care of initial authentication, before actual packets are sent.

Author

Bloody.Rabbit

Definition at line 49 of file EVESession.h.

Member Typedef Documentation

typedef TCPConnection::state_t EVEClientSession::state_t

Typedef for readability.

Definition at line 53 of file EVESession.h.

Constructor & Destructor Documentation

EVEClientSession::EVEClientSession

(

EVETCPConnection **

n

)

Parameters

[in]

n

Connection of this session.

Definition at line 38 of file EVESession.cpp.

: mNet( *n ),
mPacketHandler( nullptr )
{
    *n = nullptr;
}

EVEClientSession::~EVEClientSession ( )

virtual

Destroys contained connection.

Definition at line 45 of file EVESession.cpp.

References mNet.

                                    {
    // Destroy connection we used
    delete mNet;
}

Member Function Documentation

virtual uint32 EVEClientSession::_GetQueuePosition ( )

protectedpure virtual

Returns

Current count of connected users.

Current position in connection queue.

Implemented in Client.

Referenced by _HandleCommand().

Here is the caller graph for this function:

virtual void EVEClientSession::_GetVersion ( VersionExchangeServer &  version )

protectedpure virtual

Obtains version.

Parameters

[in]

version

Object to be filled with version information.

Implemented in Client.

Referenced by Reset().

Here is the caller graph for this function:

PyPacket * EVEClientSession::_HandleAuthentication ( PyRep *  rep )

private

Definition at line 158 of file EVESession.cpp.

References _HandleFuncResult(), _VerifyLogin(), GetAddress(), mPacketHandler, PopPacket(), and sLog.

Referenced by _HandleCrypto().

                                                              {
    //just to be sure
    CryptoChallengePacket ccp;
    if ( !ccp.Decode( &rep ) )
        sLog.Error("_HandleAuthentication", "%s: Received invalid crypto challenge!", GetAddress().c_str());
    else if ( _VerifyLogin( ccp ) )
        mPacketHandler = &EVEClientSession::_HandleFuncResult;

    return PopPacket();
}

Here is the call graph for this function:

Here is the caller graph for this function:

PyPacket * EVEClientSession::_HandleCommand ( PyRep *  rep )

private

Definition at line 106 of file EVESession.cpp.

References _GetQueuePosition(), _HandleCrypto(), _log, _VerifyVIPKey(), PyRep::AsTuple(), PyRep::Dump(), GetAddress(), is_log_enabled, PyRep::IsTuple(), mNet, mPacketHandler, PopPacket(), EVETCPConnection::QueueRep(), Reset(), PyTuple::size(), and sLog.

Referenced by _HandleVersion().

                                                       {
    //check if it actually is tuple
    if ( !rep->IsTuple() )
        sLog.Error("_HandleCommand", "%s: Invalid packet during waiting for command (tuple expected).", GetAddress().c_str());
    else if ( rep->AsTuple()->size() == 2 ) {    // decode
        //QC = Queue Check
        NetCommand_QC cmd;
        if ( !cmd.Decode( &rep ) )
            sLog.Error("_HandleCommand", "%s: Failed to decode 2-arg command.", GetAddress().c_str());
        else {
            sLog.Debug("_HandleCommand", "%s: Got Queue Check command.", GetAddress().c_str());

            //they return position in queue
            PyRep* rsp = new PyInt( _GetQueuePosition() );
            mNet->QueueRep( rsp );

            //now reset connection
            Reset();
        }
    } else if ( rep->AsTuple()->size() == 3 ) {
        //this is sent when client is logging in
        NetCommand_VK cmd;
        if ( !cmd.Decode( &rep ) ) {
            sLog.Error("_HandleCommand", "%s: Failed to decode 3-arg command.", GetAddress().c_str());
        } else {
            sLog.Debug("_HandleCommand", "%s: Got VK command, vipKey=%s.", GetAddress().c_str(), cmd.vipKey.c_str());

            if ( _VerifyVIPKey( cmd.vipKey ) )
                mPacketHandler = &EVEClientSession::_HandleCrypto;
        }
    } else {
        if (is_log_enabled(NET__PRES_ERROR)) {
            _log(NET__PRES_ERROR, "%s: Received invalid command packet:", GetAddress().c_str());
            rep->Dump(NET__PRES_ERROR, "  ");
        }
    }

    // recurse
    return PopPacket();
}

Here is the call graph for this function:

Here is the caller graph for this function:

PyPacket * EVEClientSession::_HandleCrypto ( PyRep *  rep )

private

Definition at line 147 of file EVESession.cpp.

References _HandleAuthentication(), _VerifyCrypto(), GetAddress(), mPacketHandler, PopPacket(), and sLog.

Referenced by _HandleCommand().

                                                      {
    CryptoRequestPacket cr;
    if ( !cr.Decode( &rep ) )
        sLog.Error("_HandleCrypto", "%s: Received invalid crypto request!", GetAddress().c_str());
    else if ( _VerifyCrypto( cr ) )
        mPacketHandler = &EVEClientSession::_HandleAuthentication;

    // recurse
    return PopPacket();
}

Here is the call graph for this function:

Here is the caller graph for this function:

PyPacket * EVEClientSession::_HandleFuncResult ( PyRep *  rep )

private

Definition at line 169 of file EVESession.cpp.

References _HandlePacket(), _VerifyFuncResult(), GetAddress(), mPacketHandler, PopPacket(), and sLog.

Referenced by _HandleAuthentication().

                                                          {
    CryptoHandshakeResult hr;
    if ( !hr.Decode( &rep ) )
        sLog.Error("_HandleFuncResult", "%s: Received invalid crypto handshake result!", GetAddress().c_str());
    else if ( _VerifyFuncResult( hr ) )
        mPacketHandler = &EVEClientSession::_HandlePacket;

    return PopPacket();
}

Here is the call graph for this function:

Here is the caller graph for this function:

PyPacket * EVEClientSession::_HandlePacket ( PyRep *  rep )

private

Definition at line 179 of file EVESession.cpp.

References PyPacket::Decode(), GetAddress(), PopPacket(), PySafeDecRef, SafeDelete(), and sLog.

Referenced by _HandleFuncResult().

                                                      {
    //take the PyRep and turn it into a PyPacket
    PyPacket* p = new PyPacket();
    if ( !p->Decode( &rep ) ) { //rep is consumed here
        sLog.Error("_HandlePacket", "%s: Failed to decode packet rep", GetAddress().c_str());
        SafeDelete( p );
        PySafeDecRef(rep);
        return PopPacket();
    }

    return p;
}

Here is the call graph for this function:

Here is the caller graph for this function:

PyPacket * EVEClientSession::_HandleVersion ( PyRep *  rep )

private

Definition at line 94 of file EVESession.cpp.

References _HandleCommand(), _VerifyVersion(), GetAddress(), mPacketHandler, PopPacket(), and sLog.

Referenced by Reset().

                                                       {
    //we are waiting for their version information...
    VersionExchangeClient ve;
    if ( !ve.Decode( &rep ) )
        sLog.Error("_HandleVersion", "%s: Received invalid version exchange!", GetAddress().c_str());
    else if ( _VerifyVersion( ve ) )
        mPacketHandler = &EVEClientSession::_HandleCommand;

    // recurse
    return PopPacket();
}

Here is the call graph for this function:

Here is the caller graph for this function:

virtual bool EVEClientSession::_VerifyCrypto ( CryptoRequestPacket &  cr )

protectedpure virtual

Verifies crypto.

Parameters

[in]

cr

Crypto sent by client.

Return values

true	Verification succeeded; proceeds to next state.
false	Verification failed; stays in current state.

Implemented in Client.

Referenced by _HandleCrypto().

Here is the caller graph for this function:

virtual bool EVEClientSession::_VerifyFuncResult ( CryptoHandshakeResult &  result )

protectedpure virtual

Verifies function result.

Parameters

[in]

result

Function result sent by client.

Return values

true	Verification succeeded; proceeds to next state.
false	Verification failed; stays in current state.

Implemented in Client.

Referenced by _HandleFuncResult().

Here is the caller graph for this function:

virtual bool EVEClientSession::_VerifyLogin ( CryptoChallengePacket &  ccp )

protectedpure virtual

Verifies login.

Parameters

[in]

ccp

Login data sent by client.

Return values

true	Verification succeeded; proceeds to next state.
false	Verification failed; stays in current state.

Implemented in Client.

Referenced by _HandleAuthentication().

Here is the caller graph for this function:

virtual bool EVEClientSession::_VerifyVersion ( VersionExchangeClient &  version )

protectedpure virtual

Verifies version.

Parameters

[in]

version

Version sent by client.

Return values

true	Verification succeeded; proceeds to next state.
false	Verification failed; stays in current state.

Implemented in Client.

Referenced by _HandleVersion().

Here is the caller graph for this function:

virtual bool EVEClientSession::_VerifyVIPKey ( const std::string &  vipKey )

protectedpure virtual

Verifies VIP key.

Parameters

[in]

vipKey

VIP key sent by client.

Return values

true	Verification succeeded; proceeds to next state.
false	Verification failed; stays in current state.

Implemented in Client.

Referenced by _HandleCommand().

Here is the caller graph for this function:

void EVEClientSession::CloseClientConnection ( )

inline

Disconnects client from the server.

Definition at line 93 of file EVESession.h.

References TCPConnection::Disconnect(), and mNet.

Referenced by Client::DisconnectClient(), and Client::SelectCharacter().

{ mNet->Disconnect(); }

Here is the call graph for this function:

Here is the caller graph for this function:

std::string EVEClientSession::GetAddress ( ) const

inline

Wrapper of TCPConnection::GetAddress().

Definition at line 67 of file EVESession.h.

References TCPConnection::GetAddress(), and mNet.

Referenced by _HandleAuthentication(), _HandleCommand(), _HandleCrypto(), _HandleFuncResult(), _HandlePacket(), _HandleVersion(), Client::_VerifyLogin(), PopPacket(), and QueuePacket().

{ return mNet->GetAddress(); }

Here is the call graph for this function:

Here is the caller graph for this function:

state_t EVEClientSession::GetState ( ) const

inline

Wrapper of TCPConnection::GetState().

Definition at line 65 of file EVESession.h.

References TCPConnection::GetState(), and mNet.

Referenced by Client::ProcessNet(), and Reset().

{ return mNet->GetState(); }

Here is the call graph for this function:

Here is the caller graph for this function:

PyPacket * EVEClientSession::PopPacket

(

)

Pops new packet from queue.

Returns

Popped packet.

Definition at line 80 of file EVESession.cpp.

References _log, GetAddress(), is_log_enabled, mNet, mPacketHandler, and EVETCPConnection::PopRep().

Referenced by _HandleAuthentication(), _HandleCommand(), _HandleCrypto(), _HandleFuncResult(), _HandlePacket(), _HandleVersion(), and Client::ProcessNet().

                                      {
    PyRep* rep(mNet->PopRep());
    if (rep == nullptr)
        return nullptr;

    if (is_log_enabled(NET__PRES_REP)) {
        _log(NET__PRES_REP, "%s: Raw Rep Dump:", GetAddress().c_str());
        rep->Dump(NET__PRES_REP, "    ");
    }

    assert( mPacketHandler );
    return ( this->*mPacketHandler )( rep );
}

Here is the call graph for this function:

Here is the caller graph for this function:

void EVEClientSession::QueuePacket

(

PyPacket *

packet

)

Queues new packet, retaking ownership.

Parameters

[in]

p

Packed to be queued.

Definition at line 66 of file EVESession.cpp.

References PyPacket::Encode(), GetAddress(), mNet, EVETCPConnection::QueueRep(), and sLog.

Referenced by Client::_SendCallReturn(), Client::_SendException(), Client::_SendPingRequest(), Client::_SendPingResponse(), Client::SendInitialSessionStatus(), Client::SendNotification(), and Client::SendSessionChange().

                                                     {
    if (packet == nullptr)
        return;

    PyRep* res(packet->Encode());

    if (res == nullptr) {
        sLog.Error("QueuePacket", "%s: Failed to encode a packet.", GetAddress().c_str());
        return;
    }

    mNet->QueueRep( res );
}

Here is the call graph for this function:

Here is the caller graph for this function:

void EVEClientSession::Reset

(

)

Resets session.

Reset session so we act like client just connected.

Definition at line 50 of file EVESession.cpp.

References _GetVersion(), _HandleVersion(), GetState(), mNet, mPacketHandler, EVETCPConnection::QueueRep(), and TCPConnection::STATE_CONNECTED.

Referenced by _HandleCommand(), and Client::Client().

                             {
    mPacketHandler = nullptr;

    if ( GetState() != TCPConnection::STATE_CONNECTED )
        // Connection has been lost, there's no point in reset
        return;

    VersionExchangeServer version;
    _GetVersion( version );

    PyRep* res(version.Encode());
    mNet->QueueRep(res);

    mPacketHandler = &EVEClientSession::_HandleVersion;
}

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

EVETCPConnection* const EVEClientSession::mNet

protected

Connection of this session.

Definition at line 155 of file EVESession.h.

Referenced by _HandleCommand(), Client::_LoginFail(), Client::_VerifyCrypto(), Client::_VerifyFuncResult(), Client::_VerifyLogin(), CloseClientConnection(), GetAddress(), GetState(), PopPacket(), QueuePacket(), Reset(), and ~EVEClientSession().

PyPacket*( EVEClientSession::* EVEClientSession::mPacketHandler)(PyRep *rep)

private

Definition at line 159 of file EVESession.h.

Referenced by _HandleAuthentication(), _HandleCommand(), _HandleCrypto(), _HandleFuncResult(), _HandleVersion(), PopPacket(), and Reset().

---

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

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