<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>libhashkit API — libmemcached 1.0.99 documentation</title>
+ <title>libhashkit - C/C++ hashing library — 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>
<link rel="search" title="Search" href="../search.html" />
<link rel="copyright" title="Copyright" href="../copyright.html" />
<link rel="next" title="Creating a hashkit structure" href="hashkit_create.html" />
- <link rel="prev" title="libhashkit - C/C++ hashing library" href="../libhashkit.html" />
+ <link rel="prev" title="Working with memcached pools" href="../libmemcachedutil/memcached_pool.html" />
</head>
<body class="wy-body-for-nav">
<div class="version">
- 1.0
+ 1.1
</div>
- <p class="caption"><span class="caption-text">libmemcached</span></p>
-<ul>
+ <ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../libmemcached.html">Introduction</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../libmemcached/index.html">libmemcached API</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="../libmemcached/index_basics.html">Basics</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../libmemcached/index_data.html">Working with Data</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../libmemcached/index_errors.html">Messages and Errors</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../libmemcached/index_advanced.html">Advanced Topics</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../libmemcached/index_deprecated.html">Deprecated Functionality</a></li>
-</ul>
-</li>
-<li class="toctree-l1"><a class="reference internal" href="../libmemcached/index_misc.html">Misc</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="../libmemcached/configuration.html">Configuration</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../libmemcached/constants.html">Constants</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../libmemcached/examples.html">Examples</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../libmemcached/versioning.html">Versioning</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>
-</ul>
-</li>
-</ul>
-<p class="caption"><span class="caption-text">libhashkit</span></p>
-<ul class="current">
-<li class="toctree-l1"><a class="reference internal" href="../libhashkit.html">Introduction</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../libmemcached/index.html">libmemcached API</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../libmemcachedutil/index.html">libmemcachedutil API</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">libhashkit API</a><ul>
<li class="toctree-l2"><a class="reference internal" href="hashkit_create.html">Creating a hashkit structure</a></li>
<li class="toctree-l2"><a class="reference internal" href="hashkit_function.html">Set Hash Function</a></li>
<li class="toctree-l2"><a class="reference internal" href="hashkit_value.html">Generate hash value</a></li>
</ul>
</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="../libmemcached/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><a href="../index.html">Docs</a> »</li>
- <li>libhashkit API</li>
+ <li>libhashkit - C/C++ hashing library</li>
<li class="wy-breadcrumbs-aside">
+
+ <a href="https://github.com/m6w6/libmemcached/blob/v1.x/docs/source/libhashkit/index.rst" class="fa fa-github"> Edit on GitHub</a>
+
+
</li>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
- <div class="section" id="libhashkit-api">
-<h1>libhashkit API<a class="headerlink" href="#libhashkit-api" title="Permalink to this headline">¶</a></h1>
+ <div class="section" id="libhashkit-c-c-hashing-library">
+<h1>libhashkit - C/C++ hashing library<a class="headerlink" href="#libhashkit-c-c-hashing-library" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="synopsis">
+<h2>SYNOPSIS<a class="headerlink" href="#synopsis" title="Permalink to this headline">¶</a></h2>
+<dl class="docutils">
+<dt>#include <libhashkit-1/hashkit.h></dt>
+<dd>Compile and link with -lhashkit.</dd>
+</dl>
+</div>
+<div class="section" id="description">
+<h2>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
+<p><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">libhashkit</span></code> is a small and thread-safe client library that provides a collection
+of useful hashing algorithms.</p>
+<p><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">libhashkit</span></code> is distributed with <code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">libmemcached</span></code>.</p>
<div class="toctree-wrapper compound">
<p class="caption"><span class="caption-text">Hashkit API</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="hashkit_value.html">Generate hash value</a></li>
</ul>
</div>
+</div>
+<div class="section" id="see-also">
+<h2>SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline">¶</a></h2>
+<ul class="simple">
+<li><a class="reference internal" href="../libmemcached.html"><span class="doc">C/C++ Client Library for memcached</span></a></li>
+</ul>
+</div>
</div>
<a href="hashkit_create.html" class="btn btn-neutral float-right" title="Creating a hashkit structure" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
- <a href="../libhashkit.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>
+ <a href="../libmemcachedutil/memcached_pool.html" class="btn btn-neutral float-left" title="Working with memcached pools" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>