ObjCacheService Class Reference

#include "ObjCacheService.h"

Inheritance diagram for ObjCacheService:

Collaboration diagram for ObjCacheService:

Public Types
enum	hintSet { hLoginCachables, hCharCreateCachables, hCharCreateNewExtraCachables, hAppearanceCachables }

Public Member Functions
	ObjCacheService (PyServiceMgr *mgr, const char *cacheDir)
virtual	~ObjCacheService ()
void	PrimeCache ()
void	InsertCacheHints (hintSet hset, PyDict *into)
PyRep *	GetCacheHint (const PyRep *objectID)
PySubStream *	LoadCachedFile (const char *filename, const char *oname)
bool	IsCacheLoaded (const PyRep *objectID) const
bool	IsCacheLoaded (const ObjectCachedMethodID &m) const
bool	IsCacheLoaded (const ObjectCachedSessionMethodID &m) const
void	InvalidateCache (const PyRep *objectID)
void	InvalidateCache (const ObjectCachedMethodID &m)
void	GiveCache (const PyRep *objectID, PyRep **contents)
void	GiveCache (const ObjectCachedMethodID &m, PyRep **contents)
void	GiveCache (const ObjectCachedSessionMethodID &m, PyRep **contents)
PyObject *	MakeObjectCachedMethodCallResult (const PyRep *objectID, const char *versionCheck="run")
PyObject *	MakeObjectCachedMethodCallResult (const ObjectCachedMethodID &m, const char *versionCheck="run")
PyObject *	MakeObjectCachedSessionMethodCallResult (const PyRep *objectID, const char *sessionInfoName, const char *clientWhen="always")
PyObject *	MakeObjectCachedSessionMethodCallResult (const ObjectCachedSessionMethodID &m, const char *sessionInfoName, const char *clientWhen="always")
Public Member Functions inherited from PyService
	PyService (PyServiceMgr *mgr, const char *serviceName)
virtual	~PyService ()
virtual PyResult	Call (const std::string &method, PyCallArgs &args)
const char *	GetName () const
Public Member Functions inherited from PyCallable
	PyCallable ()
virtual	~PyCallable ()

Protected Types
typedef std::map< std::string, std::string >	CacheKeysMap
typedef CacheKeysMap::iterator	CacheKeysMapItr
typedef CacheKeysMap::const_iterator	CacheKeysMapConstItr
Protected Types inherited from PyService
enum	CacheCheckTime {   check_Always = 0, check_Never, check_in_year, check_in_6_months,   check_in_3_months, check_in_1_month, check_in_1_week, check_in_1_day,   check_in_12_hours, check_in_6_hours, check_in_3_hours, check_in_2_hours,   check_in_1_hour, check_in_30_minutes, check_in_15_minutes, check_in_5_minutes,   check_in_1_minute, check_in_30_seconds, check_in_15_seconds, check_in_5_seconds,   check_in_1_second, _checkCount }

Protected Member Functions
bool	_LoadCachableObject (const PyRep *objectID)
Protected Member Functions inherited from PyService
PyObject *	_BuildCachedReturn (PySubStream **result, const char *sessionInfo, CacheCheckTime check)
virtual PyBoundObject *	CreateBoundObject (Client *pClient, const PyRep *bind_args)
virtual PyResult	Handle_MachoResolveObject (PyCallArgs &call)
virtual PyResult	Handle_MachoBindObject (PyCallArgs &call)
Protected Member Functions inherited from PyCallable
void	_SetCallDispatcher (CallDispatcher *d)

Protected Attributes
Dispatcher *const	m_dispatch
ObjCacheDB	m_db
std::string	m_cacheDir
CachedObjectMgr	m_cache
CacheKeysMap	m_cacheKeys
Protected Attributes inherited from PyService
PyServiceMgr *const	m_manager

Static Protected Attributes
static const char *const	LoginCachableObjects []
static const uint32	LoginCachableObjectCount = sizeof(ObjCacheService::LoginCachableObjects) / sizeof(const char *)
static const char *const	CharCreateCachableObjects []
static const uint32	CharCreateCachableObjectCount = sizeof(ObjCacheService::CharCreateCachableObjects) / sizeof(const char *)
static const char *const	AppearanceCachableObjects []
static const uint32	AppearanceCachableObjectCount = sizeof(ObjCacheService::AppearanceCachableObjects) / sizeof(const char *)
static const char *const	CharCreateNewExtraCachableObjects []
static const uint32	CharCreateNewExtraCachableObjectCount = sizeof(ObjCacheService::CharCreateNewExtraCachableObjects) / sizeof(const char *)
Static Protected Attributes inherited from PyService
static const char *const	s_checkTimeStrings [_checkCount]

