]> granicus.if.org Git - json-c/blobdiff - doc/html/linkhash_8h.html
Add doxygen-generated docs for the 0.12.1 release.
[json-c] / doc / html / linkhash_8h.html
index 0ddda26323299efc5b08eb42adbbe614f54143d3..f31b29d5e6e3ea62eebdd41f477954486b5a2c35 100644 (file)
@@ -3,7 +3,7 @@
 <head>
 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
-<meta name="generator" content="Doxygen 1.8.5"/>
+<meta name="generator" content="Doxygen 1.8.9.1"/>
 <title>json-c: linkhash.h File Reference</title>
 <link href="tabs.css" rel="stylesheet" type="text/css"/>
 <script type="text/javascript" src="jquery.js"></script>
@@ -18,7 +18,7 @@
  <tr style="height: 56px;">
   <td style="padding-left: 0.5em;">
    <div id="projectname">json-c
-   &#160;<span id="projectnumber">0.12</span>
+   &#160;<span id="projectnumber">0.12.1</span>
    </div>
   </td>
  </tr>
@@ -26,7 +26,7 @@
 </table>
 </div>
 <!-- end header part -->
-<!-- Generated by Doxygen 1.8.5 -->
+<!-- Generated by Doxygen 1.8.9.1 -->
   <div id="navrow1" class="tabs">
     <ul class="tablist">
       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
@@ -70,19 +70,19 @@ Macros</h2></td></tr>
 <tr class="separator:a93fad7f8ae44575dc89c9567859972d2"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:ac69428f2de0a6fb080b6fb373d506aa7"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="linkhash_8h.html#ac69428f2de0a6fb080b6fb373d506aa7">LH_FREED</a>&#160;&#160;&#160;(void*)-2</td></tr>
 <tr class="separator:ac69428f2de0a6fb080b6fb373d506aa7"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:ad7dd67da915065dce2c6f44cb03e2d82"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="linkhash_8h.html#ad7dd67da915065dce2c6f44cb03e2d82">lh_foreach</a>(table, entry)&#160;&#160;&#160;for(entry = table-&gt;head; entry; entry = entry-&gt;next)</td></tr>
+<tr class="memitem:ad7dd67da915065dce2c6f44cb03e2d82"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="linkhash_8h.html#ad7dd67da915065dce2c6f44cb03e2d82">lh_foreach</a>(table,  entry)&#160;&#160;&#160;for(entry = table-&gt;head; entry; entry = entry-&gt;next)</td></tr>
 <tr class="separator:ad7dd67da915065dce2c6f44cb03e2d82"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:abcbb0df08b4976d0649b826b6bacfca1"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="linkhash_8h.html#abcbb0df08b4976d0649b826b6bacfca1">lh_foreach_safe</a>(table, entry, tmp)&#160;&#160;&#160;for(entry = table-&gt;head; entry &amp;&amp; ((tmp = entry-&gt;next) || 1); entry = tmp)</td></tr>
+<tr class="memitem:abcbb0df08b4976d0649b826b6bacfca1"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="linkhash_8h.html#abcbb0df08b4976d0649b826b6bacfca1">lh_foreach_safe</a>(table,  entry,  tmp)&#160;&#160;&#160;for(entry = table-&gt;head; entry &amp;&amp; ((tmp = entry-&gt;next) || 1); entry = tmp)</td></tr>
 <tr class="separator:abcbb0df08b4976d0649b826b6bacfca1"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table><table class="memberdecls">
 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
 Typedefs</h2></td></tr>
