Deploy to GitHub pages
[m6w6/libmemcached] / libmemcached / memcached_generate_hash_value.html
index 6d7e39234608ff4141f302946d7ad29f6c22b560..0fe2a170750e7743667dac72f08f95679fd160e8 100644 (file)
@@ -8,7 +8,7 @@
   
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
   
-  <title>Generating hash values directly &mdash; libmemcached 1.0.99 documentation</title>
+  <title>Generating hash values directly &mdash; libmemcached 1.1.0 documentation</title>
   
 
   
   
     
       <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
-        <script src="../_static/jquery.js"></script>
-        <script src="../_static/underscore.js"></script>
-        <script src="../_static/doctools.js"></script>
-        <script src="../_static/language_data.js"></script>
+        <script type="text/javascript" src="../_static/jquery.js"></script>
+        <script type="text/javascript" src="../_static/underscore.js"></script>
+        <script type="text/javascript" src="../_static/doctools.js"></script>
+        <script type="text/javascript" src="../_static/language_data.js"></script>
     
     <script type="text/javascript" src="../_static/js/theme.js"></script>
 
@@ -61,7 +61,7 @@
             
             
               <div class="version">
-                1.0
+                1.1
               </div>
             
           
               
             
             
-              <p class="caption"><span class="caption-text">libmemcached</span></p>
-<ul class="current">
+              <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="../libmemcached.html">Introduction</a></li>
 <li class="toctree-l1 current"><a class="reference internal" href="index.html">libmemcached API</a><ul class="current">
 <li class="toctree-l2"><a class="reference internal" href="index_basics.html">Basics</a></li>
 <li class="toctree-l2"><a class="reference internal" href="index_data.html">Working with Data</a></li>
 <li class="toctree-l2"><a class="reference internal" href="index_errors.html">Messages and Errors</a></li>
-<li class="toctree-l2 current"><a class="reference internal" href="index_advanced.html">Advanced Topics</a></li>
-<li class="toctree-l2"><a class="reference internal" href="index_deprecated.html">Deprecated Functionality</a></li>
-</ul>
-</li>
-<li class="toctree-l1"><a class="reference internal" href="index_misc.html">Misc</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="configuration.html">Configuration</a></li>
-<li class="toctree-l2"><a class="reference internal" href="constants.html">Constants</a></li>
-<li class="toctree-l2"><a class="reference internal" href="examples.html">Examples</a></li>
-<li class="toctree-l2"><a class="reference internal" href="versioning.html">Versioning</a></li>
+<li class="toctree-l2 current"><a class="reference internal" href="index_advanced.html">Advanced Topics</a><ul class="current">
+<li class="toctree-l3"><a class="reference internal" href="index_advanced_internals.html">Internal Behavior</a></li>
+<li class="toctree-l3 current"><a class="reference internal" href="index_advanced_aeh.html">Authentication, Encryption &amp; Hashing</a><ul class="current">
+<li class="toctree-l4"><a class="reference internal" href="memcached_set_encoding_key.html">Set encryption key</a></li>
+<li class="toctree-l4 current"><a class="current reference internal" href="#">Generating hash values directly</a></li>
+<li class="toctree-l4"><a class="reference internal" href="memcached_sasl.html">SASL support</a></li>
 </ul>
 </li>
-</ul>
-<p class="caption"><span class="caption-text">libmemcachedutil</span></p>
-<ul>
-<li class="toctree-l1"><a class="reference internal" href="../libmemcachedutil.html">Introduction</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../libmemcachedutil/index.html">libmemcachedutil API</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="../libmemcachedutil/memcached_pool.html">Working with memcached pools</a></li>
+<li class="toctree-l3"><a class="reference internal" href="index_advanced_servers.html">Servers and Server Lists</a></li>
+<li class="toctree-l3"><a class="reference internal" href="index_advanced_daemon.html">Affecting the memcached Daemon</a></li>
+<li class="toctree-l3"><a class="reference internal" href="index_advanced_stats.html">Statistics</a></li>
 </ul>
 </li>
