CrystalSpace

Public API Reference

csVfsCacheManager Class Reference

This is a general cache that can cache data on VFS. More...

#include <csutil/vfscache.h>

Inherits scfImplementation1< csVfsCacheManager, iCacheManager >.

List of all members.

Public Member Functions

virtual bool CacheData (const void *data, size_t size, const char *type, const char *scope, uint32 id)
 Cache some data.
virtual bool ClearCache (const char *type=0, const char *scope=0, const uint32 *id=0)
 Clear items from the cache.
 csVfsCacheManager (iObjectRegistry *object_reg, const char *vfsdir)
 Construct the cache manager with the given directory.
virtual void Flush ()
 Flush VFS.
virtual const char * GetCurrentScope () const
 Get current scope or 0 if none set.
virtual const char * GetCurrentType () const
 Get current type or 0 if none set.
virtual csPtr< iDataBufferReadCache (const char *type, const char *scope, uint32 id)
 Retrieve some data from the cache.
virtual void SetCurrentScope (const char *scope)
 Set current scope.
virtual void SetCurrentType (const char *type)
 Set current type.

Detailed Description

This is a general cache that can cache data on VFS.

Definition at line 36 of file vfscache.h.


Constructor & Destructor Documentation

csVfsCacheManager::csVfsCacheManager ( iObjectRegistry object_reg,
const char *  vfsdir 
)

Construct the cache manager with the given directory.

All cached data will be put somewhere in that directory.


Member Function Documentation

virtual bool csVfsCacheManager::CacheData ( const void *  data,
size_t  size,
const char *  type,
const char *  scope,
uint32  id 
) [virtual]

Cache some data.

Returns true if this succeeded.

virtual bool csVfsCacheManager::ClearCache ( const char *  type = 0,
const char *  scope = 0,
const uint32 id = 0 
) [virtual]

Clear items from the cache.

virtual void csVfsCacheManager::Flush (  )  [virtual]

Flush VFS.

virtual const char* csVfsCacheManager::GetCurrentScope (  )  const [inline, virtual]

Get current scope or 0 if none set.

Definition at line 80 of file vfscache.h.

virtual const char* csVfsCacheManager::GetCurrentType (  )  const [inline, virtual]

Get current type or 0 if none set.

Definition at line 72 of file vfscache.h.

virtual csPtr<iDataBuffer> csVfsCacheManager::ReadCache ( const char *  type,
const char *  scope,
uint32  id 
) [virtual]

Retrieve some data from the cache.

Returns 0 if the data could not be found in the cache.

virtual void csVfsCacheManager::SetCurrentScope ( const char *  scope  )  [virtual]

Set current scope.

virtual void csVfsCacheManager::SetCurrentType ( const char *  type  )  [virtual]

Set current type.


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

Generated for Crystal Space 1.4.1 by doxygen 1.7.1