git.m6w6.name Git - m6w6/libmemcached/blob - index.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>libmemcached Manual &mdash; libmemcached 1.1.0 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 type="text/javascript" src="_static/jquery.js"></script>
  25         <script type="text/javascript" src="_static/underscore.js"></script>
  26         <script type="text/javascript" src="_static/doctools.js"></script>
  27         <script type="text/javascript" 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="C/C++ Client Library for memcached" href="libmemcached.html" />
  40 </head>
  41
  42 <body class="wy-body-for-nav">
  43
  44
  45   <div class="wy-grid-for-nav">
  46
  47     <nav data-toggle="wy-nav-shift" class="wy-nav-side">
  48       <div class="wy-side-scroll">
  49         <div class="wy-side-nav-search" >
  50
  51
  52
  53             <a href="#" class="icon icon-home"> libmemcached
  54
  55
  56
  57           </a>
  58
  59
  60
  61
  62               <div class="version">
  63                 1.1
  64               </div>
  65
  66
  67
  68
  69 <div role="search">
  70   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
  71     <input type="text" name="q" placeholder="Search docs" />
  72     <input type="hidden" name="check_keywords" value="yes" />
  73     <input type="hidden" name="area" value="default" />
  74   </form>
  75 </div>
  76
  77
  78         </div>
  79
  80         <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
  81
  82
  83
  84
  85
  86
  87               <ul>
  88 <li class="toctree-l1"><a class="reference internal" href="libmemcached.html">Introduction</a></li>
  89 <li class="toctree-l1"><a class="reference internal" href="libmemcached/index.html">libmemcached API</a></li>
  90 <li class="toctree-l1"><a class="reference internal" href="libmemcachedutil/index.html">libmemcachedutil API</a></li>
  91 <li class="toctree-l1"><a class="reference internal" href="libhashkit/index.html">libhashkit API</a></li>
  92 <li class="toctree-l1"><a class="reference internal" href="bin/index.html">Client Applications</a></li>
  93 <li class="toctree-l1"><a class="reference internal" href="libmemcached/index_misc.html">Miscellaneous</a></li>
  94 </ul>
  95 <ul>
  96 <li class="toctree-l1"><a class="reference internal" href="changelogs.html">Change Logs</a></li>
  97 <li class="toctree-l1"><a class="reference internal" href="copyright.html">Copyright</a></li>
  98 </ul>
  99
 100
 101
 102         </div>
 103       </div>
 104     </nav>
 105
 106     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
 107
 108
 109       <nav class="wy-nav-top" aria-label="top navigation">
 110
 111           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
 112           <a href="#">libmemcached</a>
 113
 114       </nav>
 115
 116
 117       <div class="wy-nav-content">
 118
 119         <div class="rst-content">
 120
 121
 122
 123
 124
 125
 126
 127
 128
 129
 130
 131
 132
 133
 134
 135
 136
 137 <div role="navigation" aria-label="breadcrumbs navigation">
 138
 139   <ul class="wy-breadcrumbs">
 140
 141       <li><a href="#">Docs</a> &raquo;</li>
 142
 143       <li>libmemcached Manual</li>
 144
 145
 146       <li class="wy-breadcrumbs-aside">
 147
 148
 149
 150               <a href="https://github.com/m6w6/libmemcached/blob/v1.x/docs/source/index.rst" class="fa fa-github"> Edit on GitHub</a>
 151
 152
 153
 154       </li>
 155
 156   </ul>
 157
 158
 159   <hr/>
 160 </div>
 161           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
 162            <div itemprop="articleBody">
 163
 164   <div class="section" id="libmemcached-manual">
 165 <h1>libmemcached Manual<a class="headerlink" href="#libmemcached-manual" title="Permalink to this headline">¶</a></h1>
 166 <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
 167 memcached server (<a class="reference external" href="http://memcached.org/">http://memcached.org/</a>). It has been designed to be light on
 168 memory usage, thread safe, and provide full access to server side methods.</p>
 169 <div class="toctree-wrapper compound">
 170 <ul>
 171 <li class="toctree-l1"><a class="reference internal" href="libmemcached.html">Introduction</a></li>
 172 <li class="toctree-l1"><a class="reference internal" href="libmemcached/index.html">libmemcached API</a><ul>
 173 <li class="toctree-l2"><a class="reference internal" href="libmemcached/index_basics.html">Basics</a><ul>
 174 <li class="toctree-l3"><a class="reference internal" href="libmemcached/memcached_create.html">Creating and destroying a memcached_st</a></li>
 175 <li class="toctree-l3"><a class="reference internal" href="libmemcached/memcached_get.html">Retrieving data from the server</a></li>
 176 <li class="toctree-l3"><a class="reference internal" href="libmemcached/memcached_set.html">Storing data on the server</a></li>
 177 <li class="toctree-l3"><a class="reference internal" href="libmemcached/memcached_delete.html">Deleting data from a server</a></li>
 178 <li class="toctree-l3"><a class="reference internal" href="libmemcached/memcached_quit.html">Disconnecting a client from a server</a></li>
 179 </ul>
 180 </li>
 181 <li class="toctree-l2"><a class="reference internal" href="libmemcached/index_data.html">Working with Data</a><ul>
 182 <li class="toctree-l3"><a class="reference internal" href="libmemcached/memcached_auto.html">Incrementing and Decrementing Values</a></li>
 183 <li class="toctree-l3"><a class="reference internal" href="libmemcached/memcached_exist.html">Determine if a keys exists</a></li>
 184 <li class="toctree-l3"><a class="reference internal" href="libmemcached/memcached_touch.html">Update expiration on a key</a></li>
 185 <li class="toctree-l3"><a class="reference internal" href="libmemcached/memcached_flush_buffers.html">Flush and send buffered commands</a></li>
 186 <li class="toctree-l3"><a class="reference internal" href="libmemcached/memcached_result_st.html">Working with result sets</a></li>
 187 <li class="toctree-l3"><a class="reference internal" href="libmemcached/memcached_append.html">Appending or Prepending Data</a></li>
 188 <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>
 189 </ul>
 190 </li>
 191 <li class="toctree-l2"><a class="reference internal" href="libmemcached/index_errors.html">Messages and Errors</a><ul>
 192 <li class="toctree-l3"><a class="reference internal" href="libmemcached/memcached_return_t.html">Error Codes - memcached_return_t</a></li>
 193 <li class="toctree-l3"><a class="reference internal" href="libmemcached/memcached_last_error.html">Retrieving Error Codes and Messages</a></li>
 194 <li class="toctree-l3"><a class="reference internal" href="libmemcached/memcached_strerror.html">Converting Error Codes to Messages</a></li>
 195 </ul>
 196 </li>
 197 <li class="toctree-l2"><a class="reference internal" href="libmemcached/index_advanced.html">Advanced Topics</a><ul>
 198 <li class="toctree-l3"><a class="reference internal" href="libmemcached/index_advanced_internals.html">Internal Behavior</a><ul>
 199 <li class="toctree-l4"><a class="reference internal" href="libmemcached/memcached_behavior.html">Behaviors of the library</a></li>
 200 <li class="toctree-l4"><a class="reference internal" href="libmemcached/memcached_callback.html">Library callbacks</a></li>
 201 <li class="toctree-l4"><a class="reference internal" href="libmemcached/memcached_memory_allocators.html">Use custom allocators for embedded usage</a></li>
 202 <li class="toctree-l4"><a class="reference internal" href="libmemcached/memcached_user_data.html">Storing custom information in the client</a></li>
 203 </ul>
 204 </li>
 205 <li class="toctree-l3"><a class="reference internal" href="libmemcached/index_advanced_aeh.html">Authentication, Encryption &amp; Hashing</a><ul>
 206 <li class="toctree-l4"><a class="reference internal" href="libmemcached/memcached_set_encoding_key.html">Set encryption key</a></li>
 207 <li class="toctree-l4"><a class="reference internal" href="libmemcached/memcached_generate_hash_value.html">Generating hash values directly</a></li>
 208 <li class="toctree-l4"><a class="reference internal" href="libmemcached/memcached_sasl.html">SASL support</a></li>
 209 </ul>
 210 </li>
 211 <li class="toctree-l3"><a class="reference internal" href="libmemcached/index_advanced_servers.html">Servers and Server Lists</a><ul>
 212 <li class="toctree-l4"><a class="reference internal" href="libmemcached/memcached_server_st.html">Managing lists of servers</a></li>
 213 <li class="toctree-l4"><a class="reference internal" href="libmemcached/memcached_servers.html">Managing the servers used by memcached_st</a></li>
 214 </ul>
 215 </li>
 216 <li class="toctree-l3"><a class="reference internal" href="libmemcached/index_advanced_daemon.html">Affecting the memcached Daemon</a><ul>
 217 <li class="toctree-l4"><a class="reference internal" href="libmemcached/memcached_dump.html">Dumping data from a server</a></li>
 218 <li class="toctree-l4"><a class="reference internal" href="libmemcached/memcached_flush.html">Wiping clean the contents of a server</a></li>
 219 <li class="toctree-l4"><a class="reference internal" href="libmemcached/memcached_verbosity.html">Setting the verbosity of a server</a></li>
 220 </ul>
 221 </li>
 222 <li class="toctree-l3"><a class="reference internal" href="libmemcached/index_advanced_stats.html">Statistics</a><ul>
 223 <li class="toctree-l4"><a class="reference internal" href="libmemcached/memcached_analyze.html">Analyzing servers</a></li>
 224 <li class="toctree-l4"><a class="reference internal" href="libmemcached/memcached_stats.html">Working with statistical information from a server</a></li>
 225 <li class="toctree-l4"><a class="reference internal" href="libmemcached/memcached_version.html">Getting version information</a></li>
 226 </ul>
 227 </li>
 228 </ul>
 229 </li>
 230 <li class="toctree-l2"><a class="reference internal" href="libmemcached/index_deprecated.html">Deprecated Functionality</a><ul>
 231 <li class="toctree-l3"><a class="reference internal" href="libmemcached/memcached_fetch.html">memcached_fetch</a></li>
 232 </ul>
 233 </li>
 234 </ul>
 235 </li>
 236 <li class="toctree-l1"><a class="reference internal" href="libmemcachedutil/index.html">libmemcachedutil API</a><ul>
 237 <li class="toctree-l2"><a class="reference internal" href="libmemcachedutil/memcached_pool.html">Working with memcached pools</a></li>
 238 </ul>
 239 </li>
 240 <li class="toctree-l1"><a class="reference internal" href="libhashkit/index.html">libhashkit API</a><ul>
 241 <li class="toctree-l2"><a class="reference internal" href="libhashkit/hashkit_create.html">Creating a hashkit structure</a></li>
 242 <li class="toctree-l2"><a class="reference internal" href="libhashkit/hashkit_function.html">Set Hash Function</a></li>
 243 <li class="toctree-l2"><a class="reference internal" href="libhashkit/hashkit_functions.html">Available Hashes</a></li>
 244 <li class="toctree-l2"><a class="reference internal" href="libhashkit/hashkit_value.html">Generate hash value</a></li>
 245 </ul>
 246 </li>
 247 <li class="toctree-l1"><a class="reference internal" href="bin/index.html">Client Applications</a><ul>
 248 <li class="toctree-l2"><a class="reference internal" href="bin/memexist.html">memexist — Check for the existence of a key</a></li>
 249 <li class="toctree-l2"><a class="reference internal" href="bin/memcat.html">memcat — &quot;cat&quot; data from a server</a></li>
 250 <li class="toctree-l2"><a class="reference internal" href="bin/memcp.html">memcp — &quot;cp&quot; files to a server</a></li>
 251 <li class="toctree-l2"><a class="reference internal" href="bin/memtouch.html">memtouch — &quot;touch&quot; a key</a></li>
 252 <li class="toctree-l2"><a class="reference internal" href="bin/memrm.html">memrm – &quot;rm&quot; a key</a></li>
 253 <li class="toctree-l2"><a class="reference internal" href="bin/memaslap.html">memaslap - Load testing and benchmarking a server</a></li>
 254 <li class="toctree-l2"><a class="reference internal" href="bin/memslap.html">memslap - Load testing and benchmarking a server</a></li>
 255 <li class="toctree-l2"><a class="reference internal" href="bin/memping.html">memping – Ping a server</a></li>
 256 <li class="toctree-l2"><a class="reference internal" href="bin/memstat.html">memstat – Gather statistics from a server</a></li>
 257 <li class="toctree-l2"><a class="reference internal" href="bin/memerror.html">memerror — Translate libmemcached error codes</a></li>
 258 <li class="toctree-l2"><a class="reference internal" href="bin/memparse.html">memparse — Parse and validate an option string</a></li>
 259 <li class="toctree-l2"><a class="reference internal" href="bin/memcapable.html">memcapable — Check a server's capabilities and compatibility</a></li>
 260 <li class="toctree-l2"><a class="reference internal" href="bin/memdump.html">memdump — Dump a server's data</a></li>
 261 <li class="toctree-l2"><a class="reference internal" href="bin/memflush.html">memflush — Flush a server (erase all cached data)</a></li>
 262 </ul>
 263 </li>
 264 <li class="toctree-l1"><a class="reference internal" href="libmemcached/index_misc.html">Miscellaneous</a><ul>
 265 <li class="toctree-l2"><a class="reference internal" href="libmemcached/configuration.html">Configuration</a></li>
 266 <li class="toctree-l2"><a class="reference internal" href="libmemcached/constants.html">Constants</a></li>
 267 <li class="toctree-l2"><a class="reference internal" href="libmemcached/examples.html">Examples</a></li>
 268 <li class="toctree-l2"><a class="reference internal" href="libmemcached/versioning.html">Versioning</a></li>
 269 </ul>
 270 </li>
 271 </ul>
 272 </div>
 273 <div class="toctree-wrapper compound">
 274 <ul>
 275 <li class="toctree-l1"><a class="reference internal" href="changelogs.html">Change Logs</a></li>
 276 <li class="toctree-l1"><a class="reference internal" href="copyright.html">Copyright</a></li>
 277 </ul>
 278 </div>
 279 <div class="section" id="index">
 280 <h2>Index<a class="headerlink" href="#index" title="Permalink to this headline">¶</a></h2>
 281 <p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></p>
 282 </div>
 283 </div>
 284
 285
 286            </div>
 287
 288           </div>
 289           <footer>
 290
 291     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
 292
 293         <a href="libmemcached.html" class="btn btn-neutral float-right" title="C/C++ Client Library for memcached" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
 294
 295
 296     </div>
 297
 298
 299   <hr/>
 300
 301   <div role="contentinfo">
 302     <p>
 303         &copy; <a href="copyright.html">Copyright</a>
 304
 305     </p>
 306   </div>
 307   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>.
 308
 309 </footer>
 310
 311         </div>
 312       </div>
 313
 314     </section>
 315
 316   </div>
 317
 318
 319
 320   <script type="text/javascript">
 321       jQuery(function () {
 322           SphinxRtdTheme.Navigation.enable(true);
 323       });
 324   </script>
 325
 326
 327
 328
 329
 330
 331 </body>
 332 </html>