-</ul>
-<p class="caption"><span class="caption-text">libhashkit</span></p>
-<ul>
-<li class="toctree-l1"><a class="reference internal" href="../libhashkit.html">Introduction</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../libhashkit/index.html">libhashkit API</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="../libhashkit/hashkit_create.html">Creating a hashkit structure</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../libhashkit/hashkit_function.html">Set Hash Function</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../libhashkit/hashkit_functions.html">Available Hashes</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../libhashkit/hashkit_value.html">Generate hash value</a></li>
+<li class="toctree-l2"><a class="reference internal" href="index_deprecated.html">Deprecated Functionality</a></li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="../libmemcachedutil/index.html">libmemcachedutil API</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../libhashkit/index.html">libhashkit API</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../bin/index.html">Client Applications</a></li>
+<li class="toctree-l1"><a class="reference internal" href="index_misc.html">Miscellaneous</a></li>
 </ul>
-<p class="caption"><span class="caption-text">Client Applications</span></p>
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="../bin/index.html">Client Applications</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="../bin/memcapable.html">memcapable - Checking a Memcached server capabilities and compatibility</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../bin/memcat.html">memcat - “cat” data from a server</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../bin/memcp.html">memcp - Copy data to a server</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../bin/memdump.html">memdump - Dumping your server</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../bin/memerror.html">memerror - translate an error code to a string</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../bin/memflush.html">memflush - flush all data from a server</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../bin/memrm.html">memrm - Remove data from a server</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../bin/memslap.html">memslap - Load testing  and benchmarking a server</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../bin/memaslap.html">memaslap - Load testing  and benchmarking a server</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../bin/memstat.html">memstat - Gather statistics from a server</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../bin/memexist.html">memexist - Check for the existence of a key</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../bin/memparse.html">memparse - Parse an option string</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../bin/memping.html">memping - Test to see if a server is available.</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../bin/memtouch.html">memtouch - Touches a key.</a></li>
-</ul>
-</li>
+<li class="toctree-l1"><a class="reference internal" href="../changelogs.html">Change Logs</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../copyright.html">Copyright</a></li>
 </ul>
 
             
       <li class="wy-breadcrumbs-aside">
         
             
+            
+              <a href="https://github.com/m6w6/libmemcached/blob/v1.x/docs/source/libmemcached/memcached_generate_hash_value.rst" class="fa fa-github"> Edit on GitHub</a>
+            
+          
         
       </li>
     
             
   <div class="section" id="generating-hash-values-directly">
 <h1>Generating hash values directly<a class="headerlink" href="#generating-hash-values-directly" title="Permalink to this headline">¶</a></h1>
-<p id="index-0">Hash a key value</p>
+<p>Hash a key value</p>
 <div class="section" id="synopsis">
 <h2>SYNOPSIS<a class="headerlink" href="#synopsis" title="Permalink to this headline">¶</a></h2>
-<p>#include &lt;libmemcached/memcached.h&gt;</p>
-<dl class="type">
-<dt id="_CPPv416memcached_hash_t">
-<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>
-<dd></dd></dl>
-
+<dl class="docutils">
+<dt>#include &lt;libmemcached/memcached.h&gt;</dt>
+<dd>Compile and link with -lmemcachedutil -lmemcached</dd>
+</dl>
 <dl class="function">
 <dt id="_CPPv429memcached_generate_hash_valuePKc6size_t16memcached_hash_t">
-<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>
-<dd></dd></dl>
+<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="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>
+<dd><table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
+<li><strong>key</strong> -- the key to generate a hash of</li>
+<li><strong>key_length</strong> -- the length of the <a class="reference internal" href="#_CPPv429memcached_generate_hash_valuePKc6size_t16memcached_hash_t" title="memcached_generate_hash_value::key"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">key</span></code></a> without any terminating zero</li>
+<li><strong>hash_algorithm</strong> -- <a class="reference internal" href="#_CPPv416memcached_hash_t" title="memcached_hash_t"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_hash_t</span></code></a>, the algorithm to use</li>
+</ul>
+</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">a 32 bit hash value</p>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
 
 <dl class="function">
 <dt id="_CPPv423memcached_generate_hashP12memcached_stPKc6size_t">
