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