ClientSession Class Reference

Value keeper for single EVE session. More...

#include "ClientSession.h"

Collaboration diagram for ClientSession:

Public Member Functions
	ClientSession ()
	~ClientSession ()
bool	isDirty () const
void	SetInt (const char *name, int32 value)
int32	GetLastInt (const char *name) const
int32	GetCurrentInt (const char *name) const
void	SetLong (const char *name, int64 value)
int64	GetLastLong (const char *name) const
int64	GetCurrentLong (const char *name) const
void	SetString (const char *name, const char *value)
std::string	GetLastString (const char *name) const
std::string	GetCurrentString (const char *name) const
void	Clear (const char *name)
void	EncodeChanges (PyDict *into)
void	EncodeInitialState (PyDict *into)
int64	GetSessionID ()

Protected Member Functions
PyRep *	_GetLast (const char *name) const
PyRep *	_GetCurrent (const char *name) const
PyTuple *	_GetValueTuple (const char *name) const
void	_Set (const char *name, PyRep *value)

Protected Attributes
PyDict *const	mSession

Private Attributes
bool	mDirty
int64	m_sessionID

Detailed Description

Value keeper for single EVE session.

This object keeps track of string-value pairs and encodes their changes as session changes.

Definition at line 37 of file ClientSession.h.

Constructor & Destructor Documentation

ClientSession::ClientSession

(

)

Definition at line 46 of file ClientSession.cpp.

References GetTimeUSeconds(), m_sessionID, mSession, new_tuple(), Acct::Role::NEWBIE, Acct::Role::PLAYER, PyStatic, sEntityList, and PyDict::SetItemString().

: mSession(new PyDict()),
mDirty(false),
m_sessionID(0)
{
    /* default session values */
    mSession->SetItemString("role", new_tuple(PyStatic.NewNone(), new PyLong(Acct::Role::PLAYER | Acct::Role::NEWBIE), PyStatic.NewFalse()));
    mSession->SetItemString("userid", new_tuple(PyStatic.NewNone(), PyStatic.NewZero(), PyStatic.NewFalse()));
    mSession->SetItemString("address", new_tuple(PyStatic.NewNone(), new PyString("0.0.0.0"), PyStatic.NewFalse()));

    /*  session id is unique to each session.
     * is not saved or shared between chars
     */
    //random.getrandbits(63)
    m_sessionID = GetTimeUSeconds() *15;
    sEntityList.RegisterSID(m_sessionID);
}

Here is the call graph for this function:

ClientSession::~ClientSession

(

)

Definition at line 64 of file ClientSession.cpp.

References m_sessionID, mSession, PyDecRef, and sEntityList.

{
    // do we clear session vars here, or let ~PyDict() do it?
    PyDecRef(mSession);
    sEntityList.RemoveSID(m_sessionID);
}

Member Function Documentation

PyRep * ClientSession::_GetCurrent ( const char *  name ) const

protected

Definition at line 180 of file ClientSession.cpp.

References _GetValueTuple(), _log, PyTuple::GetItem(), is_log_enabled, and EvE::traceStack().

Referenced by GetCurrentInt(), GetCurrentLong(), and GetCurrentString().

{
    PyTuple* tuple(_GetValueTuple(name)); // copy c'tor
    if (tuple == nullptr) {
        if (is_log_enabled(CLIENT__SESSION_NOTFOUND)) {
            _log(CLIENT__SESSION_NOTFOUND, "ClientSession::_GetCurrent - value not found with name '%s'", name);
            EvE::traceStack();
        }
        return nullptr;
    }
    return tuple->GetItem(1);
}

Here is the call graph for this function:

Here is the caller graph for this function:

PyRep * ClientSession::_GetLast ( const char *  name ) const

protected

Definition at line 170 of file ClientSession.cpp.

References _GetValueTuple(), _log, and PyTuple::GetItem().

Referenced by GetLastInt(), GetLastLong(), and GetLastString().

{
    PyTuple* tuple(_GetValueTuple(name)); // copy c'tor
    if (tuple == nullptr) {
        _log(CLIENT__SESSION_NOTFOUND, "ClientSession::_GetLast - value not found with name '%s'", name);
        return nullptr;
    }
    return tuple->GetItem(0);
}

Here is the call graph for this function:

Here is the caller graph for this function:

PyTuple * ClientSession::_GetValueTuple ( const char *  name ) const

protected

Definition at line 162 of file ClientSession.cpp.