-<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>
-<dd></dd></dl>
+<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="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>
+<dd><table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
+<li><strong>ptr</strong> -- pointer to an initialized <a class="reference internal" href="memcached_create.html#_CPPv412memcached_st" title="memcached_st"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_st</span></code></a> struct</li>
+<li><strong>key</strong> -- the key to generate a hash of</li>
+<li><strong>key_length</strong> -- the length of the <a class="reference internal" href="#_CPPv423memcached_generate_hashP12memcached_stPKc6size_t" title="memcached_generate_hash::key"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">key</span></code></a> without any terminating zero</li>
+</ul>
+</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">a 32 bit hash value</p>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
 
 <dl class="type">
-<dt id="_CPPv422MEMCACHED_HASH_DEFAULT">
-<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>
+<dt id="c.memcached_hash_t">
+enum <a class="reference internal" href="#c.memcached_hash_t" title="memcached_hash_t">memcached_hash_t</a> <code class="descname">memcached_hash_t</code><a class="headerlink" href="#c.memcached_hash_t" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>
 
-<dl class="type">
-<dt id="_CPPv418MEMCACHED_HASH_MD5">
-<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>
+<dl class="enum">
+<dt id="_CPPv416memcached_hash_t">
+<span id="_CPPv316memcached_hash_t"></span><span id="_CPPv216memcached_hash_t"></span><em class="property">enum </em><code class="descname">memcached_hash_t</code><a class="headerlink" href="#_CPPv416memcached_hash_t" title="Permalink to this definition">¶</a><br /></dt>
+<dd><dl class="enumerator">
+<dt id="_CPPv4N16memcached_hash_t22MEMCACHED_HASH_DEFAULTE">
+<span id="_CPPv3N16memcached_hash_t22MEMCACHED_HASH_DEFAULTE"></span><span id="_CPPv2N16memcached_hash_t22MEMCACHED_HASH_DEFAULTE"></span><em class="property">enumerator </em><code class="descname">MEMCACHED_HASH_DEFAULT</code><a class="headerlink" href="#_CPPv4N16memcached_hash_t22MEMCACHED_HASH_DEFAULTE" title="Permalink to this definition">¶</a><br /></dt>
 <dd></dd></dl>
 
-<dl class="type">
-<dt id="_CPPv418MEMCACHED_HASH_CRC">
-<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>
+<dl class="enumerator">
+<dt id="_CPPv4N16memcached_hash_t18MEMCACHED_HASH_MD5E">
+<span id="_CPPv3N16memcached_hash_t18MEMCACHED_HASH_MD5E"></span><span id="_CPPv2N16memcached_hash_t18MEMCACHED_HASH_MD5E"></span><em class="property">enumerator </em><code class="descname">MEMCACHED_HASH_MD5</code><a class="headerlink" href="#_CPPv4N16memcached_hash_t18MEMCACHED_HASH_MD5E" title="Permalink to this definition">¶</a><br /></dt>
 <dd></dd></dl>
 
-<dl class="type">
-<dt id="_CPPv422MEMCACHED_HASH_FNV1_64">
-<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>
+<dl class="enumerator">
+<dt id="_CPPv4N16memcached_hash_t18MEMCACHED_HASH_CRCE">
+<span id="_CPPv3N16memcached_hash_t18MEMCACHED_HASH_CRCE"></span><span id="_CPPv2N16memcached_hash_t18MEMCACHED_HASH_CRCE"></span><em class="property">enumerator </em><code class="descname">MEMCACHED_HASH_CRC</code><a class="headerlink" href="#_CPPv4N16memcached_hash_t18MEMCACHED_HASH_CRCE" title="Permalink to this definition">¶</a><br /></dt>
 <dd></dd></dl>
 
