git.m6w6.name Git - m6w6/libmemcached/blob - index.html

   1
   2
   3 <!DOCTYPE html>
   4 <html class="writer-html5" lang="en" >
   5 <head>
   6   <meta charset="utf-8">
   7
   8   <meta name="viewport" content="width=device-width, initial-scale=1.0">
   9
  10   <title>libmemcached Manual &mdash; libmemcached 1.0.99 documentation</title>
  11
  12
  13
  14   <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
  15   <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
  16
  17
  18
  19
  20
  21
  22
  23   <!--[if lt IE 9]>
  24     <script src="_static/js/html5shiv.min.js"></script>
  25   <![endif]-->
  26
  27
  28       <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
  29         <script src="_static/jquery.js"></script>
  30         <script src="_static/underscore.js"></script>
  31         <script src="_static/doctools.js"></script>
  32         <script src="_static/language_data.js"></script>
  33
  34     <script type="text/javascript" src="_static/js/theme.js"></script>
  35
  36
  37     <link rel="index" title="Index" href="genindex.html" />
  38     <link rel="search" title="Search" href="search.html" />
  39     <link rel="copyright" title="Copyright" href="copyright.html" />
  40     <link rel="next" title="C/C++ Client Library for memcached" href="libmemcached.html" />
  41 </head>
  42
  43 <body class="wy-body-for-nav">
  44
  45
  46   <div class="wy-grid-for-nav">
  47
  48     <nav data-toggle="wy-nav-shift" class="wy-nav-side">
  49       <div class="wy-side-scroll">
  50         <div class="wy-side-nav-search" >
  51
  52
  53
  54             <a href="#" class="icon icon-home" alt="Documentation Home"> libmemcached
  55
  56
  57
  58           </a>
  59
  60
  61
  62
  63               <div class="version">
  64                 1.0
  65               </div>
  66
  67
  68
  69
  70 <div role="search">
  71   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
  72     <input type="text" name="q" placeholder="Search docs" />
  73     <input type="hidden" name="check_keywords" value="yes" />
  74     <input type="hidden" name="area" value="default" />
  75   </form>
  76 </div>
  77
  78
  79         </div>
  80
  81
  82         <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
  83
  84
  85
  86
  87
  88
  89               <p class="caption"><span class="caption-text">libmemcached</span></p>
  90 <ul>
  91 <li class="toctree-l1"><a class="reference internal" href="libmemcached.html">Introduction</a></li>
  92 <li class="toctree-l1"><a class="reference internal" href="libmemcached/index.html">libmemcached API</a></li>
  93 <li class="toctree-l1"><a class="reference internal" href="libmemcached/index_misc.html">Misc</a></li>
  94 </ul>
  95 <p class="caption"><span class="caption-text">libmemcachedutil</span></p>
  96 <ul>
  97 <li class="toctree-l1"><a class="reference internal" href="libmemcachedutil.html">Introduction</a></li>
  98 <li class="toctree-l1"><a class="reference internal" href="libmemcachedutil/index.html">libmemcachedutil API</a></li>
  99 </ul>
 100 <p class="caption"><span class="caption-text">libhashkit</span></p>
 101 <ul>
 102 <li class="toctree-l1"><a class="reference internal" href="libhashkit.html">Introduction</a></li>
 103 <li class="toctree-l1"><a class="reference internal" href="libhashkit/index.html">libhashkit API</a></li>
 104 </ul>
 105 <p class="caption"><span class="caption-text">Client Applications</span></p>
 106 <ul>
 107 <li class="toctree-l1"><a class="reference internal" href="bin/index.html">Client Applications</a></li>
 108 </ul>
 109 <p class="caption"><span class="caption-text">Copyright</span></p>
 110 <ul>
 111 <li class="toctree-l1"><a class="reference internal" href="copyright.html">Copyright</a></li>
 112 </ul>
 113
 114
 115
 116         </div>
 117
 118       </div>
 119     </nav>
 120
 121     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
 122
 123
 124       <nav class="wy-nav-top" aria-label="top navigation">
 125
 126           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
 127           <a href="#">libmemcached</a>
 128
 129       </nav>
 130
 131
 132       <div class="wy-nav-content">
 133
 134         <div class="rst-content">
 135
 136
 137
 138
 139
 140
 141
 142
 143
 144
 145
 146
 147
 148
 149
 150
 151
 152 <div role="navigation" aria-label="breadcrumbs navigation">
 153
 154   <ul class="wy-breadcrumbs">
 155
 156       <li><a href="#" class="icon icon-home"></a> &raquo;</li>
 157
 158       <li>libmemcached Manual</li>
 159
 160
 161       <li class="wy-breadcrumbs-aside">
 162
 163
 164
 165       </li>
 166
 167   </ul>
 168
 169
 170   <hr/>
 171 </div>
 172           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
 173            <div itemprop="articleBody">
 174
 175   <div class="section" id="libmemcached-manual">
 176 <h1>libmemcached Manual<a class="headerlink" href="#libmemcached-manual" title="Permalink to this headline">¶</a></h1>
 177 <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
 178 memcached server (<a class="reference external" href="http://memcached.org/">http://memcached.org/</a>). It has been designed to be light on
 179 memory usage, thread safe, and provide full access to server side methods.</p>
 180 <div class="toctree-wrapper compound">
 181 <p class="caption"><span class="caption-text">libmemcached</span></p>
 182 <ul>
 183 <li class="toctree-l1"><a class="reference internal" href="libmemcached.html">Introduction</a></li>
 184 <li class="toctree-l1"><a class="reference internal" href="libmemcached/index.html">libmemcached API</a><ul>
 185 <li class="toctree-l2"><a class="reference internal" href="libmemcached/index_basics.html">Basics</a><ul>
 186 <li class="toctree-l3"><a class="reference internal" href="libmemcached/memcached_create.html">Creating and destroying a memcached_st</a></li>
 187 <li class="toctree-l3"><a class="reference internal" href="libmemcached/memcached_get.html">Retrieving data from the server</a></li>
 188 <li class="toctree-l3"><a class="reference internal" href="libmemcached/memcached_set.html">Storing data on the server</a></li>
 189 <li class="toctree-l3"><a class="reference internal" href="libmemcached/memcached_delete.html">Deleting data from a server</a></li>
 190 <li class="toctree-l3"><a class="reference internal" href="libmemcached/memcached_quit.html">Disconnecting a client from a server</a></li>
 191 </ul>
 192 </li>
 193 <li class="toctree-l2"><a class="reference internal" href="libmemcached/index_data.html">Working with Data</a><ul>
 194 <li class="toctree-l3"><a class="reference internal" href="libmemcached/memcached_auto.html">Incrementing and Decrementing Values</a></li>
 195 <li class="toctree-l3"><a class="reference internal" href="libmemcached/memcached_exist.html">Determine if a keys exists</a></li>
 196 <li class="toctree-l3"><a class="reference internal" href="libmemcached/memcached_touch.html">Update expiration on a key</a></li>
 197 <li class="toctree-l3"><a class="reference internal" href="libmemcached/memcached_flush_buffers.html">Flush and send buffered commands</a></li>
 198 <li class="toctree-l3"><a class="reference internal" href="libmemcached/memcached_result_st.html">Working with result sets</a></li>
 199 <li class="toctree-l3"><a class="reference internal" href="libmemcached/memcached_append.html">Appending or Prepending Data</a></li>
 200 <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>
 201 </ul>
 202 </li>
 203 <li class="toctree-l2"><a class="reference internal" href="libmemcached/index_errors.html">Messages and Errors</a><ul>
 204 <li class="toctree-l3"><a class="reference internal" href="libmemcached/memcached_return_t.html">Error Codes - memcached_return_t</a></li>
 205 <li class="toctree-l3"><a class="reference internal" href="libmemcached/memcached_last_error.html">Retrieving Error Codes and Messages</a></li>
 206 <li class="toctree-l3"><a class="reference internal" href="libmemcached/memcached_strerror.html">Converting Error Codes to Messages</a></li>
 207 </ul>
 208 </li>
 209 <li class="toctree-l2"><a class="reference internal" href="libmemcached/index_advanced.html">Advanced Topics</a><ul>
 210 <li class="toctree-l3"><a class="reference internal" href="libmemcached/index_advanced_internals.html">Internal Behavior</a><ul>
 211 <li class="toctree-l4"><a class="reference internal" href="libmemcached/memcached_behavior.html">Behaviors of the library</a></li>
 212 <li class="toctree-l4"><a class="reference internal" href="libmemcached/memcached_callback.html">Library callbacks</a></li>
 213 <li class="toctree-l4"><a class="reference internal" href="libmemcached/memcached_memory_allocators.html">Use custom allocators for embedded usage</a></li>
 214 <li class="toctree-l4"><a class="reference internal" href="libmemcached/memcached_user_data.html">Storing custom user information in the client.</a></li>
 215 </ul>
 216 </li>
 217 <li class="toctree-l3"><a class="reference internal" href="libmemcached/index_advanced_aeh.html">Authentication, Encryption &amp; Hashing</a><ul>
 218 <li class="toctree-l4"><a class="reference internal" href="libmemcached/memcached_set_encoding_key.html">Set encryption key</a></li>
 219 <li class="toctree-l4"><a class="reference internal" href="libmemcached/memcached_generate_hash_value.html">Generating hash values directly</a></li>
 220 <li class="toctree-l4"><a class="reference internal" href="libmemcached/memcached_sasl.html">SASL support</a></li>
 221 </ul>
 222 </li>
 223 <li class="toctree-l3"><a class="reference internal" href="libmemcached/index_advanced_servers.html">Servers and Server Lists</a><ul>
 224 <li class="toctree-l4"><a class="reference internal" href="libmemcached/memcached_server_st.html">Managing lists of servers</a></li>
 225 <li class="toctree-l4"><a class="reference internal" href="libmemcached/memcached_servers.html">Manipulate the server information stored in memcached_st</a></li>
 226 </ul>
 227 </li>
 228 <li class="toctree-l3"><a class="reference internal" href="libmemcached/index_advanced_daemon.html">Affecting the memcached Daemon</a><ul>
 229 <li class="toctree-l4"><a class="reference internal" href="libmemcached/memcached_dump.html">Dumping data from a server</a></li>
 230 <li class="toctree-l4"><a class="reference internal" href="libmemcached/memcached_flush.html">Wiping clean the contents of a server</a></li>
 231 <li class="toctree-l4"><a class="reference internal" href="libmemcached/memcached_verbosity.html">Setting the verbosity of a server</a></li>
 232 <li class="toctree-l4"><a class="reference internal" href="libmemcached/memcached_version.html">Getting version information about the client and server</a></li>
 233 </ul>
 234 </li>
 235 <li class="toctree-l3"><a class="reference internal" href="libmemcached/index_advanced_stats.html">Statistics</a><ul>
 236 <li class="toctree-l4"><a class="reference internal" href="libmemcached/memcached_analyze.html">Analyzing servers</a></li>
 237 <li class="toctree-l4"><a class="reference internal" href="libmemcached/memcached_stats.html">Working with statistical information from a server</a></li>
 238 </ul>
 239 </li>
 240 </ul>
 241 </li>
 242 <li class="toctree-l2"><a class="reference internal" href="libmemcached/index_deprecated.html">Deprecated Functionality</a><ul>
 243 <li class="toctree-l3"><a class="reference internal" href="libmemcached/memcached_fetch.html">memcached_fetch</a></li>
 244 </ul>
 245 </li>
 246 </ul>
 247 </li>
 248 <li class="toctree-l1"><a class="reference internal" href="libmemcached/index_misc.html">Misc</a><ul>
 249 <li class="toctree-l2"><a class="reference internal" href="libmemcached/configuration.html">Configuration</a></li>
 250 <li class="toctree-l2"><a class="reference internal" href="libmemcached/constants.html">Constants</a></li>
 251 <li class="toctree-l2"><a class="reference internal" href="libmemcached/examples.html">Examples</a></li>
 252 <li class="toctree-l2"><a class="reference internal" href="libmemcached/versioning.html">Versioning</a></li>
 253 </ul>
 254 </li>
 255 </ul>
 256 </div>
 257 <div class="toctree-wrapper compound">
 258 <p class="caption"><span class="caption-text">libmemcachedutil</span></p>
 259 <ul>
 260 <li class="toctree-l1"><a class="reference internal" href="libmemcachedutil.html">Introduction</a></li>
 261 <li class="toctree-l1"><a class="reference internal" href="libmemcachedutil/index.html">libmemcachedutil API</a><ul>
 262 <li class="toctree-l2"><a class="reference internal" href="libmemcachedutil/memcached_pool.html">Working with memcached pools</a></li>
 263 </ul>
 264 </li>
 265 </ul>
 266 </div>
 267 <div class="toctree-wrapper compound">
 268 <p class="caption"><span class="caption-text">libhashkit</span></p>
 269 <ul>
 270 <li class="toctree-l1"><a class="reference internal" href="libhashkit.html">Introduction</a></li>
 271 <li class="toctree-l1"><a class="reference internal" href="libhashkit/index.html">libhashkit API</a><ul>
 272 <li class="toctree-l2"><a class="reference internal" href="libhashkit/hashkit_create.html">Creating a hashkit structure</a></li>
 273 <li class="toctree-l2"><a class="reference internal" href="libhashkit/hashkit_function.html">Set Hash Function</a></li>
 274 <li class="toctree-l2"><a class="reference internal" href="libhashkit/hashkit_functions.html">Available Hashes</a></li>
 275 <li class="toctree-l2"><a class="reference internal" href="libhashkit/hashkit_value.html">Generate hash value</a></li>
 276 </ul>
 277 </li>
 278 </ul>
 279 </div>
 280 <div class="toctree-wrapper compound">
 281 <p class="caption"><span class="caption-text">Client Applications</span></p>
 282 <ul>
 283 <li class="toctree-l1"><a class="reference internal" href="bin/index.html">Client Applications</a></li>
 284 </ul>
 285 </div>
 286 <div class="toctree-wrapper compound">
 287 </div>
 288 <div class="section" id="index">
 289 <h2>Index<a class="headerlink" href="#index" title="Permalink to this headline">¶</a></h2>
 290 <p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></p>
 291 </div>
 292 </div>
 293
 294
 295            </div>
 296
 297           </div>
 298           <footer>
 299
 300     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
 301
 302         <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>
 303
 304
 305     </div>
 306
 307
 308   <hr/>
 309
 310   <div role="contentinfo">
 311     <p>
 312
 313
 314         &copy; <a href="copyright.html">Copyright</a>
 315
 316     </p>
 317   </div>
 318
 319
 320
 321     Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
 322
 323     <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
 324
 325     provided by <a href="https://readthedocs.org">Read the Docs</a>.
 326
 327 </footer>
 328
 329         </div>
 330       </div>
 331
 332     </section>
 333
 334   </div>
 335
 336
 337   <script type="text/javascript">
 338       jQuery(function () {
 339           SphinxRtdTheme.Navigation.enable(true);
 340       });
 341   </script>
 342
 343
 344
 345
 346
 347
 348 </body>
 349 </html>