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><ul>
100 <li class=
"toctree-l2"><a class=
"reference internal" href=
"configuration.html">Configuration
</a></li>
101 <li class=
"toctree-l2"><a class=
"reference internal" href=
"constants.html">Constants
</a></li>
102 <li class=
"toctree-l2"><a class=
"reference internal" href=
"examples.html">Examples
</a></li>
103 <li class=
"toctree-l2"><a class=
"reference internal" href=
"versioning.html">Versioning
</a></li>
107 <p class=
"caption"><span class=
"caption-text">libmemcachedutil
</span></p>
109 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../libmemcachedutil.html">Introduction
</a></li>
110 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../libmemcachedutil/index.html">libmemcachedutil API
</a><ul>
111 <li class=
"toctree-l2"><a class=
"reference internal" href=
"../libmemcachedutil/memcached_pool.html">Working with memcached pools
</a></li>
115 <p class=
"caption"><span class=
"caption-text">libhashkit
</span></p>
117 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../libhashkit.html">Introduction
</a></li>
118 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../libhashkit/index.html">libhashkit API
</a><ul>
119 <li class=
"toctree-l2"><a class=
"reference internal" href=
"../libhashkit/hashkit_create.html">Creating a hashkit structure
</a></li>
120 <li class=
"toctree-l2"><a class=
"reference internal" href=
"../libhashkit/hashkit_function.html">Set Hash Function
</a></li>
121 <li class=
"toctree-l2"><a class=
"reference internal" href=
"../libhashkit/hashkit_functions.html">Available Hashes
</a></li>
122 <li class=
"toctree-l2"><a class=
"reference internal" href=
"../libhashkit/hashkit_value.html">Generate hash value
</a></li>
126 <p class=
"caption"><span class=
"caption-text">Client Applications
</span></p>
128 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../bin/index.html">Client Applications
</a><ul>
129 <li class=
"toctree-l2"><a class=
"reference internal" href=
"../bin/memcapable.html">memcapable - Checking a Memcached server capabilities and compatibility
</a></li>
130 <li class=
"toctree-l2"><a class=
"reference internal" href=
"../bin/memcat.html">memcat - “cat” data from a server
</a></li>
131 <li class=
"toctree-l2"><a class=
"reference internal" href=
"../bin/memcp.html">memcp - Copy data to a server
</a></li>
132 <li class=
"toctree-l2"><a class=
"reference internal" href=
"../bin/memdump.html">memdump - Dumping your server
</a></li>
133 <li class=
"toctree-l2"><a class=
"reference internal" href=
"../bin/memerror.html">memerror - translate an error code to a string
</a></li>
134 <li class=
"toctree-l2"><a class=
"reference internal" href=
"../bin/memflush.html">memflush - flush all data from a server
</a></li>
135 <li class=
"toctree-l2"><a class=
"reference internal" href=
"../bin/memrm.html">memrm - Remove data from a server
</a></li>
136 <li class=
"toctree-l2"><a class=
"reference internal" href=
"../bin/memslap.html">memslap - Load testing and benchmarking a server
</a></li>
137 <li class=
"toctree-l2"><a class=
"reference internal" href=
"../bin/memaslap.html">memaslap - Load testing and benchmarking a server
</a></li>
138 <li class=
"toctree-l2"><a class=
"reference internal" href=
"../bin/memstat.html">memstat - Gather statistics from a server
</a></li>
139 <li class=
"toctree-l2"><a class=
"reference internal" href=
"../bin/memexist.html">memexist - Check for the existence of a key
</a></li>
140 <li class=
"toctree-l2"><a class=
"reference internal" href=
"../bin/memparse.html">memparse - Parse an option string
</a></li>
141 <li class=
"toctree-l2"><a class=
"reference internal" href=
"../bin/memping.html">memping - Test to see if a server is available.
</a></li>
142 <li class=
"toctree-l2"><a class=
"reference internal" href=
"../bin/memtouch.html">memtouch - Touches a key.
</a></li>
153 <section data-toggle=
"wy-nav-shift" class=
"wy-nav-content-wrap">
156 <nav class=
"wy-nav-top" aria-label=
"top navigation">
158 <i data-toggle=
"wy-nav-top" class=
"fa fa-bars"></i>
159 <a href=
"../index.html">libmemcached
</a>
164 <div class=
"wy-nav-content">
166 <div class=
"rst-content">
184 <div role=
"navigation" aria-label=
"breadcrumbs navigation">
186 <ul class=
"wy-breadcrumbs">
188 <li><a href=
"../index.html">Docs
</a> »</li>
190 <li>libmemcached API
</li>
193 <li class=
"wy-breadcrumbs-aside">
204 <div role=
"main" class=
"document" itemscope=
"itemscope" itemtype=
"http://schema.org/Article">
205 <div itemprop=
"articleBody">
207 <div class=
"section" id=
"libmemcached-api">
208 <h1>libmemcached API
<a class=
"headerlink" href=
"#libmemcached-api" title=
"Permalink to this headline">¶
</a></h1>
209 <div class=
"toctree-wrapper compound">
210 <p class=
"caption"><span class=
"caption-text">Basics
</span></p>
212 <li class=
"toctree-l1"><a class=
"reference internal" href=
"index_basics.html">Basics
</a><ul>
213 <li class=
"toctree-l2"><a class=
"reference internal" href=
"memcached_create.html">Creating and destroying a memcached_st
</a></li>
214 <li class=
"toctree-l2"><a class=
"reference internal" href=
"memcached_get.html">Retrieving data from the server
</a></li>
215 <li class=
"toctree-l2"><a class=
"reference internal" href=
"memcached_set.html">Storing data on the server
</a></li>
216 <li class=
"toctree-l2"><a class=
"reference internal" href=
"memcached_delete.html">Deleting data from a server
</a></li>
217 <li class=
"toctree-l2"><a class=
"reference internal" href=
"memcached_quit.html">Disconnecting a client from a server
</a></li>
222 <div class=
"toctree-wrapper compound">
223 <p class=
"caption"><span class=
"caption-text">Working with Data
</span></p>
225 <li class=
"toctree-l1"><a class=
"reference internal" href=
"index_data.html">Working with Data
</a><ul>
226 <li class=
"toctree-l2"><a class=
"reference internal" href=
"memcached_auto.html">Incrementing and Decrementing Values
</a></li>
227 <li class=
"toctree-l2"><a class=
"reference internal" href=
"memcached_exist.html">Determine if a keys exists.
</a></li>
228 <li class=
"toctree-l2"><a class=
"reference internal" href=
"memcached_touch.html">memcached_touch, memcached_touch_by_key
</a></li>
229 <li class=
"toctree-l2"><a class=
"reference internal" href=
"memcached_flush_buffers.html">Flushing client buffers
</a></li>
230 <li class=
"toctree-l2"><a class=
"reference internal" href=
"memcached_result_st.html">Working with result sets
</a></li>
231 <li class=
"toctree-l2"><a class=
"reference internal" href=
"memcached_append.html">Appending or Prepending to data on the server
</a></li>
232 <li class=
"toctree-l2"><a class=
"reference internal" href=
"memcached_cas.html">Working with data on the server in an atomic fashion
</a></li>
237 <div class=
"toctree-wrapper compound">
238 <p class=
"caption"><span class=
"caption-text">Messages and Errors
</span></p>
240 <li class=
"toctree-l1"><a class=
"reference internal" href=
"index_errors.html">Messages and Errors
</a><ul>
241 <li class=
"toctree-l2"><a class=
"reference internal" href=
"memcached_return_t.html">Error Codes - memcached_return_t
</a></li>
242 <li class=
"toctree-l2"><a class=
"reference internal" href=
"memcached_last_error.html">Retrieving Error Codes and Messages
</a></li>
243 <li class=
"toctree-l2"><a class=
"reference internal" href=
"memcached_strerror.html">Converting Error Codes to Messages
</a></li>
248 <div class=
"toctree-wrapper compound">
249 <p class=
"caption"><span class=
"caption-text">Advanced Topics
</span></p>
251 <li class=
"toctree-l1"><a class=
"reference internal" href=
"index_advanced.html">Advanced Topics
</a><ul>
252 <li class=
"toctree-l2"><a class=
"reference internal" href=
"index_advanced_internals.html">Internal Behavior
</a><ul>
253 <li class=
"toctree-l3"><a class=
"reference internal" href=
"memcached_behavior.html">Behaviors of the library
</a></li>
254 <li class=
"toctree-l3"><a class=
"reference internal" href=
"memcached_callback.html">Setting callbacks
</a></li>
255 <li class=
"toctree-l3"><a class=
"reference internal" href=
"memcached_memory_allocators.html">Use custom allocators for embedded usage
</a></li>
256 <li class=
"toctree-l3"><a class=
"reference internal" href=
"memcached_user_data.html">Storing custom user information in the client.
</a></li>
259 <li class=
"toctree-l2"><a class=
"reference internal" href=
"index_advanced_aeh.html">Authentication, Encryption
& Hashing
</a><ul>
260 <li class=
"toctree-l3"><a class=
"reference internal" href=
"memcached_set_encoding_key.html">Set encryption key
</a></li>
261 <li class=
"toctree-l3"><a class=
"reference internal" href=
"memcached_generate_hash_value.html">Generating hash values directly
</a></li>
262 <li class=
"toctree-l3"><a class=
"reference internal" href=
"memcached_sasl.html">SASL support
</a></li>
265 <li class=
"toctree-l2"><a class=
"reference internal" href=
"index_advanced_servers.html">Servers and Server Lists
</a><ul>
266 <li class=
"toctree-l3"><a class=
"reference internal" href=
"memcached_server_st.html">Managing lists of servers
</a></li>
267 <li class=
"toctree-l3"><a class=
"reference internal" href=
"memcached_servers.html">Manipulate the server information stored in memcached_st
</a></li>
270 <li class=
"toctree-l2"><a class=
"reference internal" href=
"index_advanced_daemon.html">Affecting the memcached Daemon
</a><ul>
271 <li class=
"toctree-l3"><a class=
"reference internal" href=
"memcached_dump.html">Dumping data from a server
</a></li>
272 <li class=
"toctree-l3"><a class=
"reference internal" href=
"memcached_flush.html">Wiping clean the contents of a server
</a></li>
273 <li class=
"toctree-l3"><a class=
"reference internal" href=
"memcached_verbosity.html">Setting the verbosity of a server
</a></li>
274 <li class=
"toctree-l3"><a class=
"reference internal" href=
"memcached_version.html">Getting version information about the client and server
</a></li>
277 <li class=
"toctree-l2"><a class=
"reference internal" href=
"index_advanced_stats.html">Statistics
</a><ul>
278 <li class=
"toctree-l3"><a class=
"reference internal" href=
"memcached_analyze.html">Analyzing servers
</a></li>
279 <li class=
"toctree-l3"><a class=
"reference internal" href=
"memcached_stats.html">Working with statistical information from a server
</a></li>
286 <div class=
"toctree-wrapper compound">
287 <p class=
"caption"><span class=
"caption-text">Deprecated Functionality
</span></p>
289 <li class=
"toctree-l1"><a class=
"reference internal" href=
"index_deprecated.html">Deprecated Functionality
</a><ul>
290 <li class=
"toctree-l2"><a class=
"reference internal" href=
"memcached_fetch.html">memcached_fetch
</a></li>
303 <div class=
"rst-footer-buttons" role=
"navigation" aria-label=
"footer navigation">
305 <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>
308 <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>
315 <div role=
"contentinfo">
317 © <a href=
"../copyright.html">Copyright
</a>
321 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>.
334 <script type=
"text/javascript">
336 SphinxRtdTheme.Navigation.enable(true);