-<tr class="memitem:a671553d0ee3c2a123190ba0f8ed2b635"><td class="memItemLeft" align="right" valign="top">typedef void(&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="linkhash_8h.html#a671553d0ee3c2a123190ba0f8ed2b635">lh_entry_free_fn</a> )(struct <a class="el" href="structlh__entry.html">lh_entry</a> *e)</td></tr>
-<tr class="separator:a671553d0ee3c2a123190ba0f8ed2b635"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a38bae27995dcfb6ee3fb109a9be229b2"><td class="memItemLeft" align="right" valign="top">typedef unsigned long(&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="linkhash_8h.html#a38bae27995dcfb6ee3fb109a9be229b2">lh_hash_fn</a> )(const void *k)</td></tr>
-<tr class="separator:a38bae27995dcfb6ee3fb109a9be229b2"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a91fd85fc81b0c7c83c62f00e84729091"><td class="memItemLeft" align="right" valign="top">typedef int(&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="linkhash_8h.html#a91fd85fc81b0c7c83c62f00e84729091">lh_equal_fn</a> )(const void *k1, const void *k2)</td></tr>
-<tr class="separator:a91fd85fc81b0c7c83c62f00e84729091"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a0c6811f660b93857aafdbfdf80d9696b"><td class="memItemLeft" align="right" valign="top">typedef void(&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="linkhash_8h.html#a0c6811f660b93857aafdbfdf80d9696b">lh_entry_free_fn</a>) (struct <a class="el" href="structlh__entry.html">lh_entry</a> *e)</td></tr>
+<tr class="separator:a0c6811f660b93857aafdbfdf80d9696b"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a1780449146b716ad5e6ed0a0207d0417"><td class="memItemLeft" align="right" valign="top">typedef unsigned long(&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="linkhash_8h.html#a1780449146b716ad5e6ed0a0207d0417">lh_hash_fn</a>) (const void *k)</td></tr>
+<tr class="separator:a1780449146b716ad5e6ed0a0207d0417"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:abcbf0e4849fb0c6279827ac3b66d15c3"><td class="memItemLeft" align="right" valign="top">typedef int(&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="linkhash_8h.html#abcbf0e4849fb0c6279827ac3b66d15c3">lh_equal_fn</a>) (const void *k1, const void *k2)</td></tr>
+<tr class="separator:abcbf0e4849fb0c6279827ac3b66d15c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table><table class="memberdecls">
 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
 Functions</h2></td></tr>
@@ -94,11 +94,11 @@ Functions</h2></td></tr>
 <tr class="separator:a1fcf495b9c4ce169630cb31f638b8435"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:ae4e9f21fb1a556c7a50c6b7ea61f2079"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="linkhash_8h.html#ae4e9f21fb1a556c7a50c6b7ea61f2079">lh_char_equal</a> (const void *k1, const void *k2)</td></tr>
 <tr class="separator:ae4e9f21fb1a556c7a50c6b7ea61f2079"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:ac3ba464ac43c083397b1f1d34f2ddf55"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structlh__table.html">lh_table</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="linkhash_8h.html#ac3ba464ac43c083397b1f1d34f2ddf55">lh_table_new</a> (int size, const char *name, <a class="el" href="linkhash_8h.html#a671553d0ee3c2a123190ba0f8ed2b635">lh_entry_free_fn</a> *free_fn, <a class="el" href="linkhash_8h.html#a38bae27995dcfb6ee3fb109a9be229b2">lh_hash_fn</a> *hash_fn, <a class="el" href="linkhash_8h.html#a91fd85fc81b0c7c83c62f00e84729091">lh_equal_fn</a> *equal_fn)</td></tr>
+<tr class="memitem:ac3ba464ac43c083397b1f1d34f2ddf55"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structlh__table.html">lh_table</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="linkhash_8h.html#ac3ba464ac43c083397b1f1d34f2ddf55">lh_table_new</a> (int size, const char *name, <a class="el" href="linkhash_8h.html#a0c6811f660b93857aafdbfdf80d9696b">lh_entry_free_fn</a> *free_fn, <a class="el" href="linkhash_8h.html#a1780449146b716ad5e6ed0a0207d0417">lh_hash_fn</a> *hash_fn, <a class="el" href="linkhash_8h.html#abcbf0e4849fb0c6279827ac3b66d15c3">lh_equal_fn</a> *equal_fn)</td></tr>
 <tr class="separator:ac3ba464ac43c083397b1f1d34f2ddf55"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a0aaf11e11ee5b0925279a52eab04bc38"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structlh__table.html">lh_table</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="linkhash_8h.html#a0aaf11e11ee5b0925279a52eab04bc38">lh_kchar_table_new</a> (int size, const char *name, <a class="el" href="linkhash_8h.html#a671553d0ee3c2a123190ba0f8ed2b635">lh_entry_free_fn</a> *free_fn)</td></tr>
