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