iCacheManager Struct Reference
A generic cache system. More...
#include <iutil/cache.h>
Inheritance diagram for iCacheManager:

Public Member Functions | |
virtual bool | CacheData (const void *data, size_t size, const char *type, const char *scope, uint32 id)=0 |
Cache some data. | |
virtual bool | ClearCache (const char *type=0, const char *scope=0, const uint32 *id=0)=0 |
Clear items from the cache. | |
virtual void | Flush ()=0 |
Ensure that the cached data is written on whatever medium is behind the cache. | |
virtual const char * | GetCurrentScope () const =0 |
Get current scope or 0 if none set. | |
virtual const char * | GetCurrentType () const =0 |
Get current type or 0 if none set. | |
virtual bool | IsReadOnly () const =0 |
Is the cache manager read-only? | |
virtual csPtr< iDataBuffer > | ReadCache (const char *type, const char *scope, uint32 id)=0 |
Retrieve some data from the cache. | |
virtual void | SetCurrentScope (const char *scope)=0 |
Set current scope. | |
virtual void | SetCurrentType (const char *type)=0 |
Set current type. | |
virtual void | SetReadOnly (bool ro)=0 |
Force the cache manager to be read-only. |
Detailed Description
A generic cache system.A client can use this to cache data that was hard to calculate. The data is not converted in any way so it is the responsability of the client to correct platform depending issues like endianess and structure padding.
Every item in a cache has a 'type', a 'scope', and a unique id. The 'type' can be something like 'lightmap', 'octree', ... The 'scope' can be something like 'myRegion_mySector', ... The 'id' is a unique ID for the cached item in the given type and scope. ~0 can be taken for the cases "no ID" or "ID unused". Avoid using '/' and '\' characters in both type and scope as this may cause conflicts with the given cache (if it caches on a file system for example).
Note that both 'type' and 'scope' can be made default using SetCurrentType() and SetCurrentScope(). If those are set then you can use 0 for type and/or scope in CacheData() and ReadCache(). If you don't use 0 then the given value will override the default values.
Definition at line 53 of file cache.h.
Member Function Documentation
|
Cache some data. Returns true if this succeeded. Implemented in csNullCacheManager, and csVfsCacheManager. |
|
Clear items from the cache. There are four ways to call this function:
Implemented in csNullCacheManager, and csVfsCacheManager. |
|
Ensure that the cached data is written on whatever medium is behind the cache.
Implemented in csNullCacheManager, and csVfsCacheManager. |
|
Get current scope or 0 if none set.
Implemented in csNullCacheManager, and csVfsCacheManager. |
|
Get current type or 0 if none set.
Implemented in csNullCacheManager, and csVfsCacheManager. |
|
Is the cache manager read-only?
Implemented in csNullCacheManager, and csVfsCacheManager. |
|
Retrieve some data from the cache. Returns 0 if the data could not be found in the cache.
Implemented in csNullCacheManager, and csVfsCacheManager. |
|
Set current scope. This will be used in CacheData() and ReadCache() when the given 'scope' there is 0. Implemented in csNullCacheManager, and csVfsCacheManager. |
|
Set current type. This will be used in CacheData() and ReadCache() when the given 'type' there is 0. Implemented in csNullCacheManager, and csVfsCacheManager. |
|
Force the cache manager to be read-only. This will prevent updates of the cache but CacheData() will still return true to indicate success. Implemented in csNullCacheManager, and csVfsCacheManager. |
The documentation for this struct was generated from the following file:
- iutil/cache.h
Generated for Crystal Space by doxygen 1.4.4