diff options
Diffstat (limited to 'runtime/docs/html/structmap__root.html')
-rw-r--r-- | runtime/docs/html/structmap__root.html | 128 |
1 files changed, 111 insertions, 17 deletions
diff --git a/runtime/docs/html/structmap__root.html b/runtime/docs/html/structmap__root.html index a55fe7b8..0fdd005f 100644 --- a/runtime/docs/html/structmap__root.html +++ b/runtime/docs/html/structmap__root.html @@ -14,36 +14,40 @@ <tr><td></td></tr> <tr><td colspan="2"><br><h2>Data Fields</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="o0" doxytag="map_root::type"></a> -enum valtype </td><td class="memItemRight" valign="bottom"><b>type</b></td></tr> +enum <a class="el" href="map_8h.html#a19">valtype</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structmap__root.html#o0">type</a></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">type of the values stored in the array <br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="o1" doxytag="map_root::maxnum"></a> int </td><td class="memItemRight" valign="bottom"><a class="el" href="structmap__root.html#o1">maxnum</a></td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">type of the values stored in the array <br></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">maximum number of elements allowed in the array. <br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="o2" doxytag="map_root::num"></a> int </td><td class="memItemRight" valign="bottom"><a class="el" href="structmap__root.html#o2">num</a></td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">maximum number of elements allowed in the array. <br></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">current number of used elements <br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="o3" doxytag="map_root::no_wrap"></a> -int </td><td class="memItemRight" valign="bottom"><b>no_wrap</b></td></tr> +int </td><td class="memItemRight" valign="bottom"><a class="el" href="structmap__root.html#o3">no_wrap</a></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">when more than maxnum elements, wrap or discard? <br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="o4" doxytag="map_root::head"></a> -list_head </td><td class="memItemRight" valign="bottom"><b>head</b></td></tr> +list_head </td><td class="memItemRight" valign="bottom"><a class="el" href="structmap__root.html#o4">head</a></td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="o5" doxytag="map_root::pool"></a> -list_head </td><td class="memItemRight" valign="bottom"><b>pool</b></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">linked list of current entries <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">list_head </td><td class="memItemRight" valign="bottom"><a class="el" href="structmap__root.html#o5">pool</a></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">pool of unused entries. <a href="#o5"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="o6" doxytag="map_root::key"></a> -<a class="el" href="structmap__node.html">map_node</a> * </td><td class="memItemRight" valign="bottom"><b>key</b></td></tr> +<a class="el" href="structmap__node.html">map_node</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structmap__root.html#o6">key</a></td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="o7" doxytag="map_root::create"></a> -u_int8_t </td><td class="memItemRight" valign="bottom"><b>create</b></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">saved key entry for lookups <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">u_int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structmap__root.html#o7">create</a></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">this is the creation data saved between the key functions and the set/get functions <a href="#o7"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="o8" doxytag="map_root::c_key1type"></a> -enum keytype </td><td class="memItemRight" valign="bottom"><b>c_key1type</b></td></tr> +enum <a class="el" href="map_8h.html#a18">keytype</a> </td><td class="memItemRight" valign="bottom"><b>c_key1type</b></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="o9" doxytag="map_root::c_key2type"></a> -enum keytype </td><td class="memItemRight" valign="bottom"><b>c_key2type</b></td></tr> +enum <a class="el" href="map_8h.html#a18">keytype</a> </td><td class="memItemRight" valign="bottom"><b>c_key2type</b></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="o10" doxytag="map_root::c_keyhead"></a> hlist_head * </td><td class="memItemRight" valign="bottom"><b>c_keyhead</b></td></tr> @@ -55,11 +59,12 @@ hlist_head * </td><td class="memItemRight" valign="bottom"><b>c_keyhead</b> <a class="el" href="unionkey__data.html">key_data</a> </td><td class="memItemRight" valign="bottom"><b>c_key2</b></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="o13" doxytag="map_root::hashes"></a> -hlist_head </td><td class="memItemRight" valign="bottom"><b>hashes</b> [HASH_TABLE_SIZE]</td></tr> +hlist_head </td><td class="memItemRight" valign="bottom"><a class="el" href="structmap__root.html#o13">hashes</a> [HASH_TABLE_SIZE]</td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="o14" doxytag="map_root::membuf"></a> -void * </td><td class="memItemRight" valign="bottom"><b>membuf</b></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">the hash table for this array <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="structmap__root.html#o14">membuf</a></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">pointer to allocated memory space. <a href="#o14"></a><br></td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> This structure contains all information about a map. @@ -68,8 +73,97 @@ It is allocated once when <a class="el" href="map_8c.html#a3">_stp_map_new()</a> <p> <p> -Definition at line <a class="el" href="map_8h-source.html#l00057">57</a> of file <a class="el" href="map_8h-source.html">map.h</a>.<hr>The documentation for this struct was generated from the following file:<ul> +Definition at line <a class="el" href="map_8h-source.html#l00061">61</a> of file <a class="el" href="map_8h-source.html">map.h</a>.<hr><h2>Field Documentation</h2> +<a class="anchor" name="o7" doxytag="map_root::create"></a><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">u_int8_t <a class="el" href="structmap__root.html#o7">map_root::create</a> </td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +this is the creation data saved between the key functions and the set/get functions +<p> +<dl compact><dt><b><a class="el" href="todo.html#_todo000005">Todo:</a></b></dt><dd>Needs to be per-cpu data for SMP support</dd></dl> + +<p> +Definition at line <a class="el" href="map_8h-source.html#l00087">87</a> of file <a class="el" href="map_8h-source.html">map.h</a>. +<p> +Referenced by <a class="el" href="map_8c-source.html#l00557">_stp_map_get_int64()</a>, <a class="el" href="map_8c-source.html#l00721">_stp_map_get_stat()</a>, <a class="el" href="map_8c-source.html#l00638">_stp_map_get_str()</a>, <a class="el" href="map_8c-source.html#l00222">_stp_map_key_long_long()</a>, <a class="el" href="map_8c-source.html#l00362">_stp_map_key_long_str()</a>, <a class="el" href="map_8c-source.html#l00314">_stp_map_key_str_long()</a>, <a class="el" href="map_8c-source.html#l00265">_stp_map_key_str_str()</a>, <a class="el" href="map_8c-source.html#l00662">_stp_map_set_stat()</a>, <a class="el" href="map_8c-source.html#l00577">_stp_map_set_str()</a>, and <a class="el" href="map_8c-source.html#l00742">_stp_map_stat_add()</a>. </td> + </tr> +</table> +<a class="anchor" name="o14" doxytag="map_root::membuf"></a><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">void* <a class="el" href="structmap__root.html#o14">map_root::membuf</a> </td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +pointer to allocated memory space. +<p> +Used for freeing memory. +<p> +Definition at line <a class="el" href="map_8h-source.html#l00098">98</a> of file <a class="el" href="map_8h-source.html">map.h</a>. +<p> +Referenced by <a class="el" href="map_8c-source.html#l00194">_stp_map_del()</a>, and <a class="el" href="map_8c-source.html#l00046">_stp_map_new()</a>. </td> + </tr> +</table> +<a class="anchor" name="o5" doxytag="map_root::pool"></a><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">struct list_head <a class="el" href="structmap__root.html#o5">map_root::pool</a> </td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +pool of unused entries. +<p> +Used only when entries are statically allocated at startup. +<p> +Definition at line <a class="el" href="map_8h-source.html#l00079">79</a> of file <a class="el" href="map_8h-source.html">map.h</a>. +<p> +Referenced by <a class="el" href="map_8c-source.html#l00794">_stp_list_clear()</a>, <a class="el" href="map_8c-source.html#l00046">_stp_map_new()</a>, <a class="el" href="map_8c-source.html#l00662">_stp_map_set_stat()</a>, and <a class="el" href="map_8c-source.html#l00577">_stp_map_set_str()</a>. </td> + </tr> +</table> +<hr>The documentation for this struct was generated from the following file:<ul> <li><a class="el" href="map_8h-source.html">map.h</a></ul> <hr size="1"><address style="align: right;"><small> -Generated on Tue Mar 22 00:32:02 2005 for SystemTap.</small></body> +Generated on Tue Mar 22 10:27:36 2005 for SystemTap.</small></body> </html> |