diff options
Diffstat (limited to 'cache_8c.html')
| -rw-r--r-- | cache_8c.html | 267 |
1 files changed, 267 insertions, 0 deletions
diff --git a/cache_8c.html b/cache_8c.html new file mode 100644 index 0000000..285c4ef --- /dev/null +++ b/cache_8c.html @@ -0,0 +1,267 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>memcached: cache.c File Reference</title> +<link href="tabs.css" rel="stylesheet" type="text/css"> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.8 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="annotated.html"><span>Classes</span></a></li> + <li class="current"><a href="files.html"><span>Files</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="files.html"><span>File List</span></a></li> + <li><a href="globals.html"><span>File Members</span></a></li> + </ul> + </div> +</div> +<div class="contents"> +<h1>cache.c File Reference</h1><code>#include <stdlib.h></code><br> +<code>#include <string.h></code><br> +<code>#include <inttypes.h></code><br> +<code>#include <signal.h></code><br> +<code>#include "<a class="el" href="cache_8h-source.html">cache.h</a>"</code><br> + +<p> +<div class="dynheader"> +Include dependency graph for cache.c:</div> +<div class="dynsection"> +<p><center><img src="cache_8c__incl.png" border="0" usemap="#cache.c_map" alt=""></center> +<map name="cache.c_map"> +<area shape="rect" id="node11" href="cache_8h.html" title="cache.h" alt="" coords="403,83,477,112"></map> +</div> +<table border="0" cellpadding="0" cellspacing="0"> +<tr><td></td></tr> +<tr><td colspan="2"><br><h2>Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structcache__t.html">cache_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="cache_8c.html#631fa31e902ac58f80d0374ffed1d486">cache_create</a> (const char *name, size_t bufsize, size_t align, <a class="el" href="cache_8h.html#565b39d1034d5aaccafd0e996904eebc">cache_constructor_t</a> *constructor, <a class="el" href="cache_8h.html#7ac51941cc19301c6ce8b7c4a3d5dd9c">cache_destructor_t</a> *destructor)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Create an object cache. <a href="#631fa31e902ac58f80d0374ffed1d486"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="cache_8c.html#81a74098387faa1e105aa3e9e1d60a5e">cache_destroy</a> (<a class="el" href="structcache__t.html">cache_t</a> *cache)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Destroy an object cache. <a href="#81a74098387faa1e105aa3e9e1d60a5e"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="cache_8c.html#6cc4f3f91247554c4961a0cb8acc298f">cache_alloc</a> (<a class="el" href="structcache__t.html">cache_t</a> *cache)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Allocate an object from the cache. <a href="#6cc4f3f91247554c4961a0cb8acc298f"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="cache_8c.html#a1906b5ce5a39f760454519441f3e0b9">cache_free</a> (<a class="el" href="structcache__t.html">cache_t</a> *cache, void *ptr)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return an object back to the cache. <a href="#a1906b5ce5a39f760454519441f3e0b9"></a><br></td></tr> +<tr><td colspan="2"><br><h2>Variables</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">const uint64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="cache_8c.html#c8198db047750632f151394ed7bb6841">redzone_pattern</a> = 0xdeadbeefcafebabe</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="cache_8c.html#d4f8c8851cbc2284dc3af57ed3601b6b">cache_error</a> = 0</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">const int </td><td class="memItemRight" valign="bottom"><a class="el" href="cache_8c.html#6eb94ba2de80d22549df5b6f447e1166">initial_pool_size</a> = 64</td></tr> + +</table> +<hr><h2>Function Documentation</h2> +<a class="anchor" name="6cc4f3f91247554c4961a0cb8acc298f"></a><!-- doxytag: member="cache.c::cache_alloc" ref="6cc4f3f91247554c4961a0cb8acc298f" args="(cache_t *cache)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void* cache_alloc </td> + <td>(</td> + <td class="paramtype"><a class="el" href="structcache__t.html">cache_t</a> * </td> + <td class="paramname"> <em>handle</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Allocate an object from the cache. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>the handle to the object cache to allocate from </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>a pointer to an initialized object from the cache, or NULL if the allocation cannot be satisfied. </dd></dl> + +</div> +</div><p> +<a class="anchor" name="631fa31e902ac58f80d0374ffed1d486"></a><!-- doxytag: member="cache.c::cache_create" ref="631fa31e902ac58f80d0374ffed1d486" args="(const char *name, size_t bufsize, size_t align, cache_constructor_t *constructor, cache_destructor_t *destructor)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="structcache__t.html">cache_t</a>* cache_create </td> + <td>(</td> + <td class="paramtype">const char * </td> + <td class="paramname"> <em>name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">size_t </td> + <td class="paramname"> <em>bufsize</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">size_t </td> + <td class="paramname"> <em>align</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="cache_8h.html#565b39d1034d5aaccafd0e996904eebc">cache_constructor_t</a> * </td> + <td class="paramname"> <em>constructor</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="cache_8h.html#7ac51941cc19301c6ce8b7c4a3d5dd9c">cache_destructor_t</a> * </td> + <td class="paramname"> <em>destructor</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Create an object cache. +<p> +The object cache will let you allocate objects of the same size. It is fully MT safe, so you may allocate objects from multiple threads without having to do any syncrhonization in the application code.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>the name of the object cache. This name may be used for debug purposes and may help you track down what kind of object you have problems with (buffer overruns, leakage etc) </td></tr> + <tr><td valign="top"></td><td valign="top"><em>bufsize</em> </td><td>the size of each object in the cache </td></tr> + <tr><td valign="top"></td><td valign="top"><em>align</em> </td><td>the alignment requirements of the objects in the cache. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>constructor</em> </td><td>the function to be called to initialize memory when we need to allocate more memory from the os. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>destructor</em> </td><td>the function to be called before we release the memory back to the os. </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>a handle to an object cache if successful, NULL otherwise. </dd></dl> + +</div> +</div><p> +<a class="anchor" name="81a74098387faa1e105aa3e9e1d60a5e"></a><!-- doxytag: member="cache.c::cache_destroy" ref="81a74098387faa1e105aa3e9e1d60a5e" args="(cache_t *cache)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void cache_destroy </td> + <td>(</td> + <td class="paramtype"><a class="el" href="structcache__t.html">cache_t</a> * </td> + <td class="paramname"> <em>handle</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Destroy an object cache. +<p> +Destroy and invalidate an object cache. You should return all buffers allocated with cache_alloc by using cache_free before calling this function. Not doing so results in undefined behavior (the buffers may or may not be invalidated)<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>the handle to the object cache to destroy. </td></tr> + </table> +</dl> + +</div> +</div><p> +<a class="anchor" name="a1906b5ce5a39f760454519441f3e0b9"></a><!-- doxytag: member="cache.c::cache_free" ref="a1906b5ce5a39f760454519441f3e0b9" args="(cache_t *cache, void *ptr)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void cache_free </td> + <td>(</td> + <td class="paramtype"><a class="el" href="structcache__t.html">cache_t</a> * </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">void * </td> + <td class="paramname"> <em>ptr</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Return an object back to the cache. +<p> +The caller should return the object in an initialized state so that the object may be returned in an expected state from cache_alloc.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>handle to the object cache to return the object to </td></tr> + <tr><td valign="top"></td><td valign="top"><em>ptr</em> </td><td>pointer to the object to return. </td></tr> + </table> +</dl> + +</div> +</div><p> +<hr><h2>Variable Documentation</h2> +<a class="anchor" name="d4f8c8851cbc2284dc3af57ed3601b6b"></a><!-- doxytag: member="cache.c::cache_error" ref="d4f8c8851cbc2284dc3af57ed3601b6b" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int <a class="el" href="cache_8h.html#d4f8c8851cbc2284dc3af57ed3601b6b">cache_error</a> = 0 </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="6eb94ba2de80d22549df5b6f447e1166"></a><!-- doxytag: member="cache.c::initial_pool_size" ref="6eb94ba2de80d22549df5b6f447e1166" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">const int <a class="el" href="cache_8c.html#6eb94ba2de80d22549df5b6f447e1166">initial_pool_size</a> = 64 </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="c8198db047750632f151394ed7bb6841"></a><!-- doxytag: member="cache.c::redzone_pattern" ref="c8198db047750632f151394ed7bb6841" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">const uint64_t <a class="el" href="cache_8c.html#c8198db047750632f151394ed7bb6841">redzone_pattern</a> = 0xdeadbeefcafebabe </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +</div> +<hr size="1"><address style="text-align: right;"><small>Generated on Fri Apr 17 16:28:09 2009 for memcached by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address> +</body> +</html> |