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.0.99 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 src="_static/jquery.js"></script>
  25         <script src="_static/underscore.js"></script>
  26         <script src="_static/doctools.js"></script>
  27         <script 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.0
  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               <p class="caption"><span class="caption-text">libmemcached</span></p>
  88 <ul>
  89 <li class="toctree-l1"><a class="reference internal" href="libmemcached.html">Introduction</a></li>
  90 <li class="toctree-l1"><a class="reference internal" href="libmemcached/index.html">libmemcached API</a><ul>
  91 <li class="toctree-l2"><a class="reference internal" href="libmemcached/index_basics.html">Basics</a></li>
  92 <li class="toctree-l2"><a class="reference internal" href="libmemcached/index_data.html">Working with Data</a></li>
  93 <li class="toctree-l2"><a class="reference internal" href="libmemcached/index_errors.html">Messages and Errors</a></li>
  94 <li class="toctree-l2"><a class="reference internal" href="libmemcached/index_advanced.html">Advanced Topics</a></li>
  95 <li class="toctree-l2"><a class="reference internal" href="libmemcached/index_deprecated.html">Deprecated Functionality</a></li>
  96 </ul>
  97 </li>
  98 <li class="toctree-l1"><a class="reference internal" href="libmemcached/index_misc.html">Misc</a><ul>
  99 <li class="toctree-l2"><a class="reference internal" href="libmemcached/configuration.html">Configuration</a></li>
 100 <li class="toctree-l2"><a class="reference internal" href="libmemcached/constants.html">Constants</a></li>
 101 <li class="toctree-l2"><a class="reference internal" href="libmemcached/examples.html">Examples</a></li>
 102 <li class="toctree-l2"><a class="reference internal" href="libmemcached/versioning.html">Versioning</a></li>
 103 </ul>
 104 </li>
 105 </ul>
 106 <p class="caption"><span class="caption-text">libmemcachedutil</span></p>
 107 <ul>
 108 <li class="toctree-l1"><a class="reference internal" href="libmemcachedutil.html">Introduction</a></li>
 109 <li class="toctree-l1"><a class="reference internal" href="libmemcachedutil/index.html">libmemcachedutil API</a><ul>
 110 <li class="toctree-l2"><a class="reference internal" href="libmemcachedutil/memcached_pool.html">Working with memcached pools</a></li>
 111 </ul>
 112 </li>
 113 </ul>
 114 <p class="caption"><span class="caption-text">libhashkit</span></p>
 115 <ul>
 116 <li class="toctree-l1"><a class="reference internal" href="libhashkit.html">Introduction</a></li>
 117 <li class="toctree-l1"><a class="reference internal" href="libhashkit/index.html">libhashkit API</a><ul>
 118 <li class="toctree-l2"><a class="reference internal" href="libhashkit/hashkit_create.html">Creating a hashkit structure</a></li>
 119 <li class="toctree-l2"><a class="reference internal" href="libhashkit/hashkit_function.html">Set Hash Function</a></li>
 120 <li class="toctree-l2"><a class="reference internal" href="libhashkit/hashkit_functions.html">Available Hashes</a></li>
 121 <li class="toctree-l2"><a class="reference internal" href="libhashkit/hashkit_value.html">Generate hash value</a></li>
 122 </ul>
 123 </li>
 124 </ul>
 125 <p class="caption"><span class="caption-text">Client Applications</span></p>
 126 <ul>
 127 <li class="toctree-l1"><a class="reference internal" href="bin/index.html">Client Applications</a><ul>
 128 <li class="toctree-l2"><a class="reference internal" href="bin/memcapable.html">memcapable - Checking a Memcached server capabilities and compatibility</a></li>
 129 <li class="toctree-l2"><a class="reference internal" href="bin/memcat.html">memcat - “cat” data from a server</a></li>
 130 <li class="toctree-l2"><a class="reference internal" href="bin/memcp.html">memcp - Copy data to a server</a></li>
 131 <li class="toctree-l2"><a class="reference internal" href="bin/memdump.html">memdump - Dumping your server</a></li>
 132 <li class="toctree-l2"><a class="reference internal" href="bin/memerror.html">memerror - translate an error code to a string</a></li>
 133 <li class="toctree-l2"><a class="reference internal" href="bin/memflush.html">memflush - flush all data from a server</a></li>
 134 <li class="toctree-l2"><a class="reference internal" href="bin/memrm.html">memrm - Remove data from a server</a></li>
 135 <li class="toctree-l2"><a class="reference internal" href="bin/memslap.html">memslap - Load testing  and benchmarking a server</a></li>
 136 <li class="toctree-l2"><a class="reference internal" href="bin/memaslap.html">memaslap - Load testing  and benchmarking a server</a></li>
 137 <li class="toctree-l2"><a class="reference internal" href="bin/memstat.html">memstat - Gather statistics from a server</a></li>
 138 <li class="toctree-l2"><a class="reference internal" href="bin/memexist.html">memexist - Check for the existence of a key</a></li>
 139 <li class="toctree-l2"><a class="reference internal" href="bin/memparse.html">memparse - Parse an option string</a></li>
 140 <li class="toctree-l2"><a class="reference internal" href="bin/memping.html">memping - Test to see if a server is available.</a></li>
 141 <li class="toctree-l2"><a class="reference internal" href="bin/memtouch.html">memtouch - Touches a key.</a></li>
 142 </ul>
 143 </li>
 144 </ul>
 145
 146
 147
 148         </div>
 149       </div>
 150     </nav>
 151
 152     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
 153
 154
 155       <nav class="wy-nav-top" aria-label="top navigation">
 156
 157           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
 158           <a href="#">libmemcached</a>
 159
 160       </nav>
 161
 162
 163       <div class="wy-nav-content">
 164
 165         <div class="rst-content">
 166
 167
 168
 169
 170
 171
 172
 173
 174
 175
 176
 177
 178
 179
 180
 181
 182
 183 <div role="navigation" aria-label="breadcrumbs navigation">
 184
 185   <ul class="wy-breadcrumbs">
 186
 187       <li><a href="#">Docs</a> &raquo;</li>
 188
 189       <li>libmemcached Manual</li>
 190
 191
 192       <li class="wy-breadcrumbs-aside">
 193
 194
 195
 196       </li>
 197
 198   </ul>
 199
 200
 201   <hr/>
 202 </div>
 203           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
 204            <div itemprop="articleBody">
 205
 206   <div class="section" id="libmemcached-manual">
 207 <h1>libmemcached Manual<a class="headerlink" href="#libmemcached-manual" title="Permalink to this headline">¶</a></h1>
 208 <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
 209 memcached server (<a class="reference external" href="http://memcached.org/">http://memcached.org/</a>). It has been designed to be light on
 210 memory usage, thread safe, and provide full access to server side methods.</p>
 211 <ul class="simple">
 212 <li><p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></p></li>
 213 <li><p><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></p></li>
 214 </ul>
 215 <div class="toctree-wrapper compound">
 216 <p class="caption"><span class="caption-text">libmemcached</span></p>
 217 <ul>
 218 <li class="toctree-l1"><a class="reference internal" href="libmemcached.html">Introduction</a></li>
 219 <li class="toctree-l1"><a class="reference internal" href="libmemcached/index.html">libmemcached API</a><ul>
 220 <li class="toctree-l2"><a class="reference internal" href="libmemcached/index_basics.html">Basics</a><ul>
 221 <li class="toctree-l3"><a class="reference internal" href="libmemcached/memcached_create.html">Creating and destroying a memcached_st</a></li>
 222 <li class="toctree-l3"><a class="reference internal" href="libmemcached/memcached_get.html">Retrieving data from the server</a></li>
 223 <li class="toctree-l3"><a class="reference internal" href="libmemcached/memcached_set.html">Storing data on the server</a></li>
 224 <li class="toctree-l3"><a class="reference internal" href="libmemcached/memcached_delete.html">Deleting data from a server</a></li>
 225 <li class="toctree-l3"><a class="reference internal" href="libmemcached/memcached_quit.html">Disconnecting a client from a server</a></li>
 226 </ul>
 227 </li>
 228 <li class="toctree-l2"><a class="reference internal" href="libmemcached/index_data.html">Working with Data</a><ul>
 229 <li class="toctree-l3"><a class="reference internal" href="libmemcached/memcached_auto.html">Incrementing and Decrementing Values</a></li>
 230 <li class="toctree-l3"><a class="reference internal" href="libmemcached/memcached_exist.html">Determine if a keys exists.</a></li>
 231 <li class="toctree-l3"><a class="reference internal" href="libmemcached/memcached_touch.html">memcached_touch, memcached_touch_by_key</a></li>
 232 <li class="toctree-l3"><a class="reference internal" href="libmemcached/memcached_flush_buffers.html">Flushing client buffers</a></li>
 233 <li class="toctree-l3"><a class="reference internal" href="libmemcached/memcached_result_st.html">Working with result sets</a></li>
 234 <li class="toctree-l3"><a class="reference internal" href="libmemcached/memcached_append.html">Appending or Prepending to data on the server</a></li>
 235 <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>
 236 </ul>
 237 </li>
 238 <li class="toctree-l2"><a class="reference internal" href="libmemcached/index_errors.html">Messages and Errors</a><ul>
 239 <li class="toctree-l3"><a class="reference internal" href="libmemcached/memcached_return_t.html">Error Codes - memcached_return_t</a></li>
 240 <li class="toctree-l3"><a class="reference internal" href="libmemcached/memcached_last_error.html">Retrieving Error Codes and Messages</a></li>
 241 <li class="toctree-l3"><a class="reference internal" href="libmemcached/memcached_strerror.html">Converting Error Codes to Messages</a></li>
 242 </ul>
 243 </li>
 244 <li class="toctree-l2"><a class="reference internal" href="libmemcached/index_advanced.html">Advanced Topics</a><ul>
 245 <li class="toctree-l3"><a class="reference internal" href="libmemcached/index_advanced_internals.html">Internal Behavior</a><ul>
 246 <li class="toctree-l4"><a class="reference internal" href="libmemcached/memcached_behavior.html">Behaviors of the library</a></li>
 247 <li class="toctree-l4"><a class="reference internal" href="libmemcached/memcached_callback.html">Setting callbacks</a></li>
 248 <li class="toctree-l4"><a class="reference internal" href="libmemcached/memcached_memory_allocators.html">Use custom allocators for embedded usage</a></li>
 249 <li class="toctree-l4"><a class="reference internal" href="libmemcached/memcached_user_data.html">Storing custom user information in the client.</a></li>
 250 </ul>
 251 </li>
 252 <li class="toctree-l3"><a class="reference internal" href="libmemcached/index_advanced_aeh.html">Authentication, Encryption &amp; Hashing</a><ul>
 253 <li class="toctree-l4"><a class="reference internal" href="libmemcached/memcached_set_encoding_key.html">Set encryption key</a></li>
 254 <li class="toctree-l4"><a class="reference internal" href="libmemcached/memcached_generate_hash_value.html">Generating hash values directly</a></li>
 255 <li class="toctree-l4"><a class="reference internal" href="libmemcached/memcached_sasl.html">SASL support</a></li>
 256 </ul>
 257 </li>
 258 <li class="toctree-l3"><a class="reference internal" href="libmemcached/index_advanced_servers.html">Servers and Server Lists</a><ul>
 259 <li class="toctree-l4"><a class="reference internal" href="libmemcached/memcached_server_st.html">Managing lists of servers</a></li>
 260 <li class="toctree-l4"><a class="reference internal" href="libmemcached/memcached_servers.html">Manipulate the server information stored in memcached_st</a></li>
 261 </ul>
 262 </li>
 263 <li class="toctree-l3"><a class="reference internal" href="libmemcached/index_advanced_daemon.html">Affecting the memcached Daemon</a><ul>
 264 <li class="toctree-l4"><a class="reference internal" href="libmemcached/memcached_dump.html">Dumping data from a server</a></li>
 265 <li class="toctree-l4"><a class="reference internal" href="libmemcached/memcached_flush.html">Wiping clean the contents of a server</a></li>
 266 <li class="toctree-l4"><a class="reference internal" href="libmemcached/memcached_verbosity.html">Setting the verbosity of a server</a></li>
 267 <li class="toctree-l4"><a class="reference internal" href="libmemcached/memcached_version.html">Getting version information about the client and server</a></li>
 268 </ul>
 269 </li>
 270 <li class="toctree-l3"><a class="reference internal" href="libmemcached/index_advanced_stats.html">Statistics</a><ul>
 271 <li class="toctree-l4"><a class="reference internal" href="libmemcached/memcached_analyze.html">Analyzing servers</a></li>
 272 <li class="toctree-l4"><a class="reference internal" href="libmemcached/memcached_stats.html">Working with statistical information from a server</a></li>
 273 </ul>
 274 </li>
 275 </ul>
 276 </li>
 277 <li class="toctree-l2"><a class="reference internal" href="libmemcached/index_deprecated.html">Deprecated Functionality</a><ul>
 278 <li class="toctree-l3"><a class="reference internal" href="libmemcached/memcached_fetch.html">memcached_fetch</a></li>
 279 </ul>
 280 </li>
 281 </ul>
 282 </li>
 283 <li class="toctree-l1"><a class="reference internal" href="libmemcached/index_misc.html">Misc</a><ul>
 284 <li class="toctree-l2"><a class="reference internal" href="libmemcached/configuration.html">Configuration</a></li>
 285 <li class="toctree-l2"><a class="reference internal" href="libmemcached/constants.html">Constants</a></li>
 286 <li class="toctree-l2"><a class="reference internal" href="libmemcached/examples.html">Examples</a></li>
 287 <li class="toctree-l2"><a class="reference internal" href="libmemcached/versioning.html">Versioning</a></li>
 288 </ul>
 289 </li>
 290 </ul>
 291 </div>
 292 <div class="toctree-wrapper compound">
 293 <p class="caption"><span class="caption-text">libmemcachedutil</span></p>
 294 <ul>
 295 <li class="toctree-l1"><a class="reference internal" href="libmemcachedutil.html">Introduction</a></li>
 296 <li class="toctree-l1"><a class="reference internal" href="libmemcachedutil/index.html">libmemcachedutil API</a><ul>
 297 <li class="toctree-l2"><a class="reference internal" href="libmemcachedutil/memcached_pool.html">Working with memcached pools</a></li>
 298 </ul>
 299 </li>
 300 </ul>
 301 </div>
 302 <div class="toctree-wrapper compound">
 303 <p class="caption"><span class="caption-text">libhashkit</span></p>
 304 <ul>
 305 <li class="toctree-l1"><a class="reference internal" href="libhashkit.html">Introduction</a></li>
 306 <li class="toctree-l1"><a class="reference internal" href="libhashkit/index.html">libhashkit API</a><ul>
 307 <li class="toctree-l2"><a class="reference internal" href="libhashkit/hashkit_create.html">Creating a hashkit structure</a></li>
 308 <li class="toctree-l2"><a class="reference internal" href="libhashkit/hashkit_function.html">Set Hash Function</a></li>
 309 <li class="toctree-l2"><a class="reference internal" href="libhashkit/hashkit_functions.html">Available Hashes</a></li>
 310 <li class="toctree-l2"><a class="reference internal" href="libhashkit/hashkit_value.html">Generate hash value</a></li>
 311 </ul>
 312 </li>
 313 </ul>
 314 </div>
 315 <div class="toctree-wrapper compound">
 316 <p class="caption"><span class="caption-text">Client Applications</span></p>
 317 <ul>
 318 <li class="toctree-l1"><a class="reference internal" href="bin/index.html">Client Applications</a></li>
 319 </ul>
 320 </div>
 321 <div class="toctree-wrapper compound">
 322 </div>
 323 </div>
 324
 325
 326            </div>
 327
 328           </div>
 329           <footer>
 330
 331     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
 332
 333         <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>
 334
 335
 336     </div>
 337
 338
 339   <hr/>
 340
 341   <div role="contentinfo">
 342     <p>
 343         &copy; <a href="copyright.html">Copyright</a>
 344
 345     </p>
 346   </div>
 347   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>.
 348
 349 </footer>
 350
 351         </div>
 352       </div>
 353
 354     </section>
 355
 356   </div>
 357
 358
 359
 360   <script type="text/javascript">
 361       jQuery(function () {
 362           SphinxRtdTheme.Navigation.enable(true);
 363       });
 364   </script>
 365
 366
 367
 368
 369
 370
 371 </body>
 372 </html>