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

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