git.m6w6.name Git - awesomized/libmemcached/blob - libhashkit/hashkit_create.html

   1
   2
   3 <!DOCTYPE html>
   4 <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
   5 <!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
   6 <head>
   7   <meta charset="utf-8">
   8
   9   <meta name="viewport" content="width=device-width, initial-scale=1.0">
  10
  11   <title>Creating a hashkit structure &mdash; libmemcached-awesome 1.1.4 documentation</title>
  12
  13
  14
  15
  16
  17
  18
  19
  20   <script type="text/javascript" src="../_static/js/modernizr.min.js"></script>
  21
  22
  23       <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
  24         <script type="text/javascript" src="../_static/jquery.js"></script>
  25         <script type="text/javascript" src="../_static/underscore.js"></script>
  26         <script type="text/javascript" src="../_static/doctools.js"></script>
  27         <script type="text/javascript" src="../_static/language_data.js"></script>
  28
  29     <script type="text/javascript" src="../_static/js/theme.js"></script>
  30
  31
  32
  33
  34   <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
  35   <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
  36     <link rel="index" title="Index" href="../genindex.html" />
  37     <link rel="search" title="Search" href="../search.html" />
  38     <link rel="copyright" title="Copyright" href="../copyright.html" />
  39     <link rel="next" title="Set Hash Function" href="hashkit_function.html" />
  40     <link rel="prev" title="libhashkit - C/C++ hashing library" href="index.html" />
  41 </head>
  42
  43 <body class="wy-body-for-nav">
  44
  45
  46   <div class="wy-grid-for-nav">
  47
  48     <nav data-toggle="wy-nav-shift" class="wy-nav-side">
  49       <div class="wy-side-scroll">
  50         <div class="wy-side-nav-search" >
  51
  52
  53
  54             <a href="../index.html" class="icon icon-home"> libmemcached-awesome
  55
  56
  57
  58           </a>
  59
  60
  61
  62
  63               <div class="version">
  64                 1.1
  65               </div>
  66
  67
  68
  69
  70 <div role="search">
  71   <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
  72     <input type="text" name="q" placeholder="Search docs" />
  73     <input type="hidden" name="check_keywords" value="yes" />
  74     <input type="hidden" name="area" value="default" />
  75   </form>
  76 </div>
  77
  78
  79         </div>
  80
  81         <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
  82
  83
  84
  85
  86
  87
  88               <ul class="current">
  89 <li class="toctree-l1"><a class="reference internal" href="../libmemcached.html">Introduction</a></li>
  90 <li class="toctree-l1"><a class="reference internal" href="../libmemcached/index.html">libmemcached API</a></li>
  91 <li class="toctree-l1"><a class="reference internal" href="../libmemcachedutil/index.html">libmemcachedutil API</a></li>
  92 <li class="toctree-l1 current"><a class="reference internal" href="index.html">libhashkit API</a><ul class="current">
  93 <li class="toctree-l2 current"><a class="current reference internal" href="#">Creating a hashkit structure</a></li>
  94 <li class="toctree-l2"><a class="reference internal" href="hashkit_function.html">Set Hash Function</a></li>
  95 <li class="toctree-l2"><a class="reference internal" href="hashkit_functions.html">Available Hashes</a></li>
  96 <li class="toctree-l2"><a class="reference internal" href="hashkit_value.html">Generate hash value</a></li>
  97 </ul>
  98 </li>
  99 <li class="toctree-l1"><a class="reference internal" href="../bin/index.html">Client Applications</a></li>
 100 <li class="toctree-l1"><a class="reference internal" href="../libmemcached/index_misc.html">Miscellaneous</a></li>
 101 </ul>
 102 <ul>
 103 <li class="toctree-l1"><a class="reference internal" href="../changelogs.html">Change Logs</a></li>
 104 <li class="toctree-l1"><a class="reference internal" href="../issues.html">Known issues</a></li>
 105 <li class="toctree-l1"><a class="reference internal" href="../copyright.html">Copyright</a></li>
 106 </ul>
 107
 108
 109
 110         </div>
 111       </div>
 112     </nav>
 113
 114     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
 115
 116
 117       <nav class="wy-nav-top" aria-label="top navigation">
 118
 119           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
 120           <a href="../index.html">libmemcached-awesome</a>
 121
 122       </nav>
 123
 124
 125       <div class="wy-nav-content">
 126
 127         <div class="rst-content">
 128
 129
 130
 131
 132
 133
 134
 135
 136
 137
 138
 139
 140
 141
 142
 143
 144
 145 <div role="navigation" aria-label="breadcrumbs navigation">
 146
 147   <ul class="wy-breadcrumbs">
 148
 149       <li><a href="../index.html">Docs</a> &raquo;</li>
 150
 151           <li><a href="index.html">libhashkit - C/C++ hashing library</a> &raquo;</li>
 152
 153       <li>Creating a hashkit structure</li>
 154
 155
 156       <li class="wy-breadcrumbs-aside">
 157
 158
 159
 160               <a href="https://github.com/awesomized/libmemcached/blob/v1.x/docs/source/libhashkit/hashkit_create.rst" class="fa fa-github"> Edit on GitHub</a>
 161
 162
 163
 164       </li>
 165
 166   </ul>
 167
 168
 169   <hr/>
 170 </div>
 171           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
 172            <div itemprop="articleBody">
 173
 174   <div class="section" id="creating-a-hashkit-structure">
 175 <h1>Creating a hashkit structure<a class="headerlink" href="#creating-a-hashkit-structure" title="Permalink to this headline">¶</a></h1>
 176 <div class="section" id="synopsis">
 177 <h2>SYNOPSIS<a class="headerlink" href="#synopsis" title="Permalink to this headline">¶</a></h2>
 178 <dl class="docutils">
 179 <dt>#include &lt;libhashkit-1.0/hashkit.h&gt;</dt>
 180 <dd>Compile and link with -lhashkit</dd>
 181 </dl>
 182 <dl class="type">
 183 <dt id="_CPPv410hashkit_st">
 184 <span id="_CPPv310hashkit_st"></span><span id="_CPPv210hashkit_st"></span><span id="hashkit_st"></span><em class="property">typedef </em><em class="property">struct</em> <a class="reference internal" href="#_CPPv410hashkit_st" title="hashkit_st">hashkit_st</a> <code class="descname">hashkit_st</code><a class="headerlink" href="#_CPPv410hashkit_st" title="Permalink to this definition">¶</a><br /></dt>
 185 <dd></dd></dl>
 186
 187 <dl class="function">
 188 <dt id="_CPPv414hashkit_createP10hashkit_st">
 189 <span id="_CPPv314hashkit_createP10hashkit_st"></span><span id="_CPPv214hashkit_createP10hashkit_st"></span><span id="hashkit_create__hashkit_stP"></span><a class="reference internal" href="#_CPPv410hashkit_st" title="hashkit_st">hashkit_st</a> *<code class="descname">hashkit_create</code><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv410hashkit_st" title="hashkit_st">hashkit_st</a> *<em>hash</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv414hashkit_createP10hashkit_st" title="Permalink to this definition">¶</a><br /></dt>
 190 <dd><table class="docutils field-list" frame="void" rules="none">
 191 <col class="field-name" />
 192 <col class="field-body" />
 193 <tbody valign="top">
 194 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>hash</strong> -- memory address of a <a class="reference internal" href="#_CPPv410hashkit_st" title="hashkit_st"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">hashkit_st</span></code></a> struct;
 195 if a nullptr is passed, the struct will be dynamically allocated by libhashkit</td>
 196 </tr>
 197 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">pointer to initialized <a class="reference internal" href="#_CPPv410hashkit_st" title="hashkit_st"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">hashkit_st</span></code></a> structure</td>
 198 </tr>
 199 </tbody>
 200 </table>
 201 </dd></dl>
 202
 203 <dl class="function">
 204 <dt id="_CPPv413hashkit_cloneP10hashkit_stPK10hashkit_st">
 205 <span id="_CPPv313hashkit_cloneP10hashkit_stPK10hashkit_st"></span><span id="_CPPv213hashkit_cloneP10hashkit_stPK10hashkit_st"></span><span id="hashkit_clone__hashkit_stP.hashkit_stCP"></span><a class="reference internal" href="#_CPPv410hashkit_st" title="hashkit_st">hashkit_st</a> *<code class="descname">hashkit_clone</code><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv410hashkit_st" title="hashkit_st">hashkit_st</a> *<em>destination</em>, <em class="property">const</em> <a class="reference internal" href="#_CPPv410hashkit_st" title="hashkit_st">hashkit_st</a> *<em>ptr</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv413hashkit_cloneP10hashkit_stPK10hashkit_st" title="Permalink to this definition">¶</a><br /></dt>
 206 <dd><table class="docutils field-list" frame="void" rules="none">
 207 <col class="field-name" />
 208 <col class="field-body" />
 209 <tbody valign="top">
 210 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
 211 <li><strong>destination</strong> -- memory address of a <a class="reference internal" href="#_CPPv410hashkit_st" title="hashkit_st"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">hashkit_st</span></code></a> struct;
 212 if a nullptr is passed, the struct will be dynamically allocated by libhashkit</li>
 213 <li><strong>ptr</strong> -- pointer of the <a class="reference internal" href="#_CPPv410hashkit_st" title="hashkit_st"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">hashkit_st</span></code></a> struct to copy</li>
 214 </ul>
 215 </td>
 216 </tr>
 217 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">pointer to a <a class="reference internal" href="#_CPPv410hashkit_st" title="hashkit_st"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">hashkit_st</span></code></a> structure (<a class="reference internal" href="#_CPPv413hashkit_cloneP10hashkit_stPK10hashkit_st" title="hashkit_clone::destination"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">destination</span></code></a>, if not nullptr), initialized from <a class="reference internal" href="#_CPPv413hashkit_cloneP10hashkit_stPK10hashkit_st" title="hashkit_clone::ptr"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">ptr</span></code></a></p>
 218 </td>
 219 </tr>
 220 </tbody>
 221 </table>
 222 </dd></dl>
 223
 224 <dl class="function">
 225 <dt id="_CPPv412hashkit_freeP10hashkit_st">
 226 <span id="_CPPv312hashkit_freeP10hashkit_st"></span><span id="_CPPv212hashkit_freeP10hashkit_st"></span><span id="hashkit_free__hashkit_stP"></span>void <code class="descname">hashkit_free</code><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv410hashkit_st" title="hashkit_st">hashkit_st</a> *<em>hash</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv412hashkit_freeP10hashkit_st" title="Permalink to this definition">¶</a><br /></dt>
 227 <dd><table class="docutils field-list" frame="void" rules="none">
 228 <col class="field-name" />
 229 <col class="field-body" />
 230 <tbody valign="top">
 231 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>hash</strong> -- pointer to an initialized <a class="reference internal" href="#_CPPv410hashkit_st" title="hashkit_st"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">hashkit_st</span></code></a> struct</td>
 232 </tr>
 233 </tbody>
 234 </table>
 235 </dd></dl>
 236
 237 <dl class="function">
 238 <dt id="_CPPv420hashkit_is_allocatedPK10hashkit_st">
 239 <span id="_CPPv320hashkit_is_allocatedPK10hashkit_st"></span><span id="_CPPv220hashkit_is_allocatedPK10hashkit_st"></span><span id="hashkit_is_allocated__hashkit_stCP"></span>bool <code class="descname">hashkit_is_allocated</code><span class="sig-paren">(</span><em class="property">const</em> <a class="reference internal" href="#_CPPv410hashkit_st" title="hashkit_st">hashkit_st</a> *<em>hash</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv420hashkit_is_allocatedPK10hashkit_st" title="Permalink to this definition">¶</a><br /></dt>
 240 <dd><table class="docutils field-list" frame="void" rules="none">
 241 <col class="field-name" />
 242 <col class="field-body" />
 243 <tbody valign="top">
 244 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>hash</strong> -- pointer to an initialized <a class="reference internal" href="#_CPPv410hashkit_st" title="hashkit_st"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">hashkit_st</span></code></a> struct</td>
 245 </tr>
 246 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">bool, whether the <a class="reference internal" href="#_CPPv420hashkit_is_allocatedPK10hashkit_st" title="hashkit_is_allocated::hash"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">hash</span></code></a> struct was dynamically allocated</td>
 247 </tr>
 248 </tbody>
 249 </table>
 250 </dd></dl>
 251
 252 </div>
 253 <div class="section" id="description">
 254 <h2>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
 255 <p>The <a class="reference internal" href="#_CPPv414hashkit_createP10hashkit_st" title="hashkit_create"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">hashkit_create()</span></code></a> function initializes a hashkit object for use. If you pass
 256 a nullptr argument for hash, then the memory for the object is allocated. If you
 257 specify a pre-allocated piece of memory, that is initialized for use.</p>
 258 <p>The <a class="reference internal" href="#_CPPv413hashkit_cloneP10hashkit_stPK10hashkit_st" title="hashkit_clone"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">hashkit_clone()</span></code></a> function initializes a hashkit object much like
 259 <a class="reference internal" href="#_CPPv414hashkit_createP10hashkit_st" title="hashkit_create"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">hashkit_create()</span></code></a>, but instead of using default settings it will use the settings
 260 of the ptr hashkit object.</p>
 261 <p>The <a class="reference internal" href="#_CPPv412hashkit_freeP10hashkit_st" title="hashkit_free"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">hashkit_free()</span></code></a> frees any resources being consumed by the hashkit objects
 262 that were initialized with <a class="reference internal" href="#_CPPv414hashkit_createP10hashkit_st" title="hashkit_create"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">hashkit_create()</span></code></a> or <a class="reference internal" href="#_CPPv413hashkit_cloneP10hashkit_stPK10hashkit_st" title="hashkit_clone"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">hashkit_clone()</span></code></a>.</p>
 263 <p>The <a class="reference internal" href="#_CPPv420hashkit_is_allocatedPK10hashkit_st" title="hashkit_is_allocated"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">hashkit_is_allocated()</span></code></a> reports whether the memory was allocated for a hashkit
 264 object.</p>
 265 </div>
 266 <div class="section" id="return-value">
 267 <h2>RETURN VALUE<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2>
 268 <p><a class="reference internal" href="#_CPPv414hashkit_createP10hashkit_st" title="hashkit_create"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">hashkit_create()</span></code></a> and <a class="reference internal" href="#_CPPv413hashkit_cloneP10hashkit_stPK10hashkit_st" title="hashkit_clone"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">hashkit_clone()</span></code></a> will return nullptr on failure or pointer
 269 to <a class="reference internal" href="#_CPPv410hashkit_st" title="hashkit_st"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">hashkit_st</span></code></a> on success.</p>
 270 <p><a class="reference internal" href="#_CPPv420hashkit_is_allocatedPK10hashkit_st" title="hashkit_is_allocated"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">hashkit_is_allocated()</span></code></a> returns true if the memory for the hashkit object was
 271 allocated inside of <a class="reference internal" href="#_CPPv414hashkit_createP10hashkit_st" title="hashkit_create"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">hashkit_create()</span></code></a> or <a class="reference internal" href="#_CPPv413hashkit_cloneP10hashkit_stPK10hashkit_st" title="hashkit_clone"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">hashkit_clone()</span></code></a>, otherwise it is false
 272 and was user-supplied memory.</p>
 273 </div>
 274 <div class="section" id="see-also">
 275 <h2>SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline">¶</a></h2>
 276 <ul class="simple">
 277 <li><a class="reference internal" href="index.html"><span class="doc">libhashkit - C/C++ hashing library</span></a></li>
 278 <li><a class="reference internal" href="hashkit_value.html"><span class="doc">Generate hash value</span></a></li>
 279 <li><a class="reference internal" href="hashkit_function.html"><span class="doc">Set Hash Function</span></a></li>
 280 </ul>
 281 </div>
 282 </div>
 283
 284
 285            </div>
 286
 287           </div>
 288           <footer>
 289
 290     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
 291
 292         <a href="hashkit_function.html" class="btn btn-neutral float-right" title="Set Hash Function" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
 293
 294
 295         <a href="index.html" class="btn btn-neutral float-left" title="libhashkit - C/C++ hashing library" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
 296
 297     </div>
 298
 299
 300   <hr/>
 301
 302   <div role="contentinfo">
 303     <p>
 304         &copy; <a href="../copyright.html">Copyright</a>
 305
 306     </p>
 307   </div>
 308   Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
 309
 310 </footer>
 311
 312         </div>
 313       </div>
 314
 315     </section>
 316
 317   </div>
 318
 319
 320
 321   <script type="text/javascript">
 322       jQuery(function () {
 323           SphinxRtdTheme.Navigation.enable(true);
 324       });
 325   </script>
 326
 327
 328
 329
 330
 331
 332 </body>
 333 </html>