Detailed Description

Definition at line 51 of file ObjCacheService.h.

Member Typedef Documentation

typedef std::map<std::string, std::string> ObjCacheService::CacheKeysMap

protected

Definition at line 110 of file ObjCacheService.h.

typedef CacheKeysMap::const_iterator ObjCacheService::CacheKeysMapConstItr

protected

Definition at line 112 of file ObjCacheService.h.

typedef CacheKeysMap::iterator ObjCacheService::CacheKeysMapItr

protected

Definition at line 111 of file ObjCacheService.h.

Member Enumeration Documentation

enum ObjCacheService::hintSet

Enumerator
hLoginCachables
hCharCreateCachables
hCharCreateNewExtraCachables
hAppearanceCachables

Definition at line 59 of file ObjCacheService.h.

                 {
        hLoginCachables,
        hCharCreateCachables,
        hCharCreateNewExtraCachables,
        hAppearanceCachables
    } hintSet;

Constructor & Destructor Documentation

ObjCacheService::ObjCacheService	(	PyServiceMgr *	mgr,
		const char *	cacheDir
	)

ObjCacheService::~ObjCacheService ( )

virtual

Definition at line 252 of file ObjCacheService.cpp.

References m_dispatch.

                                  {
    delete m_dispatch;
}

Member Function Documentation

bool ObjCacheService::_LoadCachableObject ( const PyRep *  objectID )

protected

Definition at line 316 of file ObjCacheService.cpp.

References _log, ObjCacheDB::GetCachableObject(), CachedObjectMgr::HaveCached(), CachedObjectMgr::LoadCachedFile(), CachedObjectMgr::LoadCachedFromFile(), m_cache, m_cacheDir, m_db, CachedObjectMgr::OIDToString(), CachedObjectMgr::SaveCachedToFile(), sLog, CachedObjectMgr::UpdateCache(), and CachedObjectMgr::UpdateCacheFromSS().