+<tr class="memitem:a0aaf11e11ee5b0925279a52eab04bc38"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structlh__table.html">lh_table</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="linkhash_8h.html#a0aaf11e11ee5b0925279a52eab04bc38">lh_kchar_table_new</a> (int size, const char *name, <a class="el" href="linkhash_8h.html#a0c6811f660b93857aafdbfdf80d9696b">lh_entry_free_fn</a> *free_fn)</td></tr>
 <tr class="separator:a0aaf11e11ee5b0925279a52eab04bc38"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a705513954267a16cc1d40a284a7c441e"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structlh__table.html">lh_table</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="linkhash_8h.html#a705513954267a16cc1d40a284a7c441e">lh_kptr_table_new</a> (int size, const char *name, <a class="el" href="linkhash_8h.html#a671553d0ee3c2a123190ba0f8ed2b635">lh_entry_free_fn</a> *free_fn)</td></tr>
+<tr class="memitem:a705513954267a16cc1d40a284a7c441e"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structlh__table.html">lh_table</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="linkhash_8h.html#a705513954267a16cc1d40a284a7c441e">lh_kptr_table_new</a> (int size, const char *name, <a class="el" href="linkhash_8h.html#a0c6811f660b93857aafdbfdf80d9696b">lh_entry_free_fn</a> *free_fn)</td></tr>
 <tr class="separator:a705513954267a16cc1d40a284a7c441e"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a81653acf740cf8c9fe672e6cd16df0cf"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="linkhash_8h.html#a81653acf740cf8c9fe672e6cd16df0cf">lh_table_free</a> (struct <a class="el" href="structlh__table.html">lh_table</a> *t)</td></tr>
 <tr class="separator:a81653acf740cf8c9fe672e6cd16df0cf"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -235,12 +235,12 @@ Functions</h2></td></tr>
 </div>
 </div>
 <h2 class="groupheader">Typedef Documentation</h2>
-<a class="anchor" id="a671553d0ee3c2a123190ba0f8ed2b635"></a>
+<a class="anchor" id="a0c6811f660b93857aafdbfdf80d9696b"></a>
 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
-          <td class="memname">typedef void( lh_entry_free_fn)(struct <a class="el" href="structlh__entry.html">lh_entry</a> *e)</td>
+          <td class="memname">typedef void( lh_entry_free_fn) (struct <a class="el" href="structlh__entry.html">lh_entry</a> *e)</td>
         </tr>
       </table>
 </div><div class="memdoc">
@@ -248,12 +248,12 @@ Functions</h2></td></tr>
 
 </div>
 </div>
-<a class="anchor" id="a91fd85fc81b0c7c83c62f00e84729091"></a>
+<a class="anchor" id="abcbf0e4849fb0c6279827ac3b66d15c3"></a>
 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
-          <td class="memname">typedef int( lh_equal_fn)(const void *k1, const void *k2)</td>
+          <td class="memname">typedef int( lh_equal_fn) (const void *k1, const void *k2)</td>
         </tr>
       </table>
 </div><div class="memdoc">
@@ -261,12 +261,12 @@ Functions</h2></td></tr>
 
 </div>
 </div>
-<a class="anchor" id="a38bae27995dcfb6ee3fb109a9be229b2"></a>
+<a class="anchor" id="a1780449146b716ad5e6ed0a0207d0417"></a>
 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
-          <td class="memname">typedef unsigned long( lh_hash_fn)(const void *k)</td>
+          <td class="memname">typedef unsigned long( lh_hash_fn) (const void *k)</td>
         </tr>
       </table>
 </div><div class="memdoc">
@@ -362,7 +362,7 @@ Functions</h2></td></tr>
         <tr>
           <td class="paramkey"></td>
           <td></td>
