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]-->
9 <meta name=
"viewport" content=
"width=device-width, initial-scale=1.0">
11 <title>libmemcached API
— libmemcached
1.0.99 documentation
</title>
20 <script type=
"text/javascript" src=
"../_static/js/modernizr.min.js"></script>
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>
29 <script type=
"text/javascript" src=
"../_static/js/theme.js"></script>
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" />
43 <body class=
"wy-body-for-nav">
46 <div class=
"wy-grid-for-nav">
48 <nav data-toggle=
"wy-nav-shift" class=
"wy-nav-side">
49 <div class=
"wy-side-scroll">
50 <div class=
"wy-side-nav-search" >
54 <a href=
"../index.html" class=
"icon icon-home"> libmemcached
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" />
81 <div class=
"wy-menu wy-menu-vertical" data-spy=
"affix" role=
"navigation" aria-label=
"main navigation">
88 <p class=
"caption"><span class=
"caption-text">libmemcached
</span></p>
90 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../libmemcached.html">Introduction
</a></li>
91 <li class=
"toctree-l1 current"><a class=
"current reference internal" href=
"#">libmemcached API
</a><ul>
92 <li class=
"toctree-l2"><a class=
"reference internal" href=
"index_basics.html">Basics
</a></li>
93 <li class=
"toctree-l2"><a class=
"reference internal" href=
"index_data.html">Working with Data
</a></li>
94 <li class=
"toctree-l2"><a class=
"reference internal" href=
"index_errors.html">Messages and Errors
</a></li>
95 <li class=
"toctree-l2"><a class=
"reference internal" href=
"index_advanced.html">Advanced Topics
</a></li>
96 <li class=
"toctree-l2"><a class=
"reference internal" href=
"index_deprecated.html">Deprecated Functionality
</a></li>
99 <li class=
"toctree-l1"><a class=
"reference internal" href=
"index_misc.html">Misc
</a></li>
101 <p class=
"caption"><span class=
"caption-text">libmemcachedutil
</span></p>
103 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../libmemcachedutil.html">Introduction
</a></li>
104 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../libmemcachedutil/index.html">libmemcachedutil API
</a></li>
106 <p class=
"caption"><span class=
"caption-text">libhashkit
</span></p>
108 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../libhashkit.html">Introduction
</a></li>
109 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../libhashkit/index.html">libhashkit API
</a></li>
111 <p class=
"caption"><span class=
"caption-text">Client Applications
</span></p>
113 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../bin/index.html">Client Applications
</a></li>
115 <p class=
"caption"><span class=
"caption-text">Copyright
</span></p>
117 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../copyright.html">Copyright
</a></li>
126 <section data-toggle=
"wy-nav-shift" class=
"wy-nav-content-wrap">
129 <nav class=
"wy-nav-top" aria-label=
"top navigation">
131 <i data-toggle=
"wy-nav-top" class=
"fa fa-bars"></i>
132 <a href=
"../index.html">libmemcached
</a>
137 <div class=
"wy-nav-content">
139 <div class=
"rst-content">
157 <div role=
"navigation" aria-label=
"breadcrumbs navigation">
159 <ul class=
"wy-breadcrumbs">
161 <li><a href=
"../index.html">Docs
</a> »</li>
163 <li>libmemcached API
</li>
166 <li class=
"wy-breadcrumbs-aside">
177 <div role=
"main" class=
"document" itemscope=
"itemscope" itemtype=
"http://schema.org/Article">
178 <div itemprop=
"articleBody">
180 <div class=
"section" id=
"libmemcached-api">
181 <h1>libmemcached API
<a class=
"headerlink" href=
"#libmemcached-api" title=
"Permalink to this headline">ΒΆ
</a></h1>
182 <div class=
"toctree-wrapper compound">
183 <p class=
"caption"><span class=
"caption-text">Basics
</span></p>
185 <li class=
"toctree-l1"><a class=
"reference internal" href=
"index_basics.html">Basics
</a><ul>
186 <li class=
"toctree-l2"><a class=
"reference internal" href=
"memcached_create.html">Creating and destroying a memcached_st
</a></li>
187 <li class=
"toctree-l2"><a class=
"reference internal" href=
"memcached_get.html">Retrieving data from the server
</a></li>
188 <li class=
"toctree-l2"><a class=
"reference internal" href=
"memcached_set.html">Storing data on the server
</a></li>
189 <li class=
"toctree-l2"><a class=
"reference internal" href=
"memcached_delete.html">Deleting data from a server
</a></li>
190 <li class=
"toctree-l2"><a class=
"reference internal" href=
"memcached_quit.html">Disconnecting a client from a server
</a></li>
195 <div class=
"toctree-wrapper compound">
196 <p class=
"caption"><span class=
"caption-text">Working with Data
</span></p>
198 <li class=
"toctree-l1"><a class=
"reference internal" href=
"index_data.html">Working with Data
</a><ul>
199 <li class=
"toctree-l2"><a class=
"reference internal" href=
"memcached_auto.html">Incrementing and Decrementing Values
</a></li>
200 <li class=
"toctree-l2"><a class=
"reference internal" href=
"memcached_exist.html">Determine if a keys exists.
</a></li>
201 <li class=
"toctree-l2"><a class=
"reference internal" href=
"memcached_touch.html">memcached_touch, memcached_touch_by_key
</a></li>
202 <li class=
"toctree-l2"><a class=
"reference internal" href=
"memcached_flush_buffers.html">Flushing client buffers
</a></li>
203 <li class=
"toctree-l2"><a class=
"reference internal" href=
"memcached_result_st.html">Working with result sets
</a></li>
204 <li class=
"toctree-l2"><a class=
"reference internal" href=
"memcached_append.html">Appending or Prepending Data
</a></li>
205 <li class=
"toctree-l2"><a class=
"reference internal" href=
"memcached_cas.html">Working with data on the server in an atomic fashion
</a></li>
210 <div class=
"toctree-wrapper compound">
211 <p class=
"caption"><span class=
"caption-text">Messages and Errors
</span></p>
213 <li class=
"toctree-l1"><a class=
"reference internal" href=
"index_errors.html">Messages and Errors
</a><ul>
214 <li class=
"toctree-l2"><a class=
"reference internal" href=
"memcached_return_t.html">Error Codes - memcached_return_t
</a></li>
215 <li class=
"toctree-l2"><a class=
"reference internal" href=
"memcached_last_error.html">Retrieving Error Codes and Messages
</a></li>
216 <li class=
"toctree-l2"><a class=
"reference internal" href=
"memcached_strerror.html">Converting Error Codes to Messages
</a></li>
221 <div class=
"toctree-wrapper compound">
222 <p class=
"caption"><span class=
"caption-text">Advanced Topics
</span></p>
224 <li class=
"toctree-l1"><a class=
"reference internal" href=
"index_advanced.html">Advanced Topics
</a><ul>
225 <li class=
"toctree-l2"><a class=
"reference internal" href=
"index_advanced_internals.html">Internal Behavior
</a><ul>
226 <li class=
"toctree-l3"><a class=
"reference internal" href=
"memcached_behavior.html">Behaviors of the library
</a></li>
227 <li class=
"toctree-l3"><a class=
"reference internal" href=
"memcached_callback.html">Library callbacks
</a></li>
228 <li class=
"toctree-l3"><a class=
"reference internal" href=
"memcached_memory_allocators.html">Use custom allocators for embedded usage
</a></li>
229 <li class=
"toctree-l3"><a class=
"reference internal" href=
"memcached_user_data.html">Storing custom user information in the client.
</a></li>
232 <li class=
"toctree-l2"><a class=
"reference internal" href=
"index_advanced_aeh.html">Authentication, Encryption
& Hashing
</a><ul>
233 <li class=
"toctree-l3"><a class=
"reference internal" href=
"memcached_set_encoding_key.html">Set encryption key
</a></li>
234 <li class=
"toctree-l3"><a class=
"reference internal" href=
"memcached_generate_hash_value.html">Generating hash values directly
</a></li>
235 <li class=
"toctree-l3"><a class=
"reference internal" href=
"memcached_sasl.html">SASL support
</a></li>
238 <li class=
"toctree-l2"><a class=
"reference internal" href=
"index_advanced_servers.html">Servers and Server Lists
</a><ul>
239 <li class=
"toctree-l3"><a class=
"reference internal" href=
"memcached_server_st.html">Managing lists of servers
</a></li>
240 <li class=
"toctree-l3"><a class=
"reference internal" href=
"memcached_servers.html">Manipulate the server information stored in memcached_st
</a></li>
243 <li class=
"toctree-l2"><a class=
"reference internal" href=
"index_advanced_daemon.html">Affecting the memcached Daemon
</a><ul>
244 <li class=
"toctree-l3"><a class=
"reference internal" href=
"memcached_dump.html">Dumping data from a server
</a></li>
245 <li class=
"toctree-l3"><a class=
"reference internal" href=
"memcached_flush.html">Wiping clean the contents of a server
</a></li>
246 <li class=
"toctree-l3"><a class=
"reference internal" href=
"memcached_verbosity.html">Setting the verbosity of a server
</a></li>
247 <li class=
"toctree-l3"><a class=
"reference internal" href=
"memcached_version.html">Getting version information about the client and server
</a></li>
250 <li class=
"toctree-l2"><a class=
"reference internal" href=
"index_advanced_stats.html">Statistics
</a><ul>
251 <li class=
"toctree-l3"><a class=
"reference internal" href=
"memcached_analyze.html">Analyzing servers
</a></li>
252 <li class=
"toctree-l3"><a class=
"reference internal" href=
"memcached_stats.html">Working with statistical information from a server
</a></li>
259 <div class=
"toctree-wrapper compound">
260 <p class=
"caption"><span class=
"caption-text">Deprecated Functionality
</span></p>
262 <li class=
"toctree-l1"><a class=
"reference internal" href=
"index_deprecated.html">Deprecated Functionality
</a><ul>
263 <li class=
"toctree-l2"><a class=
"reference internal" href=
"memcached_fetch.html">memcached_fetch
</a></li>
276 <div class=
"rst-footer-buttons" role=
"navigation" aria-label=
"footer navigation">
278 <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>
281 <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>
288 <div role=
"contentinfo">
290 © <a href=
"../copyright.html">Copyright
</a>
294 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>.
307 <script type=
"text/javascript">
309 SphinxRtdTheme.Navigation.enable(true);