<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Crystal Space 1.2.1: iCacheManager Struct Reference (Crystal Space 1.2.1 Public API Reference)</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<table border="0" cellpadding="0" cellspacing="0" width="100%" class="head">
<tr height="59">
<td class="head" width="202" valign="bottom" style="padding-left:0;"><a href="http://www.crystalspace3d.org/"><img src="csblur.png" width="236" height="59" alt="CrystalSpace" border="0"></a></td>
<td class="head"><h2>Public API Reference</h2></td>
</tr>
<tr height="11">
<td colspan="2" class="headshadow" valign="top" style="padding-left:0;"><img src="csblurb.png" width="236" height="11" alt="" border="0"></td>
</tr>
</table>
<div class="content">
<!-- Generated by Doxygen 1.5.3 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="classes.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical List</span></a></li>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<h1>iCacheManager Struct Reference</h1><!-- doxytag: class="iCacheManager" --><!-- doxytag: inherits="iBase" -->A generic cache system.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="cache_8h-source.html">iutil/cache.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for iCacheManager:</div>
<div class="dynsection">
<p><center><img src="structiCacheManager__inherit__graph.png" border="0" usemap="#iCacheManager__inherit__map" alt="Inheritance graph"></center>
<map name="iCacheManager__inherit__map">
<area shape="rect" href="classscfImplementation1.html" title="scfImplementation1\< csNullCacheManager, iCacheManager \>" alt="" coords="281,5,705,32"><area shape="rect" href="classscfImplementation1.html" title="scfImplementation1\< csVfsCacheManager, iCacheManager \>" alt="" coords="283,56,704,83"><area shape="rect" href="structiBase.html" title="This is the basic interface: all other interfaces should be derived from this one..." alt="" coords="5,31,61,57"><area shape="rect" href="classcsNullCacheManager.html" title="This is a general cache that doesn't cache anything at all." alt="" coords="755,5,912,32"><area shape="rect" href="classcsVfsCacheManager.html" title="This is a general cache that can cache data on VFS." alt="" coords="756,56,911,83"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="structiCacheManager-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structiCacheManager.html#2aedafde9aa1abfd45423fa2b509a487">CacheData</a> (const void *data, size_t size, const char *type, const char *scope, <a class="el" href="group__util.html#g1134b580f8da4de94ca6b1de4d37975e">uint32</a> id)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Cache some data. <a href="#2aedafde9aa1abfd45423fa2b509a487"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structiCacheManager.html#026bda3760ef474ba81032e849bd40b8">ClearCache</a> (const char *type=0, const char *scope=0, const <a class="el" href="group__util.html#g1134b580f8da4de94ca6b1de4d37975e">uint32</a> *id=0)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Clear items from the cache. <a href="#026bda3760ef474ba81032e849bd40b8"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structiCacheManager.html#6f55692170b6a800973260d3efe9dd98">Flush</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Ensure that the cached data is written on whatever medium is behind the cache. <a href="#6f55692170b6a800973260d3efe9dd98"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structiCacheManager.html#6c368f02fd33a11c9758daa968e0e6ae">GetCurrentScope</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get current scope or 0 if none set. <a href="#6c368f02fd33a11c9758daa968e0e6ae"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structiCacheManager.html#757fe6fbfa9de749269ee522106ac508">GetCurrentType</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get current type or 0 if none set. <a href="#757fe6fbfa9de749269ee522106ac508"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structiCacheManager.html#5354f443c37597e6f91c65aa435910c8">IsReadOnly</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Is the cache manager read-only? <a href="#5354f443c37597e6f91c65aa435910c8"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classcsPtr.html">csPtr</a><br>
< <a class="el" href="structiDataBuffer.html">iDataBuffer</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="structiCacheManager.html#8720145834e76d05d858b7b4bac6b8b1">ReadCache</a> (const char *type, const char *scope, <a class="el" href="group__util.html#g1134b580f8da4de94ca6b1de4d37975e">uint32</a> id)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieve some data from the cache. <a href="#8720145834e76d05d858b7b4bac6b8b1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structiCacheManager.html#9467a5d21d2f805217fe3017d3475349">SetCurrentScope</a> (const char *scope)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set current scope. <a href="#9467a5d21d2f805217fe3017d3475349"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structiCacheManager.html#368ec9b2fdcf57ef7e74a90f60189646">SetCurrentType</a> (const char *type)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set current type. <a href="#368ec9b2fdcf57ef7e74a90f60189646"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structiCacheManager.html#013f35481ea7adb2edd11c3c556b6cf4">SetReadOnly</a> (bool ro)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Force the cache manager to be read-only. <a href="#013f35481ea7adb2edd11c3c556b6cf4"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A generic cache system.
<p>
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. <p>
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). <p>
Note that both 'type' and 'scope' can be made default using <a class="el" href="structiCacheManager.html#368ec9b2fdcf57ef7e74a90f60189646" title="Set current type.">SetCurrentType()</a> and <a class="el" href="structiCacheManager.html#9467a5d21d2f805217fe3017d3475349" title="Set current scope.">SetCurrentScope()</a>. If those are set then you can use 0 for type and/or scope in <a class="el" href="structiCacheManager.html#2aedafde9aa1abfd45423fa2b509a487" title="Cache some data.">CacheData()</a> and <a class="el" href="structiCacheManager.html#8720145834e76d05d858b7b4bac6b8b1" title="Retrieve some data from the cache.">ReadCache()</a>. If you don't use 0 then the given value will override the default values.
<p>Definition at line <a class="el" href="cache_8h-source.html#l00052">52</a> of file <a class="el" href="cache_8h-source.html">cache.h</a>.</p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="2aedafde9aa1abfd45423fa2b509a487"></a><!-- doxytag: member="iCacheManager::CacheData" ref="2aedafde9aa1abfd45423fa2b509a487" args="(const void *data, size_t size, const char *type, const char *scope, uint32 id)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool iCacheManager::CacheData </td>
<td>(</td>
<td class="paramtype">const void * </td>
<td class="paramname"> <em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>scope</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__util.html#g1134b580f8da4de94ca6b1de4d37975e">uint32</a> </td>
<td class="paramname"> <em>id</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Cache some data.
<p>
Returns true if this succeeded.
<p>Implemented in <a class="el" href="classcsNullCacheManager.html#4e7b26c857964d3c18b56dffa15e0da7">csNullCacheManager</a>, and <a class="el" href="classcsVfsCacheManager.html#af49b7621a0622b7f90515ac5576e5c5">csVfsCacheManager</a>.</p>
</div>
</div><p>
<a class="anchor" name="026bda3760ef474ba81032e849bd40b8"></a><!-- doxytag: member="iCacheManager::ClearCache" ref="026bda3760ef474ba81032e849bd40b8" args="(const char *type=0, const char *scope=0, const uint32 *id=0)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool iCacheManager::ClearCache </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>type</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>scope</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="group__util.html#g1134b580f8da4de94ca6b1de4d37975e">uint32</a> * </td>
<td class="paramname"> <em>id</em> = <code>0</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Clear items from the cache.
<p>
There are four ways to call this function:<ul>
<li>0, 0, 0: clear entire cache.</li><li>'type', 0, 0: clear everything of this type.</li><li>'type', 'scope', 0: clear everything of this type and scope.</li><li>'type', 'scope', id: clear the specific item.</li></ul>
<p>
Returns true if items were deleted. Returns false if item was not found or deletion is not possible.
<p>Implemented in <a class="el" href="classcsNullCacheManager.html#2d981f16c349b1f0b863cfa0e1eb7abe">csNullCacheManager</a>, and <a class="el" href="classcsVfsCacheManager.html#0597d546bad71dc58dfebad402079c0e">csVfsCacheManager</a>.</p>
</div>
</div><p>
<a class="anchor" name="6f55692170b6a800973260d3efe9dd98"></a><!-- doxytag: member="iCacheManager::Flush" ref="6f55692170b6a800973260d3efe9dd98" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iCacheManager::Flush </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Ensure that the cached data is written on whatever medium is behind the cache.
<p>
<p>Implemented in <a class="el" href="classcsNullCacheManager.html#94a67b5203c1d8284059fe9759743a98">csNullCacheManager</a>, and <a class="el" href="classcsVfsCacheManager.html#f71878aec7fe758379ad56998ff22c55">csVfsCacheManager</a>.</p>
</div>
</div><p>
<a class="anchor" name="6c368f02fd33a11c9758daa968e0e6ae"></a><!-- doxytag: member="iCacheManager::GetCurrentScope" ref="6c368f02fd33a11c9758daa968e0e6ae" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const char* iCacheManager::GetCurrentScope </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get current scope or 0 if none set.
<p>
<p>Implemented in <a class="el" href="classcsNullCacheManager.html#86ceba26b60ad8645dddb953c9cfc8db">csNullCacheManager</a>, and <a class="el" href="classcsVfsCacheManager.html#d2aee76ef0d1e381fc473bf810991648">csVfsCacheManager</a>.</p>
</div>
</div><p>
<a class="anchor" name="757fe6fbfa9de749269ee522106ac508"></a><!-- doxytag: member="iCacheManager::GetCurrentType" ref="757fe6fbfa9de749269ee522106ac508" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const char* iCacheManager::GetCurrentType </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get current type or 0 if none set.
<p>
<p>Implemented in <a class="el" href="classcsNullCacheManager.html#8baeefa2a11dcb25b77ece65056e7bc0">csNullCacheManager</a>, and <a class="el" href="classcsVfsCacheManager.html#beaf915c611af5992efb6c65d11a6f8d">csVfsCacheManager</a>.</p>
</div>
</div><p>
<a class="anchor" name="5354f443c37597e6f91c65aa435910c8"></a><!-- doxytag: member="iCacheManager::IsReadOnly" ref="5354f443c37597e6f91c65aa435910c8" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool iCacheManager::IsReadOnly </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Is the cache manager read-only?
<p>
<p>Implemented in <a class="el" href="classcsNullCacheManager.html#69fbf038696378ec0a6001b9dea77947">csNullCacheManager</a>, and <a class="el" href="classcsVfsCacheManager.html#4024c7cfb5a6b10275538943f1d45c28">csVfsCacheManager</a>.</p>
</div>
</div><p>
<a class="anchor" name="8720145834e76d05d858b7b4bac6b8b1"></a><!-- doxytag: member="iCacheManager::ReadCache" ref="8720145834e76d05d858b7b4bac6b8b1" args="(const char *type, const char *scope, uint32 id)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classcsPtr.html">csPtr</a><<a class="el" href="structiDataBuffer.html">iDataBuffer</a>> iCacheManager::ReadCache </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>scope</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__util.html#g1134b580f8da4de94ca6b1de4d37975e">uint32</a> </td>
<td class="paramname"> <em>id</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Retrieve some data from the cache.
<p>
Returns 0 if the data could not be found in the cache. <dl class="remark" compact><dt><b>Remarks:</b></dt><dd>Returned buffer is NOT null-terminated. <p>
Don't modify returned buffer! </dd></dl>
<p>Implemented in <a class="el" href="classcsNullCacheManager.html#307bd208fe556f1e298af62fce7941de">csNullCacheManager</a>, and <a class="el" href="classcsVfsCacheManager.html#09efd63ae7ac4313f6c6c07409d50d8b">csVfsCacheManager</a>.</p>
</div>
</div><p>
<a class="anchor" name="9467a5d21d2f805217fe3017d3475349"></a><!-- doxytag: member="iCacheManager::SetCurrentScope" ref="9467a5d21d2f805217fe3017d3475349" args="(const char *scope)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iCacheManager::SetCurrentScope </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>scope</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set current scope.
<p>
This will be used in <a class="el" href="structiCacheManager.html#2aedafde9aa1abfd45423fa2b509a487" title="Cache some data.">CacheData()</a> and <a class="el" href="structiCacheManager.html#8720145834e76d05d858b7b4bac6b8b1" title="Retrieve some data from the cache.">ReadCache()</a> when the given 'scope' there is 0.
<p>Implemented in <a class="el" href="classcsNullCacheManager.html#e5f4b2d643f46d7bf58892e6b3a35135">csNullCacheManager</a>, and <a class="el" href="classcsVfsCacheManager.html#c66d9b7c679fdda2722c4d92f68daccc">csVfsCacheManager</a>.</p>
</div>
</div><p>
<a class="anchor" name="368ec9b2fdcf57ef7e74a90f60189646"></a><!-- doxytag: member="iCacheManager::SetCurrentType" ref="368ec9b2fdcf57ef7e74a90f60189646" args="(const char *type)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iCacheManager::SetCurrentType </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>type</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set current type.
<p>
This will be used in <a class="el" href="structiCacheManager.html#2aedafde9aa1abfd45423fa2b509a487" title="Cache some data.">CacheData()</a> and <a class="el" href="structiCacheManager.html#8720145834e76d05d858b7b4bac6b8b1" title="Retrieve some data from the cache.">ReadCache()</a> when the given 'type' there is 0.
<p>Implemented in <a class="el" href="classcsNullCacheManager.html#94c2e512887ab82dc6c3bfad6e3c4ea4">csNullCacheManager</a>, and <a class="el" href="classcsVfsCacheManager.html#f313ceafd06b7a528b7d4925181994b0">csVfsCacheManager</a>.</p>
</div>
</div><p>
<a class="anchor" name="013f35481ea7adb2edd11c3c556b6cf4"></a><!-- doxytag: member="iCacheManager::SetReadOnly" ref="013f35481ea7adb2edd11c3c556b6cf4" args="(bool ro)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iCacheManager::SetReadOnly </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>ro</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Force the cache manager to be read-only.
<p>
This will prevent updates of the cache but <a class="el" href="structiCacheManager.html#2aedafde9aa1abfd45423fa2b509a487" title="Cache some data.">CacheData()</a> will still return true to indicate success.
<p>Implemented in <a class="el" href="classcsNullCacheManager.html#d66c76d2349f6261db3ba2a4c07752bb">csNullCacheManager</a>, and <a class="el" href="classcsVfsCacheManager.html#37027ad3efed70589a378920b6c808ef">csVfsCacheManager</a>.</p>
</div>
</div><p>
<hr>The documentation for this struct was generated from the following file:<ul>
<li>iutil/<a class="el" href="cache_8h-source.html">cache.h</a></ul>
<hr size="1"><address><small>Generated for Crystal Space 1.2.1 by
<a href="http://www.doxygen.org/index.html">doxygen</a> 1.5.3
</small></address> </div></body> </html>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
bad97183153701b09df5fae1052b1c30
>
files
>
2812