-          <td class="paramtype"><a class="el" href="linkhash_8h.html#a671553d0ee3c2a123190ba0f8ed2b635">lh_entry_free_fn</a> *&#160;</td>
+          <td class="paramtype"><a class="el" href="linkhash_8h.html#a0c6811f660b93857aafdbfdf80d9696b">lh_entry_free_fn</a> *&#160;</td>
           <td class="paramname"><em>free_fn</em>&#160;</td>
         </tr>
         <tr>
@@ -372,8 +372,7 @@ Functions</h2></td></tr>
         </tr>
       </table>
 </div><div class="memdoc">
-<p>Convenience function to create a new linkhash table with char keys. </p>
-<dl class="params"><dt>Parameters</dt><dd>
+<p>Convenience function to create a new linkhash table with char keys. </p><dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
     <tr><td class="paramname">size</td><td>initial table size. </td></tr>
     <tr><td class="paramname">name</td><td>table name. </td></tr>
@@ -404,7 +403,7 @@ Functions</h2></td></tr>
         <tr>
           <td class="paramkey"></td>
           <td></td>
-          <td class="paramtype"><a class="el" href="linkhash_8h.html#a671553d0ee3c2a123190ba0f8ed2b635">lh_entry_free_fn</a> *&#160;</td>
+          <td class="paramtype"><a class="el" href="linkhash_8h.html#a0c6811f660b93857aafdbfdf80d9696b">lh_entry_free_fn</a> *&#160;</td>
           <td class="paramname"><em>free_fn</em>&#160;</td>
         </tr>
         <tr>
@@ -414,8 +413,7 @@ Functions</h2></td></tr>
         </tr>
       </table>
 </div><div class="memdoc">
-<p>Convenience function to create a new linkhash table with ptr keys. </p>
-<dl class="params"><dt>Parameters</dt><dd>
+<p>Convenience function to create a new linkhash table with ptr keys. </p><dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
     <tr><td class="paramname">size</td><td>initial table size. </td></tr>
     <tr><td class="paramname">name</td><td>table name. </td></tr>
@@ -493,8 +491,7 @@ Functions</h2></td></tr>
         </tr>
       </table>
 </div><div class="memdoc">
-<p>Delete a record from the table. If a callback free function is provided then it is called for the for the item being deleted. </p>
-<dl class="params"><dt>Parameters</dt><dd>
+<p>Delete a record from the table. If a callback free function is provided then it is called for the for the item being deleted. </p><dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
     <tr><td class="paramname">t</td><td>the table to delete from. </td></tr>
     <tr><td class="paramname">k</td><td>a pointer to the key to delete. </td></tr>
@@ -530,8 +527,7 @@ Functions</h2></td></tr>
         </tr>
       </table>
 </div><div class="memdoc">
-<p>Delete a record from the table. If a callback free function is provided then it is called for the for the item being deleted. </p>
-<dl class="params"><dt>Parameters</dt><dd>
+<p>Delete a record from the table. If a callback free function is provided then it is called for the for the item being deleted. </p><dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
     <tr><td class="paramname">t</td><td>the table to delete from. </td></tr>
     <tr><td class="paramname">e</td><td>a pointer to the entry to delete. </td></tr>
@@ -557,8 +553,7 @@ Functions</h2></td></tr>
         </tr>
       </table>
 </div><div class="memdoc">
-<p>Free a linkhash table. If a callback free function is provided then it is called for all entries in the table. </p>
-<dl class="params"><dt>Parameters</dt><dd>
+<p>Free a linkhash table. If a callback free function is provided then it is called for all entries in the table. </p><dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
     <tr><td class="paramname">t</td><td>table to free. </td></tr>
   </table>
@@ -596,8 +591,7 @@ Functions</h2></td></tr>
         </tr>
       </table>
 </div><div class="memdoc">
-<p>Insert a record into the table. </p>
-<dl class="params"><dt>Parameters</dt><dd>
+<p>Insert a record into the table. </p><dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
     <tr><td class="paramname">t</td><td>the table to insert into. </td></tr>
     <tr><td class="paramname">k</td><td>a pointer to the key to insert. </td></tr>