-<dl class="type">
-<dt id="_CPPv423MEMCACHED_HASH_FNV1A_64">
-<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>
+<dl class="enumerator">
+<dt id="_CPPv4N16memcached_hash_t22MEMCACHED_HASH_FNV1_64E">
+<span id="_CPPv3N16memcached_hash_t22MEMCACHED_HASH_FNV1_64E"></span><span id="_CPPv2N16memcached_hash_t22MEMCACHED_HASH_FNV1_64E"></span><em class="property">enumerator </em><code class="descname">MEMCACHED_HASH_FNV1_64</code><a class="headerlink" href="#_CPPv4N16memcached_hash_t22MEMCACHED_HASH_FNV1_64E" title="Permalink to this definition">¶</a><br /></dt>
 <dd></dd></dl>
 
-<dl class="type">
-<dt id="_CPPv422MEMCACHED_HASH_FNV1_32">
-<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>
+<dl class="enumerator">
+<dt id="_CPPv4N16memcached_hash_t23MEMCACHED_HASH_FNV1A_64E">
+<span id="_CPPv3N16memcached_hash_t23MEMCACHED_HASH_FNV1A_64E"></span><span id="_CPPv2N16memcached_hash_t23MEMCACHED_HASH_FNV1A_64E"></span><em class="property">enumerator </em><code class="descname">MEMCACHED_HASH_FNV1A_64</code><a class="headerlink" href="#_CPPv4N16memcached_hash_t23MEMCACHED_HASH_FNV1A_64E" title="Permalink to this definition">¶</a><br /></dt>
 <dd></dd></dl>
 
-<dl class="type">
-<dt id="_CPPv423MEMCACHED_HASH_FNV1A_32">
-<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>
+<dl class="enumerator">
+<dt id="_CPPv4N16memcached_hash_t22MEMCACHED_HASH_FNV1_32E">
+<span id="_CPPv3N16memcached_hash_t22MEMCACHED_HASH_FNV1_32E"></span><span id="_CPPv2N16memcached_hash_t22MEMCACHED_HASH_FNV1_32E"></span><em class="property">enumerator </em><code class="descname">MEMCACHED_HASH_FNV1_32</code><a class="headerlink" href="#_CPPv4N16memcached_hash_t22MEMCACHED_HASH_FNV1_32E" title="Permalink to this definition">¶</a><br /></dt>
 <dd></dd></dl>
 
-<dl class="type">
-<dt id="_CPPv422MEMCACHED_HASH_JENKINS">
-<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>
+<dl class="enumerator">
+<dt id="_CPPv4N16memcached_hash_t23MEMCACHED_HASH_FNV1A_32E">
+<span id="_CPPv3N16memcached_hash_t23MEMCACHED_HASH_FNV1A_32E"></span><span id="_CPPv2N16memcached_hash_t23MEMCACHED_HASH_FNV1A_32E"></span><em class="property">enumerator </em><code class="descname">MEMCACHED_HASH_FNV1A_32</code><a class="headerlink" href="#_CPPv4N16memcached_hash_t23MEMCACHED_HASH_FNV1A_32E" title="Permalink to this definition">¶</a><br /></dt>
 <dd></dd></dl>
 
-<dl class="type">
-<dt id="_CPPv421MEMCACHED_HASH_MURMUR">
-<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>
+<dl class="enumerator">
+<dt id="_CPPv4N16memcached_hash_t20MEMCACHED_HASH_HSIEHE">
+<span id="_CPPv3N16memcached_hash_t20MEMCACHED_HASH_HSIEHE"></span><span id="_CPPv2N16memcached_hash_t20MEMCACHED_HASH_HSIEHE"></span><em class="property">enumerator </em><code class="descname">MEMCACHED_HASH_HSIEH</code><a class="headerlink" href="#_CPPv4N16memcached_hash_t20MEMCACHED_HASH_HSIEHE" title="Permalink to this definition">¶</a><br /></dt>
 <dd></dd></dl>
 