Referenced by GetCacheHint(), and PrimeCache().

                                                               {
    if(m_cache.HaveCached(objectID))
        return true;

    const std::string objectID_string = CachedObjectMgr::OIDToString(objectID);

    if(!m_cacheDir.empty())
    {
        if( m_cache.LoadCachedFromFile( m_cacheDir, objectID ) )
        {
            _log( CACHE__INFO, "Loaded cached object '%s' from file.", objectID_string.c_str() );
            return true;
        }
    }

    //first try to generate it from the database...
    //we go to the DB with a string, not a rep
    PyRep *cache = m_db.GetCachableObject(objectID_string);
    if(cache != nullptr) {
        //we have generated the cache file in question, remember it
        m_cache.UpdateCache(objectID, &cache);
    } else {
        //failed to query from the database... fall back to old
        //hackish file loading.
        PySubStream* ss = m_cache.LoadCachedFile( objectID_string.c_str() );
        if( ss == nullptr )
        {
            _log(CACHE__ERROR, "Failed to create or load cache file for '%s'", objectID_string.c_str());
            return false;
        }

        //we have generated the cache file in question, remember it
        m_cache.UpdateCacheFromSS(objectID_string, &ss);
    }

    //if we have a cache dir, write out the cache entry:
    if(!m_cacheDir.empty())
    {
        if(!m_cache.SaveCachedToFile(m_cacheDir, objectID)) {
            sLog.Error( "ObjCacheService", "Failed to save cache file for '%s' in '%s'", objectID_string.c_str(), m_cacheDir.c_str() );
        } else {
            sLog.White( "ObjCacheService", "Saved cached object '%s' to file in '%s'.", objectID_string.c_str(), m_cacheDir.c_str() );
        }
    }

    return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

PyRep * ObjCacheService::GetCacheHint

(

const PyRep *

objectID

)

Definition at line 364 of file ObjCacheService.cpp.

References _LoadCachableObject(), _log, m_cache, CachedObjectMgr::MakeCacheHint(), and CachedObjectMgr::OIDToString().

Referenced by InsertCacheHints().

                                                          {
    if (!_LoadCachableObject(objectID))
        return nullptr;    //print done already

    PyObject *cache_hint = m_cache.MakeCacheHint(objectID);
    if (cache_hint == nullptr) {
        _log(CACHE__ERROR, "Unable to build cache hint for object ID '%s' (h), skipping.", CachedObjectMgr::OIDToString(objectID).c_str());
        return nullptr;
    }

    return cache_hint;
}

Here is the call graph for this function:

Here is the caller graph for this function:

void ObjCacheService::GiveCache	(	const PyRep *	objectID,
		PyRep **	contents
	)

Definition at line 430 of file ObjCacheService.cpp.

References m_cache, and CachedObjectMgr::UpdateCache().

Referenced by MarketMgr::GetNewPriceHistory(), MarketMgr::GetOldPriceHistory(), and PyServiceMgr::Initalize().

                                                                       {
    //contents is consumed.
    m_cache.UpdateCache(objectID, contents);
}

Here is the call graph for this function:

Here is the caller graph for this function:

void ObjCacheService::GiveCache ( const ObjectCachedMethodID &  m, PyRep **  contents  )

inline

Definition at line 80 of file ObjCacheService.h.

References GiveCache(), and ObjectCachedMethodID::objectID.

Referenced by GiveCache().

{ GiveCache(m.objectID, contents); }

Here is the call graph for this function:

Here is the caller graph for this function:

void ObjCacheService::GiveCache ( const ObjectCachedSessionMethodID &  m, PyRep **  contents  )

inline

Definition at line 81 of file ObjCacheService.h.

References GiveCache(), and ObjectCachedSessionMethodID::objectID.

Referenced by GiveCache().

{ GiveCache(m.objectID, contents); }

Here is the call graph for this function:

Here is the caller graph for this function:

void ObjCacheService::InsertCacheHints	(	hintSet	hset,
		PyDict *	into
	)

Definition at line 377 of file ObjCacheService.cpp.

References _log, AppearanceCachableObjectCount, AppearanceCachableObjects, CharCreateCachableObjectCount, CharCreateCachableObjects, CharCreateNewExtraCachableObjectCount, CharCreateNewExtraCachableObjects, GetCacheHint(), hAppearanceCachables, hCharCreateCachables, hCharCreateNewExtraCachables, hLoginCachables, LoginCachableObjectCount, LoginCachableObjects, m_cacheKeys, objects(), PyDecRef, and PyDict::SetItemString().

                                                                 {
    const char *const *objects = nullptr;
    uint32 object_count = 0;
    switch(hset) {
    case hLoginCachables:
        objects = LoginCachableObjects;
        object_count = LoginCachableObjectCount;
        break;
    case hCharCreateCachables:
        objects = CharCreateCachableObjects;
        object_count = CharCreateCachableObjectCount;
        break;
    case hAppearanceCachables:
        objects = AppearanceCachableObjects;
        object_count = AppearanceCachableObjectCount;
        break;
    case hCharCreateNewExtraCachables:
        objects = CharCreateNewExtraCachableObjects;
        object_count = CharCreateNewExtraCachableObjectCount;
        break;
    }
    if(objects == nullptr)
        return;
    uint32 r;
    std::map<std::string, std::string>::const_iterator res;
    for(r = 0; r < object_count; r++) {
        //find the dict key to use for this object
        res = m_cacheKeys.find(objects[r]);
        if(res == m_cacheKeys.end()) {
            _log(CACHE__ERROR, "Unable to find cache key for object ID '%s', skipping.", objects[r]);
            continue;
        }

        //get the hint
        PyString* str = new PyString( objects[r] );
        PyRep *cache_hint = GetCacheHint( str );
        PyDecRef( str );

        if(cache_hint == nullptr)
            continue;    //print already done.

        into->SetItemString(res->second.c_str(), cache_hint);
    }
}

Here is the call graph for this function:

void ObjCacheService::InvalidateCache

(

const PyRep *

objectID

)

Definition at line 426 of file ObjCacheService.cpp.

References CachedObjectMgr::InvalidateCache(), and m_cache.

Referenced by MarketMgr::InvalidateOrdersCache().

                                                           {
    m_cache.InvalidateCache(objectID);
}

Here is the call graph for this function:

Here is the caller graph for this function:

void ObjCacheService::InvalidateCache ( const ObjectCachedMethodID &  m )

inline

Definition at line 77 of file ObjCacheService.h.

References InvalidateCache(), and ObjectCachedMethodID::objectID.

Referenced by InvalidateCache().

{ InvalidateCache(m.objectID); }

Here is the call graph for this function:

Here is the caller graph for this function:

bool ObjCacheService::IsCacheLoaded

(

const PyRep *

objectID

)

const

Definition at line 422 of file ObjCacheService.cpp.

References CachedObjectMgr::HaveCached(), and m_cache.

Referenced by MarketMgr::GetNewPriceHistory(), MarketMgr::GetOldPriceHistory(), PyServiceMgr::Initalize(), MakeObjectCachedMethodCallResult(), and MakeObjectCachedSessionMethodCallResult().

                                                               {
    return(m_cache.HaveCached(objectID));
}

Here is the call graph for this function:

Here is the caller graph for this function:

bool ObjCacheService::IsCacheLoaded ( const ObjectCachedMethodID &  m ) const

inline

Definition at line 73 of file ObjCacheService.h.

References IsCacheLoaded(), and ObjectCachedMethodID::objectID.

Referenced by IsCacheLoaded().

{ return(IsCacheLoaded(m.objectID)); }

Here is the call graph for this function:

Here is the caller graph for this function:

bool ObjCacheService::IsCacheLoaded ( const ObjectCachedSessionMethodID &  m ) const

inline

Definition at line 74 of file ObjCacheService.h.

References IsCacheLoaded(), and ObjectCachedSessionMethodID::objectID.

Referenced by IsCacheLoaded().

{ return(IsCacheLoaded(m.objectID)); }

Here is the call graph for this function:

Here is the caller graph for this function:

PySubStream * ObjCacheService::LoadCachedFile	(	const char *	filename,
		const char *	oname
	)

Definition at line 309 of file ObjCacheService.cpp.

References CachedObjectMgr::LoadCachedFile(), and m_cache.

{
    //temp hack...
    return m_cache.LoadCachedFile( filename, oname );
}

Here is the call graph for this function:

PyObject * ObjCacheService::MakeObjectCachedMethodCallResult	(	const PyRep *	objectID,
		const char *	versionCheck = "run"
	)

Definition at line 446 of file ObjCacheService.cpp.

References IsCacheLoaded(), m_cache, and CachedObjectMgr::MakeCacheHint().

Referenced by MarketMgr::GetNewPriceHistory(), and MarketMgr::GetOldPriceHistory().

                                                                                                           {
    if(!IsCacheLoaded(objectID))
        return nullptr;

    objectCaching_CachedMethodCallResult_object c;
    c.versionCheck = versionCheck;
    c.object = m_cache.MakeCacheHint(objectID);
    return c.Encode();
}

Here is the call graph for this function:

Here is the caller graph for this function:

PyObject* ObjCacheService::MakeObjectCachedMethodCallResult ( const ObjectCachedMethodID &  m, const char *  versionCheck = "run"  )

inline

Definition at line 84 of file ObjCacheService.h.

References MakeObjectCachedMethodCallResult(), and ObjectCachedMethodID::objectID.

Referenced by MakeObjectCachedMethodCallResult().

{ return(MakeObjectCachedMethodCallResult(m.objectID, versionCheck)); }

Here is the call graph for this function:

Here is the caller graph for this function:

PyObject * ObjCacheService::MakeObjectCachedSessionMethodCallResult	(	const PyRep *	objectID,
		const char *	sessionInfoName,
		const char *	clientWhen = "always"
	)

Definition at line 435 of file ObjCacheService.cpp.

References IsCacheLoaded(), m_cache, and CachedObjectMgr::MakeCacheHint().

                                                                                                                                             {
    if(!IsCacheLoaded(objectID))
        return nullptr;

    objectCaching_SessionCachedMethodCallResult_object c;
    c.clientWhen = clientWhen;
    c.sessionInfoName = sessionInfoName;
    c.object = m_cache.MakeCacheHint(objectID);
    return c.Encode();
}

Here is the call graph for this function:

PyObject* ObjCacheService::MakeObjectCachedSessionMethodCallResult ( const ObjectCachedSessionMethodID &  m, const char *  sessionInfoName, const char *  clientWhen = "always"  )

inline

Definition at line 87 of file ObjCacheService.h.

References MakeObjectCachedSessionMethodCallResult(), and ObjectCachedSessionMethodID::objectID.

Referenced by MakeObjectCachedSessionMethodCallResult().

{ return(MakeObjectCachedSessionMethodCallResult(m.objectID, sessionInfoName, clientWhen)); }

Here is the call graph for this function:

Here is the caller graph for this function:

void ObjCacheService::PrimeCache

(

)

Definition at line 298 of file ObjCacheService.cpp.

References _LoadCachableObject(), m_cacheKeys, and PyDecRef.

{
    CacheKeysMapConstItr cur = m_cacheKeys.begin();
    for(; cur != m_cacheKeys.end(); cur++)
    {
        PyString* str = new PyString( cur->first );
        _LoadCachableObject( str );
        PyDecRef( str );
    }
}

Here is the call graph for this function:

Member Data Documentation

const uint32 ObjCacheService::AppearanceCachableObjectCount = sizeof(ObjCacheService::AppearanceCachableObjects) / sizeof(const char *)

staticprotected

Definition at line 96 of file ObjCacheService.h.

Referenced by InsertCacheHints().

const char *const ObjCacheService::AppearanceCachableObjects

staticprotected

Initial value:

= {
    "charCreationInfo.eyebrows",
    "charCreationInfo.eyes",
    "charCreationInfo.decos",
    "charCreationInfo.hairs",
    "charCreationInfo.backgrounds",
    "charCreationInfo.accessories",
    "charCreationInfo.costumes",
    "charCreationInfo.lights",
    "charCreationInfo.makeups",
    "charCreationInfo.beards",
    "charCreationInfo.skins",
    "charCreationInfo.lipsticks"
}

Definition at line 95 of file ObjCacheService.h.

Referenced by InsertCacheHints().

const uint32 ObjCacheService::CharCreateCachableObjectCount = sizeof(ObjCacheService::CharCreateCachableObjects) / sizeof(const char *)

staticprotected

Definition at line 94 of file ObjCacheService.h.

Referenced by InsertCacheHints().

const char *const ObjCacheService::CharCreateCachableObjects

staticprotected

Initial value:

= {
    "charCreationInfo.bl_eyebrows",
    "charCreationInfo.bl_eyes",
    "charCreationInfo.bl_decos",
    "charCreationInfo.bloodlines",
    "charCreationInfo.bl_hairs",
    "charCreationInfo.bl_backgrounds",
    "charCreationInfo.bl_accessories",
    "charCreationInfo.bl_costumes",
    "charCreationInfo.bl_lights",
    "charCreationInfo.races",
    "charCreationInfo.ancestries",
    "charCreationInfo.schools",
    "charCreationInfo.attributes",
    "charCreationInfo.bl_beards",
    "charCreationInfo.bl_skins",
    "charCreationInfo.bl_lipsticks",
    "charCreationInfo.bl_makeups"
}

Definition at line 93 of file ObjCacheService.h.

Referenced by InsertCacheHints().

const uint32 ObjCacheService::CharCreateNewExtraCachableObjectCount = sizeof(ObjCacheService::CharCreateNewExtraCachableObjects) / sizeof(const char *)

staticprotected

Definition at line 98 of file ObjCacheService.h.

Referenced by InsertCacheHints().

const char *const ObjCacheService::CharCreateNewExtraCachableObjects

staticprotected

Initial value:

= {
    "charNewExtraCreationInfo.raceskills",
    "charNewExtraCreationInfo.careerskills",
    "charNewExtraCreationInfo.careers",
    "charNewExtraCreationInfo.specialityskills",
    "charNewExtraCreationInfo.specialities"
}

Definition at line 97 of file ObjCacheService.h.

Referenced by InsertCacheHints().

const uint32 ObjCacheService::LoginCachableObjectCount = sizeof(ObjCacheService::LoginCachableObjects) / sizeof(const char *)

staticprotected

Definition at line 92 of file ObjCacheService.h.

Referenced by InsertCacheHints().

const char *const ObjCacheService::LoginCachableObjects

staticprotected

Todo:

this needs to be fixed. is currently unused, but intended to be a BulkData data service. the "config*" and "char*" files are intended to be sent in BulkData the rest of this file isnt fully understood (by me) or implemented.

Definition at line 91 of file ObjCacheService.h.

Referenced by InsertCacheHints().

CachedObjectMgr ObjCacheService::m_cache

protected

Definition at line 106 of file ObjCacheService.h.

Referenced by _LoadCachableObject(), GetCacheHint(), GiveCache(), InvalidateCache(), IsCacheLoaded(), LoadCachedFile(), MakeObjectCachedMethodCallResult(), and MakeObjectCachedSessionMethodCallResult().

std::string ObjCacheService::m_cacheDir

protected

Definition at line 105 of file ObjCacheService.h.

Referenced by _LoadCachableObject().

CacheKeysMap ObjCacheService::m_cacheKeys

protected

Definition at line 114 of file ObjCacheService.h.

Referenced by InsertCacheHints(), and PrimeCache().

ObjCacheDB ObjCacheService::m_db

protected

Definition at line 103 of file ObjCacheService.h.

Referenced by _LoadCachableObject().

Dispatcher* const ObjCacheService::m_dispatch

protected

Definition at line 100 of file ObjCacheService.h.

Referenced by ~ObjCacheService().

---

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

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