git.m6w6.name Git - m6w6/libmemcached/blob - libmemcached/memcached_generate_hash_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>Generating hash values directly &mdash; libmemcached 1.0.99 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 src="../_static/jquery.js"></script>
  25         <script src="../_static/underscore.js"></script>
  26         <script src="../_static/doctools.js"></script>
  27         <script 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="SASL support" href="memcached_sasl.html" />
  40     <link rel="prev" title="Set encryption key" href="memcached_set_encoding_key.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.0
  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               <p class="caption"><span class="caption-text">libmemcached</span></p>
  89 <ul class="current">
  90 <li class="toctree-l1"><a class="reference internal" href="../libmemcached.html">Introduction</a></li>
  91 <li class="toctree-l1 current"><a class="reference internal" href="index.html">libmemcached API</a><ul class="current">
  92 <li class="toctree-l2"><a class="reference internal" href="index_basics.html">Basics</a></li>
  93 <li class="toctree-l2"><a class="reference internal" href="index_data.html">Working with Data</a></li>
  94 <li class="toctree-l2"><a class="reference internal" href="index_errors.html">Messages and Errors</a></li>
  95 <li class="toctree-l2 current"><a class="reference internal" href="index_advanced.html">Advanced Topics</a></li>
  96 <li class="toctree-l2"><a class="reference internal" href="index_deprecated.html">Deprecated Functionality</a></li>
  97 </ul>
  98 </li>
  99 <li class="toctree-l1"><a class="reference internal" href="index_misc.html">Misc</a><ul>
 100 <li class="toctree-l2"><a class="reference internal" href="configuration.html">Configuration</a></li>
 101 <li class="toctree-l2"><a class="reference internal" href="constants.html">Constants</a></li>
 102 <li class="toctree-l2"><a class="reference internal" href="examples.html">Examples</a></li>
 103 <li class="toctree-l2"><a class="reference internal" href="versioning.html">Versioning</a></li>
 104 </ul>
 105 </li>
 106 </ul>
 107 <p class="caption"><span class="caption-text">libmemcachedutil</span></p>
 108 <ul>
 109 <li class="toctree-l1"><a class="reference internal" href="../libmemcachedutil.html">Introduction</a></li>
 110 <li class="toctree-l1"><a class="reference internal" href="../libmemcachedutil/index.html">libmemcachedutil API</a><ul>
 111 <li class="toctree-l2"><a class="reference internal" href="../libmemcachedutil/memcached_pool.html">Working with memcached pools</a></li>
 112 </ul>
 113 </li>
 114 </ul>
 115 <p class="caption"><span class="caption-text">libhashkit</span></p>
 116 <ul>
 117 <li class="toctree-l1"><a class="reference internal" href="../libhashkit.html">Introduction</a></li>
 118 <li class="toctree-l1"><a class="reference internal" href="../libhashkit/index.html">libhashkit API</a><ul>
 119 <li class="toctree-l2"><a class="reference internal" href="../libhashkit/hashkit_create.html">Creating a hashkit structure</a></li>
 120 <li class="toctree-l2"><a class="reference internal" href="../libhashkit/hashkit_function.html">Set Hash Function</a></li>
 121 <li class="toctree-l2"><a class="reference internal" href="../libhashkit/hashkit_functions.html">Available Hashes</a></li>
 122 <li class="toctree-l2"><a class="reference internal" href="../libhashkit/hashkit_value.html">Generate hash value</a></li>
 123 </ul>
 124 </li>
 125 </ul>
 126 <p class="caption"><span class="caption-text">Client Applications</span></p>
 127 <ul>
 128 <li class="toctree-l1"><a class="reference internal" href="../bin/index.html">Client Applications</a><ul>
 129 <li class="toctree-l2"><a class="reference internal" href="../bin/memcapable.html">memcapable - Checking a Memcached server capabilities and compatibility</a></li>
 130 <li class="toctree-l2"><a class="reference internal" href="../bin/memcat.html">memcat - “cat” data from a server</a></li>
 131 <li class="toctree-l2"><a class="reference internal" href="../bin/memcp.html">memcp - Copy data to a server</a></li>
 132 <li class="toctree-l2"><a class="reference internal" href="../bin/memdump.html">memdump - Dumping your server</a></li>
 133 <li class="toctree-l2"><a class="reference internal" href="../bin/memerror.html">memerror - translate an error code to a string</a></li>
 134 <li class="toctree-l2"><a class="reference internal" href="../bin/memflush.html">memflush - flush all data from a server</a></li>
 135 <li class="toctree-l2"><a class="reference internal" href="../bin/memrm.html">memrm - Remove data from a server</a></li>
 136 <li class="toctree-l2"><a class="reference internal" href="../bin/memslap.html">memslap - Load testing  and benchmarking a server</a></li>
 137 <li class="toctree-l2"><a class="reference internal" href="../bin/memaslap.html">memaslap - Load testing  and benchmarking a server</a></li>
 138 <li class="toctree-l2"><a class="reference internal" href="../bin/memstat.html">memstat - Gather statistics from a server</a></li>
 139 <li class="toctree-l2"><a class="reference internal" href="../bin/memexist.html">memexist - Check for the existence of a key</a></li>
 140 <li class="toctree-l2"><a class="reference internal" href="../bin/memparse.html">memparse - Parse an option string</a></li>
 141 <li class="toctree-l2"><a class="reference internal" href="../bin/memping.html">memping - Test to see if a server is available.</a></li>
 142 <li class="toctree-l2"><a class="reference internal" href="../bin/memtouch.html">memtouch - Touches a key.</a></li>
 143 </ul>
 144 </li>
 145 </ul>
 146
 147
 148
 149         </div>
 150       </div>
 151     </nav>
 152
 153     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
 154
 155
 156       <nav class="wy-nav-top" aria-label="top navigation">
 157
 158           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
 159           <a href="../index.html">libmemcached</a>
 160
 161       </nav>
 162
 163
 164       <div class="wy-nav-content">
 165
 166         <div class="rst-content">
 167
 168
 169
 170
 171
 172
 173
 174
 175
 176
 177
 178
 179
 180
 181
 182
 183
 184 <div role="navigation" aria-label="breadcrumbs navigation">
 185
 186   <ul class="wy-breadcrumbs">
 187
 188       <li><a href="../index.html">Docs</a> &raquo;</li>
 189
 190           <li><a href="index.html">libmemcached API</a> &raquo;</li>
 191
 192           <li><a href="index_advanced.html">Advanced Topics</a> &raquo;</li>
 193
 194           <li><a href="index_advanced_aeh.html">Authentication, Encryption &amp; Hashing</a> &raquo;</li>
 195
 196       <li>Generating hash values directly</li>
 197
 198
 199       <li class="wy-breadcrumbs-aside">
 200
 201
 202
 203       </li>
 204
 205   </ul>
 206
 207
 208   <hr/>
 209 </div>
 210           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
 211            <div itemprop="articleBody">
 212
 213   <div class="section" id="generating-hash-values-directly">
 214 <h1>Generating hash values directly<a class="headerlink" href="#generating-hash-values-directly" title="Permalink to this headline">¶</a></h1>
 215 <p id="index-0">Hash a key value</p>
 216 <div class="section" id="synopsis">
 217 <h2>SYNOPSIS<a class="headerlink" href="#synopsis" title="Permalink to this headline">¶</a></h2>
 218 <p>#include &lt;libmemcached/memcached.h&gt;</p>
 219 <dl class="type">
 220 <dt id="_CPPv416memcached_hash_t">
 221 <span id="_CPPv316memcached_hash_t"></span><span id="_CPPv216memcached_hash_t"></span><span id="memcached_hash_t"></span><em class="property">type </em><code class="sig-name descname">memcached_hash_t</code><a class="headerlink" href="#_CPPv416memcached_hash_t" title="Permalink to this definition">¶</a><br /></dt>
 222 <dd></dd></dl>
 223
 224 <dl class="function">
 225 <dt id="_CPPv429memcached_generate_hash_valuePKc6size_t16memcached_hash_t">
 226 <span id="_CPPv329memcached_generate_hash_valuePKc6size_t16memcached_hash_t"></span><span id="_CPPv229memcached_generate_hash_valuePKc6size_t16memcached_hash_t"></span><span id="memcached_generate_hash_value__cCP.s.memcached_hash_t"></span>uint32_t <code class="sig-name descname">memcached_generate_hash_value</code><span class="sig-paren">(</span><em class="property">const</em> char *<em>key</em>, size_t <em>key_length</em>, <a class="reference internal" href="#_CPPv416memcached_hash_t" title="memcached_hash_t">memcached_hash_t</a> <em>hash_algorithm</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv429memcached_generate_hash_valuePKc6size_t16memcached_hash_t" title="Permalink to this definition">¶</a><br /></dt>
 227 <dd></dd></dl>
 228
 229 <dl class="function">
 230 <dt id="_CPPv423memcached_generate_hashP12memcached_stPKc6size_t">
 231 <span id="_CPPv323memcached_generate_hashP12memcached_stPKc6size_t"></span><span id="_CPPv223memcached_generate_hashP12memcached_stPKc6size_t"></span><span id="memcached_generate_hash__memcached_stP.cCP.s"></span>uint32_t <code class="sig-name descname">memcached_generate_hash</code><span class="sig-paren">(</span><a class="reference internal" href="memcached_create.html#_CPPv412memcached_st" title="memcached_st">memcached_st</a> *<em>ptr</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="#_CPPv423memcached_generate_hashP12memcached_stPKc6size_t" title="Permalink to this definition">¶</a><br /></dt>
 232 <dd></dd></dl>
 233
 234 <dl class="type">
 235 <dt id="_CPPv422MEMCACHED_HASH_DEFAULT">
 236 <span id="_CPPv322MEMCACHED_HASH_DEFAULT"></span><span id="_CPPv222MEMCACHED_HASH_DEFAULT"></span><span id="MEMCACHED_HASH_DEFAULT"></span><em class="property">type </em><code class="sig-name descname">MEMCACHED_HASH_DEFAULT</code><a class="headerlink" href="#_CPPv422MEMCACHED_HASH_DEFAULT" title="Permalink to this definition">¶</a><br /></dt>
 237 <dd></dd></dl>
 238
 239 <dl class="type">
 240 <dt id="_CPPv418MEMCACHED_HASH_MD5">
 241 <span id="_CPPv318MEMCACHED_HASH_MD5"></span><span id="_CPPv218MEMCACHED_HASH_MD5"></span><span id="MEMCACHED_HASH_MD5"></span><em class="property">type </em><code class="sig-name descname">MEMCACHED_HASH_MD5</code><a class="headerlink" href="#_CPPv418MEMCACHED_HASH_MD5" title="Permalink to this definition">¶</a><br /></dt>
 242 <dd></dd></dl>
 243
 244 <dl class="type">
 245 <dt id="_CPPv418MEMCACHED_HASH_CRC">
 246 <span id="_CPPv318MEMCACHED_HASH_CRC"></span><span id="_CPPv218MEMCACHED_HASH_CRC"></span><span id="MEMCACHED_HASH_CRC"></span><em class="property">type </em><code class="sig-name descname">MEMCACHED_HASH_CRC</code><a class="headerlink" href="#_CPPv418MEMCACHED_HASH_CRC" title="Permalink to this definition">¶</a><br /></dt>
 247 <dd></dd></dl>
 248
 249 <dl class="type">
 250 <dt id="_CPPv422MEMCACHED_HASH_FNV1_64">
 251 <span id="_CPPv322MEMCACHED_HASH_FNV1_64"></span><span id="_CPPv222MEMCACHED_HASH_FNV1_64"></span><span id="MEMCACHED_HASH_FNV1_64"></span><em class="property">type </em><code class="sig-name descname">MEMCACHED_HASH_FNV1_64</code><a class="headerlink" href="#_CPPv422MEMCACHED_HASH_FNV1_64" title="Permalink to this definition">¶</a><br /></dt>
 252 <dd></dd></dl>
 253
 254 <dl class="type">
 255 <dt id="_CPPv423MEMCACHED_HASH_FNV1A_64">
 256 <span id="_CPPv323MEMCACHED_HASH_FNV1A_64"></span><span id="_CPPv223MEMCACHED_HASH_FNV1A_64"></span><span id="MEMCACHED_HASH_FNV1A_64"></span><em class="property">type </em><code class="sig-name descname">MEMCACHED_HASH_FNV1A_64</code><a class="headerlink" href="#_CPPv423MEMCACHED_HASH_FNV1A_64" title="Permalink to this definition">¶</a><br /></dt>
 257 <dd></dd></dl>
 258
 259 <dl class="type">
 260 <dt id="_CPPv422MEMCACHED_HASH_FNV1_32">
 261 <span id="_CPPv322MEMCACHED_HASH_FNV1_32"></span><span id="_CPPv222MEMCACHED_HASH_FNV1_32"></span><span id="MEMCACHED_HASH_FNV1_32"></span><em class="property">type </em><code class="sig-name descname">MEMCACHED_HASH_FNV1_32</code><a class="headerlink" href="#_CPPv422MEMCACHED_HASH_FNV1_32" title="Permalink to this definition">¶</a><br /></dt>
 262 <dd></dd></dl>
 263
 264 <dl class="type">
 265 <dt id="_CPPv423MEMCACHED_HASH_FNV1A_32">
 266 <span id="_CPPv323MEMCACHED_HASH_FNV1A_32"></span><span id="_CPPv223MEMCACHED_HASH_FNV1A_32"></span><span id="MEMCACHED_HASH_FNV1A_32"></span><em class="property">type </em><code class="sig-name descname">MEMCACHED_HASH_FNV1A_32</code><a class="headerlink" href="#_CPPv423MEMCACHED_HASH_FNV1A_32" title="Permalink to this definition">¶</a><br /></dt>
 267 <dd></dd></dl>
 268
 269 <dl class="type">
 270 <dt id="_CPPv422MEMCACHED_HASH_JENKINS">
 271 <span id="_CPPv322MEMCACHED_HASH_JENKINS"></span><span id="_CPPv222MEMCACHED_HASH_JENKINS"></span><span id="MEMCACHED_HASH_JENKINS"></span><em class="property">type </em><code class="sig-name descname">MEMCACHED_HASH_JENKINS</code><a class="headerlink" href="#_CPPv422MEMCACHED_HASH_JENKINS" title="Permalink to this definition">¶</a><br /></dt>
 272 <dd></dd></dl>
 273
 274 <dl class="type">
 275 <dt id="_CPPv421MEMCACHED_HASH_MURMUR">
 276 <span id="_CPPv321MEMCACHED_HASH_MURMUR"></span><span id="_CPPv221MEMCACHED_HASH_MURMUR"></span><span id="MEMCACHED_HASH_MURMUR"></span><em class="property">type </em><code class="sig-name descname">MEMCACHED_HASH_MURMUR</code><a class="headerlink" href="#_CPPv421MEMCACHED_HASH_MURMUR" title="Permalink to this definition">¶</a><br /></dt>
 277 <dd></dd></dl>
 278
 279 <dl class="type">
 280 <dt id="_CPPv420MEMCACHED_HASH_HSIEH">
 281 <span id="_CPPv320MEMCACHED_HASH_HSIEH"></span><span id="_CPPv220MEMCACHED_HASH_HSIEH"></span><span id="MEMCACHED_HASH_HSIEH"></span><em class="property">type </em><code class="sig-name descname">MEMCACHED_HASH_HSIEH</code><a class="headerlink" href="#_CPPv420MEMCACHED_HASH_HSIEH" title="Permalink to this definition">¶</a><br /></dt>
 282 <dd></dd></dl>
 283
 284 <dl class="type">
 285 <dt id="_CPPv422MEMCACHED_HASH_MURMUR3">
 286 <span id="_CPPv322MEMCACHED_HASH_MURMUR3"></span><span id="_CPPv222MEMCACHED_HASH_MURMUR3"></span><span id="MEMCACHED_HASH_MURMUR3"></span><em class="property">type </em><code class="sig-name descname">MEMCACHED_HASH_MURMUR3</code><a class="headerlink" href="#_CPPv422MEMCACHED_HASH_MURMUR3" title="Permalink to this definition">¶</a><br /></dt>
 287 <dd></dd></dl>
 288
 289 <p>Compile and link with -lmemcachedutil -lmemcached</p>
 290 </div>
 291 <div class="section" id="description">
 292 <h2>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
 293 <p><a class="reference internal" href="#_CPPv429memcached_generate_hash_valuePKc6size_t16memcached_hash_t" title="memcached_generate_hash_value"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_generate_hash_value()</span></code></a> allows you to hash a key using one of
 294 the hash functions defined in the library. This method is provided for
 295 the convenience of higher-level language bindings and is not necessary
 296 for normal memcache operations.</p>
 297 <p>The allowed hash algorithm constants are listed in the manpage for
 298 <a class="reference internal" href="memcached_behavior.html#_CPPv422memcached_behavior_setP12memcached_st20memcached_behavior_t8uint64_t" title="memcached_behavior_set"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_behavior_set()</span></code></a>.</p>
 299 <p><a class="reference internal" href="#_CPPv423memcached_generate_hashP12memcached_stPKc6size_t" title="memcached_generate_hash"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_generate_hash()</span></code></a> takes a <a class="reference internal" href="memcached_create.html#_CPPv412memcached_st" title="memcached_st"><code class="xref cpp cpp-type docutils literal notranslate"><span class="pre">memcached_st</span></code></a> structure
 300 and produces the hash value that would have been generated based on the
 301 defaults of <a class="reference internal" href="memcached_create.html#_CPPv412memcached_st" title="memcached_st"><code class="xref cpp cpp-type docutils literal notranslate"><span class="pre">memcached_st</span></code></a>.</p>
 302 <p>As of version 0.36 all hash methods have been placed into the library
 303 libhashkit(3) which is linked with libmemcached(3). For more information please see its documentation.</p>
 304 </div>
 305 <div class="section" id="return">
 306 <h2>RETURN<a class="headerlink" href="#return" title="Permalink to this headline">¶</a></h2>
 307 <p>A 32-bit integer which is the result of hashing the given key.
 308 For 64-bit hash algorithms, only the least-significant 32 bits are
 309 returned.</p>
 310 </div>
 311 <div class="section" id="see-also">
 312 <h2>SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline">¶</a></h2>
 313 </div>
 314 </div>
 315
 316
 317            </div>
 318
 319           </div>
 320           <footer>
 321
 322     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
 323
 324         <a href="memcached_sasl.html" class="btn btn-neutral float-right" title="SASL support" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
 325
 326
 327         <a href="memcached_set_encoding_key.html" class="btn btn-neutral float-left" title="Set encryption key" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
 328
 329     </div>
 330
 331
 332   <hr/>
 333
 334   <div role="contentinfo">
 335     <p>
 336         &copy; <a href="../copyright.html">Copyright</a>
 337
 338     </p>
 339   </div>
 340   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>.
 341
 342 </footer>
 343
 344         </div>
 345       </div>
 346
 347     </section>
 348
 349   </div>
 350
 351
 352
 353   <script type="text/javascript">
 354       jQuery(function () {
 355           SphinxRtdTheme.Navigation.enable(true);
 356       });
 357   </script>
 358
 359
 360
 361
 362
 363
 364 </body>
 365 </html>