References PyRep::AsTuple(), PyDict::GetItemString(), and mSession.

Referenced by _GetCurrent(), _GetLast(), and _Set().

{
    PyRep* value(mSession->GetItemString(name));
    if (value == nullptr)
        return nullptr;
    return value->AsTuple();
}

Here is the call graph for this function:

Here is the caller graph for this function:

void ClientSession::_Set ( const char *  name, PyRep *  value  )

protected

Definition at line 193 of file ClientSession.cpp.

References _GetValueTuple(), PyTuple::GetItem(), PyRep::hash(), mDirty, mSession, new_tuple(), PyDecRef, PyStatic, PyTuple::SetItem(), and PyDict::SetItemString().

Referenced by Clear(), SetInt(), SetLong(), and SetString().

{
    PyTuple* tuple(_GetValueTuple(name)); // copy c'tor
    if (tuple == nullptr) {
        tuple = new_tuple(PyStatic.NewNone(), PyStatic.NewNone(), PyStatic.NewFalse());
        mSession->SetItemString(name, tuple);
    }

    PyRep* current(tuple->GetItem(1)); // copy c'tor
    if (value->hash() != current->hash()) {
        tuple->SetItem(0, current); /* didn't the session need to store the old value too? */
        tuple->SetItem(1, value);
        tuple->SetItem(2, PyStatic.NewTrue());
        mDirty = true;
    } else {
        PyDecRef(value);
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

void ClientSession::Clear

(

const char *

name

)

Definition at line 72 of file ClientSession.cpp.

References _Set(), and PyStatic.

Referenced by Client::InitSession(), and Client::UpdateSession().

{
    _Set(name, PyStatic.NewNone());
}

Here is the call graph for this function:

Here is the caller graph for this function:

void ClientSession::EncodeChanges

(

PyDict *

into

)

Buils a PyDictionary with the list of changes the session has gone through Every item is a tuple that includes the old and new value so the client can compare against what it has

Parameters

into

Definition at line 122 of file ClientSession.cpp.

References PyRep::AsBool(), PyRep::AsTuple(), PyTuple::GetItem(), mDirty, mSession, new_tuple(), PyStatic, PyTuple::SetItem(), PyDict::SetItem(), and PyBool::value().

Referenced by Client::SendSessionChange().

{
    if (!mDirty)
        return;

    for (auto cur : *mSession)
    {
        PyTuple* valueTuple = cur.second->AsTuple ();

        if (valueTuple->GetItem (2)->AsBool ()->value () == false)
            continue;

        // mark the value as not new
        valueTuple->SetItem (2, PyStatic.NewFalse());

        // add the value to the list if it should be persisted
        if (NONPERSISTVARS.find (cur.first->AsString ()->content ()) == NONPERSISTVARS.end ())
            into->SetItem (cur.first, new_tuple (valueTuple->GetItem (0), valueTuple->GetItem(1)));
    }

    mDirty = false;
}

Here is the call graph for this function:

Here is the caller graph for this function:

void ClientSession::EncodeInitialState

(

PyDict *

into

)

Builds a PyDictionary with the current state of the session. Useful for macho.SessionInitialStateNotification The side-effects include overwriting of the old value on the session data with the new one

Parameters

into

Definition at line 145 of file ClientSession.cpp.

References PyRep::AsTuple(), mDirty, mSession, PyStatic, PyTuple::SetItem(), and PyDict::SetItem().

Referenced by Client::SendInitialSessionStatus().

{
    for (auto cur : *mSession)
    {
        PyTuple* valueTuple = cur.second->AsTuple ();

        valueTuple->SetItem(2, PyStatic.NewFalse());

        // add the value to the initial state only if required
        if (NONPERSISTVARS.find (cur.first->AsString ()->content ()) == NONPERSISTVARS.end ())
            into->SetItem (cur.first, cur.second->AsTuple ()->GetItem (1));
    }

    // mark the session as not dirty
    mDirty = false;
}

Here is the call graph for this function:

Here is the caller graph for this function:

int32 ClientSession::GetCurrentInt

(

const char *

name

)

const

Definition at line 97 of file ClientSession.cpp.

References _GetCurrent(), and PyRep::IntegerValue().

Referenced by Client::GetAccountType(), Client::GetAllianceID(), Client::GetCharacterID(), Client::GetCloneStationID(), Client::GetCorpAccountKey(), Client::GetCorpHQ(), Client::GetCorporationID(), Client::GetFleetRole(), Client::GetStationID(), Client::GetStationID2(), Client::GetUserID(), and Client::GetWarFactionID().

{
    return PyRep::IntegerValue(_GetCurrent(name));
}

Here is the call graph for this function:

Here is the caller graph for this function:

int64 ClientSession::GetCurrentLong

(

const char *

name

)

const

Definition at line 107 of file ClientSession.cpp.

References _GetCurrent(), and PyRep::IntegerValue().

Referenced by Client::GetAccountRole(), Client::GetClientID(), Client::GetCorpRole(), Client::GetRolesAtAll(), Client::GetRolesAtBase(), Client::GetRolesAtHQ(), and Client::GetRolesAtOther().

{
    return PyRep::IntegerValue(_GetCurrent(name));
}

Here is the call graph for this function:

Here is the caller graph for this function:

std::string ClientSession::GetCurrentString

(

const char *

name

)

const

Definition at line 117 of file ClientSession.cpp.

References _GetCurrent(), and PyRep::StringContent().

Referenced by Client::GetAddress(), and Client::GetLanguageID().

{
    return PyRep::StringContent(_GetCurrent(name));
}

Here is the call graph for this function:

Here is the caller graph for this function:

int32 ClientSession::GetLastInt

(

const char *

name

)

const

Definition at line 92 of file ClientSession.cpp.

References _GetLast(), and PyRep::IntegerValue().

{
    return PyRep::IntegerValue(_GetLast(name));
}

Here is the call graph for this function:

int64 ClientSession::GetLastLong

(

const char *

name

)

const

Definition at line 102 of file ClientSession.cpp.

References _GetLast(), and PyRep::IntegerValue().

{
    return PyRep::IntegerValue(_GetLast(name));
}

Here is the call graph for this function:

std::string ClientSession::GetLastString

(

const char *

name

)

const

Definition at line 112 of file ClientSession.cpp.

References _GetLast(), and PyRep::StringContent().

{
    return PyRep::StringContent(_GetLast(name));
}

Here is the call graph for this function:

int64 ClientSession::GetSessionID ( )

inline

Definition at line 76 of file ClientSession.h.

References m_sessionID.

Referenced by Command_showsession(), and Client::SendInitialSessionStatus().

{ return m_sessionID; }

Here is the caller graph for this function:

bool ClientSession::isDirty ( ) const

inline

Definition at line 43 of file ClientSession.h.

References mDirty.

Referenced by Client::SendSessionChange().

{ return mDirty; }

Here is the caller graph for this function:

void ClientSession::SetInt	(	const char *	name,
		int32	value
	)

Definition at line 77 of file ClientSession.cpp.

References _Set().

Referenced by Client::_VerifyLogin(), Client::InitSession(), Client::SendSessionChange(), Client::SetShip(), Client::UpdateCorpSession(), Client::UpdateFleetSession(), Client::UpdateSession(), and Client::UpdateSessionInt().

{
    _Set(name, new PyInt(value));
}

Here is the call graph for this function:

Here is the caller graph for this function:

void ClientSession::SetLong	(	const char *	name,
		int64	value
	)

Definition at line 82 of file ClientSession.cpp.

References _Set().

Referenced by Client::_VerifyLogin(), Client::InitSession(), and Client::UpdateCorpSession().

{
    _Set(name, new PyLong(value));
}

Here is the call graph for this function:

Here is the caller graph for this function:

void ClientSession::SetString	(	const char *	name,
		const char *	value
	)

Definition at line 87 of file ClientSession.cpp.

References _Set().

Referenced by Client::_VerifyLogin().

{
    _Set(name, new PyString(value));
}

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

int64 ClientSession::m_sessionID

private

Definition at line 90 of file ClientSession.h.

Referenced by ClientSession(), GetSessionID(), and ~ClientSession().

bool ClientSession::mDirty

private

Definition at line 88 of file ClientSession.h.

Referenced by _Set(), EncodeChanges(), EncodeInitialState(), and isDirty().

PyDict* const ClientSession::mSession

protected

Definition at line 85 of file ClientSession.h.

Referenced by _GetValueTuple(), _Set(), ClientSession(), EncodeChanges(), EncodeInitialState(), and ~ClientSession().

---

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

• /backups/local/src/eve/EvEmu_Crucible/src/eve-server/ClientSession.h
• /backups/local/src/eve/EvEmu_Crucible/src/eve-server/ClientSession.cpp