Deploy to GitHub pages
[m6w6/libmemcached] / libmemcachedutil.html
index 682422567d6f62f09567a92adba547fa3a899619..e92b46071167ce14c3709f803936942c28ff90fd 100644 (file)
   
     
       <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>
 
               <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 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>
+<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="libmemcached/index_misc.html">Misc</a></li>
 </ul>
 <p class="caption"><span class="caption-text">libmemcachedutil</span></p>
 <ul class="current">
 <li class="toctree-l1 current"><a class="current reference internal" href="#">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>
+<li class="toctree-l1"><a class="reference internal" href="libmemcachedutil/index.html">libmemcachedutil API</a></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="libhashkit/index.html">libhashkit API</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>
+<li class="toctree-l1"><a class="reference internal" href="bin/index.html">Client Applications</a></li>
 </ul>
-</li>
+<p class="caption"><span class="caption-text">Copyright</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="copyright.html">Copyright</a></li>
 </ul>
 
             
 <p>Utility library for libmemcached</p>
 <div class="section" id="synopsis">
 <h2>SYNOPSIS<a class="headerlink" href="#synopsis" title="Permalink to this headline">¶</a></h2>
-<dl class="simple">
-<dt>#include &lt;libmemcachedutil-1.0/util.h&gt;</dt><dd><p>Compile and link with -lmemcachedutil</p>
-</dd>
+<dl class="docutils">
+<dt>#include &lt;libmemcachedutil-1.0/util.h&gt;</dt>
+<dd>Compile and link with -lmemcachedutil -lmemcached</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">libmemcachedutil</span></code> is a small and thread-safe client library that
-provides extra functionality built on top of <code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">libmemcached</span></code>.</p>
+<p><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">libmemcachedutil</span></code> is a small and thread-safe client library that provides extra
+functionality built on top of <code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">libmemcached</span></code>.</p>
 </div>
-<div class="section" id="threads">
-<h2>THREADS<a class="headerlink" href="#threads" title="Permalink to this headline">¶</a></h2>
-<p>Do not try to access an instance of <a class="reference internal" href="libmemcached/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> from multiple threads
-at the same time. If you want to access memcached from multiple threads
-you should either clone the <a class="reference internal" href="libmemcached/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>, or use the memcached pool
-implementation. See <a class="reference internal" href="libmemcachedutil/memcached_pool.html#_CPPv421memcached_pool_createP12memcached_stii" title="memcached_pool_create"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_pool_create()</span></code></a>.</p>
+<div class="section" id="threads-and-processes">
+<h2>THREADS AND PROCESSES<a class="headerlink" href="#threads-and-processes" title="Permalink to this headline">¶</a></h2>
+<p>Do not try to access an instance of <a class="reference internal" href="libmemcached/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> from multiple threads at the
+same time. If you want to access memcached from multiple threads you should
+either clone the <a class="reference internal" href="libmemcached/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>, or use the memcached pool implementation. See
+<a class="reference internal" href="libmemcachedutil/memcached_pool.html#_CPPv414memcached_poolPKc6size_t" title="memcached_pool"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_pool()</span></code></a>.</p>
 </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><p><a class="reference internal" href="libmemcached.html"><span class="doc">C/C++ Client Library for memcached</span></a></p></li>
-<li><p><a class="reference internal" href="libmemcachedutil/memcached_pool.html"><span class="doc">Working with memcached pools</span></a></p></li>
+<li><a class="reference internal" href="libmemcached.html"><span class="doc">C/C++ Client Library for memcached</span></a></li>
+<li><a class="reference internal" href="libmemcachedutil/memcached_pool.html"><span class="doc">Working with memcached pools</span></a></li>
 </ul>
 </div>
 </div>