<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>libmemcached Manual — libmemcached 1.0.99 documentation</title>
+ <title>libmemcached-awesome Manual — libmemcached-awesome 1.1.1 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>
- <a href="#" class="icon icon-home"> libmemcached
+ <a href="#" class="icon icon-home"> libmemcached-awesome
<div class="version">
- 1.0
+ 1.1
</div>
- <p class="caption"><span class="caption-text">libmemcached</span></p>
-<ul>
+ <ul>
<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>
-<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>
-</ul>
-</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"><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="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>
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
- <a href="#">libmemcached</a>
+ <a href="#">libmemcached-awesome</a>
</nav>
<li><a href="#">Docs</a> »</li>
- <li>libmemcached Manual</li>
+ <li>libmemcached-awesome Manual</li>
<li class="wy-breadcrumbs-aside">
+
+ <a href="https://github.com/awesomized/libmemcached/blob/v1.x/docs/source/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="libmemcached-manual">
-<h1>libmemcached Manual<a class="headerlink" href="#libmemcached-manual" title="Permalink to this headline">¶</a></h1>
-<p><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">libmemcached</span></code> is an open source C/C++ client library and tools for the
+ <div class="section" id="libmemcached-awesome-manual">
+<h1>libmemcached-awesome Manual<a class="headerlink" href="#libmemcached-awesome-manual" title="Permalink to this headline">¶</a></h1>
+<p><code class="docutils literal notranslate"><span class="pre">libmemcached-awesome</span></code> is an open source C/C++ client library and tools for the
memcached server (<a class="reference external" href="http://memcached.org/">http://memcached.org/</a>). It has been designed to be light on
memory usage, thread safe, and provide full access to server side methods.</p>
-<ul class="simple">
-<li><p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></p></li>
-<li><p><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></p></li>
-</ul>
<div class="toctree-wrapper compound">
-<p class="caption"><span class="caption-text">libmemcached</span></p>
<ul>
<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>
<li class="toctree-l2"><a class="reference internal" href="libmemcached/index_data.html">Working with Data</a><ul>
<li class="toctree-l3"><a class="reference internal" href="libmemcached/memcached_auto.html">Incrementing and Decrementing Values</a></li>
-<li class="toctree-l3"><a class="reference internal" href="libmemcached/memcached_exist.html">Determine if a keys exists.</a></li>
-<li class="toctree-l3"><a class="reference internal" href="libmemcached/memcached_touch.html">memcached_touch, memcached_touch_by_key</a></li>
-<li class="toctree-l3"><a class="reference internal" href="libmemcached/memcached_flush_buffers.html">Flushing client buffers</a></li>
+<li class="toctree-l3"><a class="reference internal" href="libmemcached/memcached_exist.html">Determine if a keys exists</a></li>
+<li class="toctree-l3"><a class="reference internal" href="libmemcached/memcached_touch.html">Update expiration on a key</a></li>
+<li class="toctree-l3"><a class="reference internal" href="libmemcached/memcached_flush_buffers.html">Flush and send buffered commands</a></li>
<li class="toctree-l3"><a class="reference internal" href="libmemcached/memcached_result_st.html">Working with result sets</a></li>
-<li class="toctree-l3"><a class="reference internal" href="libmemcached/memcached_append.html">Appending or Prepending to data on the server</a></li>
+<li class="toctree-l3"><a class="reference internal" href="libmemcached/memcached_append.html">Appending or Prepending Data</a></li>
<li class="toctree-l3"><a class="reference internal" href="libmemcached/memcached_cas.html">Working with data on the server in an atomic fashion</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="libmemcached/index_advanced.html">Advanced Topics</a><ul>
<li class="toctree-l3"><a class="reference internal" href="libmemcached/index_advanced_internals.html">Internal Behavior</a><ul>
<li class="toctree-l4"><a class="reference internal" href="libmemcached/memcached_behavior.html">Behaviors of the library</a></li>
-<li class="toctree-l4"><a class="reference internal" href="libmemcached/memcached_callback.html">Setting callbacks</a></li>
+<li class="toctree-l4"><a class="reference internal" href="libmemcached/memcached_callback.html">Library callbacks</a></li>
<li class="toctree-l4"><a class="reference internal" href="libmemcached/memcached_memory_allocators.html">Use custom allocators for embedded usage</a></li>
-<li class="toctree-l4"><a class="reference internal" href="libmemcached/memcached_user_data.html">Storing custom user information in the client.</a></li>
+<li class="toctree-l4"><a class="reference internal" href="libmemcached/memcached_user_data.html">Storing custom information in the client</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="libmemcached/index_advanced_aeh.html">Authentication, Encryption & Hashing</a><ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="libmemcached/index_advanced_servers.html">Servers and Server Lists</a><ul>
<li class="toctree-l4"><a class="reference internal" href="libmemcached/memcached_server_st.html">Managing lists of servers</a></li>
-<li class="toctree-l4"><a class="reference internal" href="libmemcached/memcached_servers.html">Manipulate the server information stored in memcached_st</a></li>
+<li class="toctree-l4"><a class="reference internal" href="libmemcached/memcached_servers.html">Managing the servers used by memcached_st</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="libmemcached/index_advanced_daemon.html">Affecting the memcached Daemon</a><ul>
<li class="toctree-l4"><a class="reference internal" href="libmemcached/memcached_dump.html">Dumping data from a server</a></li>
<li class="toctree-l4"><a class="reference internal" href="libmemcached/memcached_flush.html">Wiping clean the contents of a server</a></li>
<li class="toctree-l4"><a class="reference internal" href="libmemcached/memcached_verbosity.html">Setting the verbosity of a server</a></li>
-<li class="toctree-l4"><a class="reference internal" href="libmemcached/memcached_version.html">Getting version information about the client and server</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="libmemcached/index_advanced_stats.html">Statistics</a><ul>
<li class="toctree-l4"><a class="reference internal" href="libmemcached/memcached_analyze.html">Analyzing servers</a></li>
<li class="toctree-l4"><a class="reference internal" href="libmemcached/memcached_stats.html">Working with statistical information from a server</a></li>
+<li class="toctree-l4"><a class="reference internal" href="libmemcached/memcached_version.html">Getting version information</a></li>
</ul>
</li>
</ul>
</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>
-</div>
-<div class="toctree-wrapper compound">
-<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>
-</div>
-<div class="toctree-wrapper compound">
-<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_value.html">Generate hash value</a></li>
</ul>
</li>
+<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/memexist.html">memexist — Check for the existence of a key</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 — "cp" files to a server</a></li>
+<li class="toctree-l2"><a class="reference internal" href="bin/memtouch.html">memtouch — "touch" a key</a></li>
+<li class="toctree-l2"><a class="reference internal" href="bin/memrm.html">memrm – "rm" a key</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/memslap.html">memslap - Load testing and benchmarking a server</a></li>
+<li class="toctree-l2"><a class="reference internal" href="bin/memping.html">memping – Ping 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/memerror.html">memerror — Translate libmemcached error codes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="bin/memparse.html">memparse — Parse and validate an option string</a></li>
+<li class="toctree-l2"><a class="reference internal" href="bin/memcapable.html">memcapable — Check a server's capabilities and compatibility</a></li>
+<li class="toctree-l2"><a class="reference internal" href="bin/memdump.html">memdump — Dump a server's data</a></li>
+<li class="toctree-l2"><a class="reference internal" href="bin/memflush.html">memflush — Flush a server (erase all cached data)</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="libmemcached/index_misc.html">Miscellaneous</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>
</div>
<div class="toctree-wrapper compound">
-<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></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>
</div>
-<div class="toctree-wrapper compound">
+<div class="section" id="index">
+<h2>Index<a class="headerlink" href="#index" title="Permalink to this headline">¶</a></h2>
+<p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></p>
</div>
</div>