git.m6w6.name Git - m6w6/libmemcached/blob - libhashkit/hashkit_value.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>Generate hash value &mdash; libmemcached 1.1.0 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="Client Applications" href="../bin/index.html" />
  40     <link rel="prev" title="Available Hashes" href="hashkit_functions.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
  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"><a class="reference internal" href="hashkit_create.html">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 current"><a class="current reference internal" href="#">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="../copyright.html">Copyright</a></li>
 105 </ul>
 106
 107
 108
 109         </div>
 110       </div>
 111     </nav>
 112
 113     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
 114
 115
 116       <nav class="wy-nav-top" aria-label="top navigation">
 117
 118           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
 119           <a href="../index.html">libmemcached</a>
 120
 121       </nav>
 122
 123
 124       <div class="wy-nav-content">
 125
 126         <div class="rst-content">
 127
 128
 129
 130
 131
 132
 133
 134
 135
 136
 137
 138
 139
 140
 141
 142
 143
 144 <div role="navigation" aria-label="breadcrumbs navigation">
 145
 146   <ul class="wy-breadcrumbs">
 147
 148       <li><a href="../index.html">Docs</a> &raquo;</li>
 149
 150           <li><a href="index.html">libhashkit - C/C++ hashing library</a> &raquo;</li>
 151
 152       <li>Generate hash value</li>
 153
 154
 155       <li class="wy-breadcrumbs-aside">
 156
 157
 158
 159               <a href="https://github.com/m6w6/libmemcached/blob/v1.x/docs/source/libhashkit/hashkit_value.rst" class="fa fa-github"> Edit on GitHub</a>
 160
 161
 162
 163       </li>
 164
 165   </ul>
 166
 167
 168   <hr/>
 169 </div>
 170           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
 171            <div itemprop="articleBody">
 172
 173   <div class="section" id="generate-hash-value">
 174 <h1>Generate hash value<a class="headerlink" href="#generate-hash-value" title="Permalink to this headline">¶</a></h1>
 175 <div class="section" id="synopsis">
 176 <h2>SYNOPSIS<a class="headerlink" href="#synopsis" title="Permalink to this headline">¶</a></h2>
 177 <dl class="docutils">
 178 <dt>#include &lt;libhashkit-1.0/hashkit.h&gt;</dt>
 179 <dd>Compile and link with -lhashkit</dd>
 180 </dl>
 181 <dl class="function">
 182 <dt id="_CPPv413hashkit_valueP10hashkit_stPKc6size_t">
 183 <span id="_CPPv313hashkit_valueP10hashkit_stPKc6size_t"></span><span id="_CPPv213hashkit_valueP10hashkit_stPKc6size_t"></span><span id="hashkit_value__hashkit_stP.cCP.s"></span>uint32_t <code class="descname">hashkit_value</code><span class="sig-paren">(</span><a class="reference internal" href="hashkit_create.html#_CPPv410hashkit_st" title="hashkit_st">hashkit_st</a> *<em>hash</em>, <em class="property">const</em> char *<em>key</em>, size_t <em>key_length</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv413hashkit_valueP10hashkit_stPKc6size_t" title="Permalink to this definition">¶</a><br /></dt>
 184 <dd><table class="docutils field-list" frame="void" rules="none">
 185 <col class="field-name" />
 186 <col class="field-body" />
 187 <tbody valign="top">
 188 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
 189 <li><strong>hash</strong> -- pointer to an initialized <a class="reference internal" href="hashkit_create.html#_CPPv410hashkit_st" title="hashkit_st"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">hashkit_st</span></code></a> struct</li>
 190 <li><strong>key</strong> -- the key to genereate a hash of</li>
 191 <li><strong>key_length</strong> -- the length of the <a class="reference internal" href="#_CPPv413hashkit_valueP10hashkit_stPKc6size_t" title="hashkit_value::key"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">key</span></code></a> without any terminating zero byte</li>
 192 </ul>
 193 </td>
 194 </tr>
 195 </tbody>
 196 </table>
 197 </dd></dl>
 198
 199 </div>
 200 <div class="section" id="description">
 201 <h2>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
 202 <p>The <a class="reference internal" href="#_CPPv413hashkit_valueP10hashkit_stPKc6size_t" title="hashkit_value"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">hashkit_value()</span></code></a> function generates a 32-bit hash value from the given key
 203 and key_length. The hash argument is an initialized hashkit object, and
 204 distribution type and hash function is used from this object while generating
 205 the value.</p>
 206 </div>
 207 <div class="section" id="return-value">
 208 <h2>RETURN VALUE<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2>
 209 <p>A 32-bit hash value.</p>
 210 </div>
 211 <div class="section" id="see-also">
 212 <h2>SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline">¶</a></h2>
 213 <ul class="simple">
 214 <li><a class="reference internal" href="index.html"><span class="doc">libhashkit - C/C++ hashing library</span></a></li>
 215 <li><a class="reference internal" href="hashkit_create.html"><span class="doc">Creating a hashkit structure</span></a></li>
 216 <li><a class="reference internal" href="hashkit_function.html"><span class="doc">Set Hash Function</span></a></li>
 217 <li><a class="reference internal" href="hashkit_functions.html"><span class="doc">Available Hashes</span></a></li>
 218 </ul>
 219 </div>
 220 </div>
 221
 222
 223            </div>
 224
 225           </div>
 226           <footer>
 227
 228     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
 229
 230         <a href="../bin/index.html" class="btn btn-neutral float-right" title="Client Applications" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
 231
 232
 233         <a href="hashkit_functions.html" class="btn btn-neutral float-left" title="Available Hashes" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
 234
 235     </div>
 236
 237
 238   <hr/>
 239
 240   <div role="contentinfo">
 241     <p>
 242         &copy; <a href="../copyright.html">Copyright</a>
 243
 244     </p>
 245   </div>
 246   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>.
 247
 248 </footer>
 249
 250         </div>
 251       </div>
 252
 253     </section>
 254
 255   </div>
 256
 257
 258
 259   <script type="text/javascript">
 260       jQuery(function () {
 261           SphinxRtdTheme.Navigation.enable(true);
 262       });
 263   </script>
 264
 265
 266
 267
 268
 269
 270 </body>
 271 </html>