git.m6w6.name Git - m6w6/libmemcached/blob - libmemcached/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 API &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="Basics" href="index_basics.html" />
  40     <link rel="prev" 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="../index.html" class="icon icon-home"> libmemcached
  55
  56
  57
  58           </a>
  59
  60
  61
  62
  63               <div class="version">
  64                 1.1
  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         <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
  82
  83
  84
  85
  86
  87
  88               <ul class="current">
  89 <li class="toctree-l1"><a class="reference internal" href="../libmemcached.html">Introduction</a></li>
  90 <li class="toctree-l1 current"><a class="current reference internal" href="#">libmemcached API</a><ul>
  91 <li class="toctree-l2"><a class="reference internal" href="index_basics.html">Basics</a></li>
  92 <li class="toctree-l2"><a class="reference internal" href="index_data.html">Working with Data</a></li>
  93 <li class="toctree-l2"><a class="reference internal" href="index_errors.html">Messages and Errors</a></li>
  94 <li class="toctree-l2"><a class="reference internal" href="index_advanced.html">Advanced Topics</a></li>
  95 <li class="toctree-l2"><a class="reference internal" href="index_deprecated.html">Deprecated Functionality</a></li>
  96 </ul>
  97 </li>
  98 <li class="toctree-l1"><a class="reference internal" href="../libmemcachedutil/index.html">libmemcachedutil API</a></li>
  99 <li class="toctree-l1"><a class="reference internal" href="../libhashkit/index.html">libhashkit API</a></li>
 100 <li class="toctree-l1"><a class="reference internal" href="../bin/index.html">Client Applications</a></li>
 101 <li class="toctree-l1"><a class="reference internal" href="index_misc.html">Miscellaneous</a></li>
 102 </ul>
 103 <ul>
 104 <li class="toctree-l1"><a class="reference internal" href="../changelogs.html">Change Logs</a></li>
 105 <li class="toctree-l1"><a class="reference internal" href="../copyright.html">Copyright</a></li>
 106 </ul>
 107
 108
 109
 110         </div>
 111       </div>
 112     </nav>
 113
 114     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
 115
 116
 117       <nav class="wy-nav-top" aria-label="top navigation">
 118
 119           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
 120           <a href="../index.html">libmemcached</a>
 121
 122       </nav>
 123
 124
 125       <div class="wy-nav-content">
 126
 127         <div class="rst-content">
 128
 129
 130
 131
 132
 133
 134
 135
 136
 137
 138
 139
 140
 141
 142
 143
 144
 145 <div role="navigation" aria-label="breadcrumbs navigation">
 146
 147   <ul class="wy-breadcrumbs">
 148
 149       <li><a href="../index.html">Docs</a> &raquo;</li>
 150
 151       <li>libmemcached API</li>
 152
 153
 154       <li class="wy-breadcrumbs-aside">
 155
 156
 157
 158               <a href="https://github.com/m6w6/libmemcached/blob/v1.x/docs/source/libmemcached/index.rst" class="fa fa-github"> Edit on GitHub</a>
 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-api">
 173 <h1>libmemcached API<a class="headerlink" href="#libmemcached-api" title="Permalink to this headline">¶</a></h1>
 174 <div class="toctree-wrapper compound">
 175 <p class="caption"><span class="caption-text">Basics</span></p>
 176 <ul>
 177 <li class="toctree-l1"><a class="reference internal" href="index_basics.html">Basics</a><ul>
 178 <li class="toctree-l2"><a class="reference internal" href="memcached_create.html">Creating and destroying a memcached_st</a></li>
 179 <li class="toctree-l2"><a class="reference internal" href="memcached_get.html">Retrieving data from the server</a></li>
 180 <li class="toctree-l2"><a class="reference internal" href="memcached_set.html">Storing data on the server</a></li>
 181 <li class="toctree-l2"><a class="reference internal" href="memcached_delete.html">Deleting data from a server</a></li>
 182 <li class="toctree-l2"><a class="reference internal" href="memcached_quit.html">Disconnecting a client from a server</a></li>
 183 </ul>
 184 </li>
 185 </ul>
 186 </div>
 187 <div class="toctree-wrapper compound">
 188 <p class="caption"><span class="caption-text">Working with Data</span></p>
 189 <ul>
 190 <li class="toctree-l1"><a class="reference internal" href="index_data.html">Working with Data</a><ul>
 191 <li class="toctree-l2"><a class="reference internal" href="memcached_auto.html">Incrementing and Decrementing Values</a></li>
 192 <li class="toctree-l2"><a class="reference internal" href="memcached_exist.html">Determine if a keys exists</a></li>
 193 <li class="toctree-l2"><a class="reference internal" href="memcached_touch.html">Update expiration on a key</a></li>
 194 <li class="toctree-l2"><a class="reference internal" href="memcached_flush_buffers.html">Flush and send buffered commands</a></li>
 195 <li class="toctree-l2"><a class="reference internal" href="memcached_result_st.html">Working with result sets</a></li>
 196 <li class="toctree-l2"><a class="reference internal" href="memcached_append.html">Appending or Prepending Data</a></li>
 197 <li class="toctree-l2"><a class="reference internal" href="memcached_cas.html">Working with data on the server in an atomic fashion</a></li>
 198 </ul>
 199 </li>
 200 </ul>
 201 </div>
 202 <div class="toctree-wrapper compound">
 203 <p class="caption"><span class="caption-text">Messages and Errors</span></p>
 204 <ul>
 205 <li class="toctree-l1"><a class="reference internal" href="index_errors.html">Messages and Errors</a><ul>
 206 <li class="toctree-l2"><a class="reference internal" href="memcached_return_t.html">Error Codes - memcached_return_t</a></li>
 207 <li class="toctree-l2"><a class="reference internal" href="memcached_last_error.html">Retrieving Error Codes and Messages</a></li>
 208 <li class="toctree-l2"><a class="reference internal" href="memcached_strerror.html">Converting Error Codes to Messages</a></li>
 209 </ul>
 210 </li>
 211 </ul>
 212 </div>
 213 <div class="toctree-wrapper compound">
 214 <p class="caption"><span class="caption-text">Advanced Topics</span></p>
 215 <ul>
 216 <li class="toctree-l1"><a class="reference internal" href="index_advanced.html">Advanced Topics</a><ul>
 217 <li class="toctree-l2"><a class="reference internal" href="index_advanced_internals.html">Internal Behavior</a><ul>
 218 <li class="toctree-l3"><a class="reference internal" href="memcached_behavior.html">Behaviors of the library</a></li>
 219 <li class="toctree-l3"><a class="reference internal" href="memcached_callback.html">Library callbacks</a></li>
 220 <li class="toctree-l3"><a class="reference internal" href="memcached_memory_allocators.html">Use custom allocators for embedded usage</a></li>
 221 <li class="toctree-l3"><a class="reference internal" href="memcached_user_data.html">Storing custom information in the client</a></li>
 222 </ul>
 223 </li>
 224 <li class="toctree-l2"><a class="reference internal" href="index_advanced_aeh.html">Authentication, Encryption &amp; Hashing</a><ul>
 225 <li class="toctree-l3"><a class="reference internal" href="memcached_set_encoding_key.html">Set encryption key</a></li>
 226 <li class="toctree-l3"><a class="reference internal" href="memcached_generate_hash_value.html">Generating hash values directly</a></li>
 227 <li class="toctree-l3"><a class="reference internal" href="memcached_sasl.html">SASL support</a></li>
 228 </ul>
 229 </li>
 230 <li class="toctree-l2"><a class="reference internal" href="index_advanced_servers.html">Servers and Server Lists</a><ul>
 231 <li class="toctree-l3"><a class="reference internal" href="memcached_server_st.html">Managing lists of servers</a></li>
 232 <li class="toctree-l3"><a class="reference internal" href="memcached_servers.html">Managing the servers used by memcached_st</a></li>
 233 </ul>
 234 </li>
 235 <li class="toctree-l2"><a class="reference internal" href="index_advanced_daemon.html">Affecting the memcached Daemon</a><ul>
 236 <li class="toctree-l3"><a class="reference internal" href="memcached_dump.html">Dumping data from a server</a></li>
 237 <li class="toctree-l3"><a class="reference internal" href="memcached_flush.html">Wiping clean the contents of a server</a></li>
 238 <li class="toctree-l3"><a class="reference internal" href="memcached_verbosity.html">Setting the verbosity of a server</a></li>
 239 </ul>
 240 </li>
 241 <li class="toctree-l2"><a class="reference internal" href="index_advanced_stats.html">Statistics</a><ul>
 242 <li class="toctree-l3"><a class="reference internal" href="memcached_analyze.html">Analyzing servers</a></li>
 243 <li class="toctree-l3"><a class="reference internal" href="memcached_stats.html">Working with statistical information from a server</a></li>
 244 <li class="toctree-l3"><a class="reference internal" href="memcached_version.html">Getting version information</a></li>
 245 </ul>
 246 </li>
 247 </ul>
 248 </li>
 249 </ul>
 250 </div>
 251 <div class="toctree-wrapper compound">
 252 <p class="caption"><span class="caption-text">Deprecated Functionality</span></p>
 253 <ul>
 254 <li class="toctree-l1"><a class="reference internal" href="index_deprecated.html">Deprecated Functionality</a><ul>
 255 <li class="toctree-l2"><a class="reference internal" href="memcached_fetch.html">memcached_fetch</a></li>
 256 </ul>
 257 </li>
 258 </ul>
 259 </div>
 260 </div>
 261
 262
 263            </div>
 264
 265           </div>
 266           <footer>
 267
 268     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
 269
 270         <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>
 271
 272
 273         <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>
 274
 275     </div>
 276
 277
 278   <hr/>
 279
 280   <div role="contentinfo">
 281     <p>
 282         &copy; <a href="../copyright.html">Copyright</a>
 283
 284     </p>
 285   </div>
 286   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>.
 287
 288 </footer>
 289
 290         </div>
 291       </div>
 292
 293     </section>
 294
 295   </div>
 296
 297
 298
 299   <script type="text/javascript">
 300       jQuery(function () {
 301           SphinxRtdTheme.Navigation.enable(true);
 302       });
 303   </script>
 304
 305
 306
 307
 308
 309
 310 </body>
 311 </html>