@@ -647,8 +641,7 @@ Functions</h2></td></tr>
         </tr>
       </table>
 </div><div class="memdoc">
-<p>Lookup a record into the table. </p>
-<dl class="params"><dt>Parameters</dt><dd>
+<p>Lookup a record into the table. </p><dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
     <tr><td class="paramname">t</td><td>the table to lookup </td></tr>
     <tr><td class="paramname">k</td><td>a pointer to the key to lookup </td></tr>
@@ -688,8 +681,7 @@ Functions</h2></td></tr>
         </tr>
       </table>
 </div><div class="memdoc">
-<p>Lookup a record in the table </p>
-<dl class="params"><dt>Parameters</dt><dd>
+<p>Lookup a record in the table </p><dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
     <tr><td class="paramname">t</td><td>the table to lookup </td></tr>
     <tr><td class="paramname">k</td><td>a pointer to the key to lookup </td></tr>
@@ -720,19 +712,19 @@ Functions</h2></td></tr>
         <tr>
           <td class="paramkey"></td>
           <td></td>
-          <td class="paramtype"><a class="el" href="linkhash_8h.html#a671553d0ee3c2a123190ba0f8ed2b635">lh_entry_free_fn</a> *&#160;</td>
+          <td class="paramtype"><a class="el" href="linkhash_8h.html#a0c6811f660b93857aafdbfdf80d9696b">lh_entry_free_fn</a> *&#160;</td>
           <td class="paramname"><em>free_fn</em>, </td>
         </tr>
         <tr>
           <td class="paramkey"></td>
           <td></td>
-          <td class="paramtype"><a class="el" href="linkhash_8h.html#a38bae27995dcfb6ee3fb109a9be229b2">lh_hash_fn</a> *&#160;</td>
+          <td class="paramtype"><a class="el" href="linkhash_8h.html#a1780449146b716ad5e6ed0a0207d0417">lh_hash_fn</a> *&#160;</td>
           <td class="paramname"><em>hash_fn</em>, </td>
         </tr>
         <tr>
           <td class="paramkey"></td>
           <td></td>
-          <td class="paramtype"><a class="el" href="linkhash_8h.html#a91fd85fc81b0c7c83c62f00e84729091">lh_equal_fn</a> *&#160;</td>
+          <td class="paramtype"><a class="el" href="linkhash_8h.html#abcbf0e4849fb0c6279827ac3b66d15c3">lh_equal_fn</a> *&#160;</td>
           <td class="paramname"><em>equal_fn</em>&#160;</td>
         </tr>
         <tr>
@@ -742,8 +734,7 @@ Functions</h2></td></tr>
         </tr>
       </table>
 </div><div class="memdoc">
-<p>Create a new linkhash table. </p>
-<dl class="params"><dt>Parameters</dt><dd>
+<p>Create a new linkhash table. </p><dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
     <tr><td class="paramname">size</td><td>initial table size. The table is automatically resized although this incurs a performance penalty. </td></tr>
     <tr><td class="paramname">name</td><td>the table name. </td></tr>
@@ -796,8 +787,7 @@ Functions</h2></td></tr>
         </tr>
       </table>
 </div><div class="memdoc">
-<p>Lookup a record into the table </p>
-<dl class="params"><dt>Parameters</dt><dd>
+<p>Lookup a record into the table </p><dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
     <tr><td class="paramname">t</td><td>the table to lookup </td></tr>
     <tr><td class="paramname">k</td><td>a pointer to the key to lookup </td></tr>
@@ -812,9 +802,9 @@ Functions</h2></td></tr>
 </div><!-- contents -->
 <!-- start footer part -->
 <hr class="footer"/><address class="footer"><small>
-Generated on Thu Apr 10 2014 01:30:33 for json-c by &#160;<a href="http://www.doxygen.org/index.html">
+Generated on Tue Jun 7 2016 17:51:50 for json-c by &#160;<a href="http://www.doxygen.org/index.html">
 <img class="footer" src="doxygen.png" alt="doxygen"/>
-</a> 1.8.5
+</a> 1.8.9.1
 </small></address>
 </body>
 </html>