Planeshift
CacheManager::psCacheExpireEvent Class Reference

The generic cache sets timers for each object added to the cache, then if the object is not removed by the expiration time, it calls the iCachedObject interface and deletes the object. More...

#include <cachemanager.h>

Public Member Functions

void CancelEvent ()
 
 psCacheExpireEvent (int delayticks, CachedObject *object)
 
virtual void Trigger ()
 Abstract event processing function. More...
 
- Public Member Functions inherited from psGameEvent
virtual bool CheckTrigger ()
 Called right before a Trigger is called. More...
 
const char * GetType ()
 Return the type that this event where created with. More...
 
virtual bool IsValid ()
 Return the valid flag. More...
 
bool operator< (const psGameEvent &other) const
 
bool operator== (const psGameEvent &other) const
 
bool operator> (const psGameEvent &other) const
 
 psGameEvent (csTicks ticks, int offsetticks, const char *newType)
 Construct a new game event. More...
 
void QueueEvent ()
 Publish the game event to the local program. More...
 
virtual void SetValid (bool valid)
 Set the valid flag. More...
 
virtual csString ToString () const
 Return a string with information about the event. More...
 
virtual ~psGameEvent ()
 

Protected Attributes

CachedObjectmyObject
 
bool valid
 

Additional Inherited Members

- Public Attributes inherited from psGameEvent
csTicks delayticks
 delay before the event starts More...
 
int id
 id value combined with ticks ensures uniqueness for tree More...
 
csTicks triggerticks
 ticks value when event should be triggered. More...
 
bool valid
 Set this to false if the trigger should not be fired. More...
 
- Static Public Attributes inherited from psGameEvent
static EventManagereventmanager
 
static int nextid
 id counter sequence More...
 

Detailed Description

The generic cache sets timers for each object added to the cache, then if the object is not removed by the expiration time, it calls the iCachedObject interface and deletes the object.

Definition at line 871 of file cachemanager.h.

Constructor & Destructor Documentation

CacheManager::psCacheExpireEvent::psCacheExpireEvent ( int  delayticks,
CachedObject object 
)

Member Function Documentation

void CacheManager::psCacheExpireEvent::CancelEvent ( )
inline

Definition at line 879 of file cachemanager.h.

virtual void CacheManager::psCacheExpireEvent::Trigger ( )
virtual

Abstract event processing function.

Implements psGameEvent.

Member Data Documentation

CachedObject* CacheManager::psCacheExpireEvent::myObject
protected

Definition at line 875 of file cachemanager.h.

bool CacheManager::psCacheExpireEvent::valid
protected

Definition at line 874 of file cachemanager.h.


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