-<dl class="type">
-<dt id="_CPPv420MEMCACHED_HASH_HSIEH">
-<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>
+<dl class="enumerator">
+<dt id="_CPPv4N16memcached_hash_t21MEMCACHED_HASH_MURMURE">
+<span id="_CPPv3N16memcached_hash_t21MEMCACHED_HASH_MURMURE"></span><span id="_CPPv2N16memcached_hash_t21MEMCACHED_HASH_MURMURE"></span><em class="property">enumerator </em><code class="descname">MEMCACHED_HASH_MURMUR</code><a class="headerlink" href="#_CPPv4N16memcached_hash_t21MEMCACHED_HASH_MURMURE" title="Permalink to this definition">¶</a><br /></dt>
 <dd></dd></dl>
 
-<dl class="type">
-<dt id="_CPPv422MEMCACHED_HASH_MURMUR3">
-<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>
+<dl class="enumerator">
+<dt id="_CPPv4N16memcached_hash_t22MEMCACHED_HASH_JENKINSE">
+<span id="_CPPv3N16memcached_hash_t22MEMCACHED_HASH_JENKINSE"></span><span id="_CPPv2N16memcached_hash_t22MEMCACHED_HASH_JENKINSE"></span><em class="property">enumerator </em><code class="descname">MEMCACHED_HASH_JENKINS</code><a class="headerlink" href="#_CPPv4N16memcached_hash_t22MEMCACHED_HASH_JENKINSE" title="Permalink to this definition">¶</a><br /></dt>
 <dd></dd></dl>
 
-<p>Compile and link with -lmemcachedutil -lmemcached</p>
+<dl class="enumerator">
+<dt id="_CPPv4N16memcached_hash_t22MEMCACHED_HASH_MURMUR3E">
+<span id="_CPPv3N16memcached_hash_t22MEMCACHED_HASH_MURMUR3E"></span><span id="_CPPv2N16memcached_hash_t22MEMCACHED_HASH_MURMUR3E"></span><em class="property">enumerator </em><code class="descname">MEMCACHED_HASH_MURMUR3</code><a class="headerlink" href="#_CPPv4N16memcached_hash_t22MEMCACHED_HASH_MURMUR3E" title="Permalink to this definition">¶</a><br /></dt>
+<dd></dd></dl>
+
+<dl class="enumerator">
+<dt id="_CPPv4N16memcached_hash_t21MEMCACHED_HASH_CUSTOME">
+<span id="_CPPv3N16memcached_hash_t21MEMCACHED_HASH_CUSTOME"></span><span id="_CPPv2N16memcached_hash_t21MEMCACHED_HASH_CUSTOME"></span><em class="property">enumerator </em><code class="descname">MEMCACHED_HASH_CUSTOM</code><a class="headerlink" href="#_CPPv4N16memcached_hash_t21MEMCACHED_HASH_CUSTOME" title="Permalink to this definition">¶</a><br /></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
 </div>
 <div class="section" id="description">
 <h2>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
 the hash functions defined in the library. This method is provided for
 the convenience of higher-level language bindings and is not necessary
 for normal memcache operations.</p>
-<p>The allowed hash algorithm constants are listed in the manpage for
-<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>
+<p>Support for <a class="reference internal" href="#_CPPv4N16memcached_hash_t20MEMCACHED_HASH_HSIEHE" title="MEMCACHED_HASH_HSIEH"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">MEMCACHED_HASH_HSIEH</span></code></a> is a compile time option that is
+disabled by default. To enable tests for this hashing algorithm,
+configure and build libmemcached with the Hsieh hash enabled.</p>
 <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
 and produces the hash value that would have been generated based on the
 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>
 <p>As of version 0.36 all hash methods have been placed into the library
 libhashkit(3) which is linked with libmemcached(3). For more information please see its documentation.</p>
 </div>
-<div class="section" id="return">
-<h2>RETURN<a class="headerlink" href="#return" title="Permalink to this headline">¶</a></h2>
+<div class="section" id="return-value">
+<h2>RETURN VALUE<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2>
 <p>A 32-bit integer which is the result of hashing the given key.
 For 64-bit hash algorithms, only the least-significant 32 bits are
 returned.</p>