<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Introducing the C Client Library for memcached — libmemcached 1.0.99 documentation</title>
+ <title>C/C++ Client Library for memcached — libmemcached 1.0.99 documentation</title>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="copyright" title="Copyright" href="copyright.html" />
- <link rel="next" title="Versioning" href="versioning.html" />
- <link rel="prev" title="Welcome to the libmemcached documentation" href="index.html" />
+ <link rel="next" title="libmemcached API" href="libmemcached/index.html" />
+ <link rel="prev" title="libmemcached Manual" href="index.html" />
</head>
<body class="wy-body-for-nav">
- <p class="caption"><span class="caption-text">Basics</span></p>
+ <p class="caption"><span class="caption-text">libmemcached</span></p>
<ul class="current">
-<li class="toctree-l1 current"><a class="current reference internal" href="#">Introducing the C Client Library for memcached</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="#synopsis">SYNOPSIS</a></li>
-<li class="toctree-l2"><a class="reference internal" href="#description">DESCRIPTION</a></li>
-<li class="toctree-l2"><a class="reference internal" href="#constants">CONSTANTS</a></li>
-<li class="toctree-l2"><a class="reference internal" href="#threads-and-processes">THREADS AND PROCESSES</a></li>
-<li class="toctree-l2"><a class="reference internal" href="#see-also">SEE ALSO</a></li>
+<li class="toctree-l1 current"><a class="current reference internal" href="#">Introduction</a></li>
+<li class="toctree-l1"><a class="reference internal" href="libmemcached/index.html">libmemcached API</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="libmemcached/index_basics.html">Basics</a></li>
+<li class="toctree-l2"><a class="reference internal" href="libmemcached/index_data.html">Working with Data</a></li>
+<li class="toctree-l2"><a class="reference internal" href="libmemcached/index_errors.html">Messages and Errors</a></li>
+<li class="toctree-l2"><a class="reference internal" href="libmemcached/index_advanced.html">Advanced Topics</a></li>
+<li class="toctree-l2"><a class="reference internal" href="libmemcached/index_deprecated.html">Deprecated Functionality</a></li>
</ul>
</li>
-<li class="toctree-l1"><a class="reference internal" href="versioning.html">Versioning</a></li>
-<li class="toctree-l1"><a class="reference internal" href="memcached_create.html">Creating and destroying a memcached_st</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="memcached_create.html#synopsis">SYNOPSIS</a></li>
-<li class="toctree-l2"><a class="reference internal" href="memcached_create.html#description">DESCRIPTION</a></li>
-<li class="toctree-l2"><a class="reference internal" href="memcached_create.html#return">RETURN</a></li>
-<li class="toctree-l2"><a class="reference internal" href="memcached_create.html#see-also">SEE ALSO</a></li>
+<li class="toctree-l1"><a class="reference internal" href="libmemcached/index_misc.html">Misc</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="libmemcached/configuration.html">Configuration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="libmemcached/constants.html">Constants</a></li>
+<li class="toctree-l2"><a class="reference internal" href="libmemcached/examples.html">Examples</a></li>
+<li class="toctree-l2"><a class="reference internal" href="libmemcached/versioning.html">Versioning</a></li>
</ul>
</li>
-<li class="toctree-l1"><a class="reference internal" href="libmemcached_examples.html">Examples</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="libmemcached_examples.html#description">DESCRIPTION</a></li>
-<li class="toctree-l2"><a class="reference internal" href="libmemcached_examples.html#connecting-to-servers">Connecting to servers</a></li>
-<li class="toctree-l2"><a class="reference internal" href="libmemcached_examples.html#creating-a-pool-of-servers">Creating a pool of servers</a></li>
-<li class="toctree-l2"><a class="reference internal" href="libmemcached_examples.html#adding-a-value-to-the-server">Adding a value to the server</a></li>
-<li class="toctree-l2"><a class="reference internal" href="libmemcached_examples.html#fetching-multiple-values">Fetching multiple values</a></li>
-<li class="toctree-l2"><a class="reference internal" href="libmemcached_examples.html#see-also">SEE ALSO</a></li>
</ul>
-</li>
-<li class="toctree-l1"><a class="reference internal" href="libmemcached_configuration.html">Configuring Libmemcached</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="libmemcached_configuration.html#synopsis">SYNOPSIS</a></li>
-<li class="toctree-l2"><a class="reference internal" href="libmemcached_configuration.html#description">DESCRIPTION</a></li>
-<li class="toctree-l2"><a class="reference internal" href="libmemcached_configuration.html#environment">ENVIRONMENT</a></li>
-<li class="toctree-l2"><a class="reference internal" href="libmemcached_configuration.html#return">RETURN</a></li>
-<li class="toctree-l2"><a class="reference internal" href="libmemcached_configuration.html#example">EXAMPLE</a></li>
-<li class="toctree-l2"><a class="reference internal" href="libmemcached_configuration.html#see-also">SEE ALSO</a></li>
-</ul>
-</li>
-<li class="toctree-l1"><a class="reference internal" href="libmemcached/memcached_last_error_message.html">Retrieving errors</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="libmemcached/memcached_last_error_message.html#synopsis">SYNOPSIS</a></li>
-<li class="toctree-l2"><a class="reference internal" href="libmemcached/memcached_last_error_message.html#description">DESCRIPTION</a></li>
-<li class="toctree-l2"><a class="reference internal" href="libmemcached/memcached_last_error_message.html#return">RETURN</a></li>
-<li class="toctree-l2"><a class="reference internal" href="libmemcached/memcached_last_error_message.html#see-also">SEE ALSO</a></li>
-</ul>
-</li>
-</ul>
-<p class="caption"><span class="caption-text">Working with Data</span></p>
-<ul>
-<li class="toctree-l1"><a class="reference internal" href="memcached_auto.html">Incrementing and Decrementing Values</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="memcached_auto.html#synopsis">SYNOPSIS</a></li>
-<li class="toctree-l2"><a class="reference internal" href="memcached_auto.html#description">DESCRIPTION</a></li>
-<li class="toctree-l2"><a class="reference internal" href="memcached_auto.html#return">RETURN</a></li>
-<li class="toctree-l2"><a class="reference internal" href="memcached_auto.html#see-also">SEE ALSO</a></li>
-</ul>
-</li>
-<li class="toctree-l1"><a class="reference internal" href="memcached_delete.html">Deleting data from a server</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="memcached_delete.html#synopsis">SYNOPSIS</a></li>
-<li class="toctree-l2"><a class="reference internal" href="memcached_delete.html#description">DESCRIPTION</a></li>
-<li class="toctree-l2"><a class="reference internal" href="memcached_delete.html#return">RETURN</a></li>
-<li class="toctree-l2"><a class="reference internal" href="memcached_delete.html#see-also">SEE ALSO</a></li>
-</ul>
-</li>
-<li class="toctree-l1"><a class="reference internal" href="libmemcached/memcached_exist.html">Determine if a keys exists.</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="libmemcached/memcached_exist.html#synopsis">SYNOPSIS</a></li>
-<li class="toctree-l2"><a class="reference internal" href="libmemcached/memcached_exist.html#description">DESCRIPTION</a></li>
-<li class="toctree-l2"><a class="reference internal" href="libmemcached/memcached_exist.html#return">RETURN</a></li>
-<li class="toctree-l2"><a class="reference internal" href="libmemcached/memcached_exist.html#see-also">SEE ALSO</a></li>
-</ul>
-</li>
-<li class="toctree-l1"><a class="reference internal" href="memcached_flush_buffers.html">Flushing client buffers</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="memcached_flush_buffers.html#synopsis">SYNOPSIS</a></li>
-<li class="toctree-l2"><a class="reference internal" href="memcached_flush_buffers.html#description">DESCRIPTION</a></li>
-<li class="toctree-l2"><a class="reference internal" href="memcached_flush_buffers.html#return">RETURN</a></li>
-<li class="toctree-l2"><a class="reference internal" href="memcached_flush_buffers.html#see-also">SEE ALSO</a></li>
-</ul>
-</li>
-<li class="toctree-l1"><a class="reference internal" href="memcached_flush.html">Wiping clean the contents of a server</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="memcached_flush.html#synopsis">SYNOPSIS</a></li>
-<li class="toctree-l2"><a class="reference internal" href="memcached_flush.html#description">DESCRIPTION</a></li>
-<li class="toctree-l2"><a class="reference internal" href="memcached_flush.html#return">RETURN</a></li>
-<li class="toctree-l2"><a class="reference internal" href="memcached_flush.html#see-also">SEE ALSO</a></li>
-</ul>
-</li>
-<li class="toctree-l1"><a class="reference internal" href="memcached_get.html">Retrieving data from the server</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="memcached_get.html#synopsis">SYNOPSIS</a></li>
-<li class="toctree-l2"><a class="reference internal" href="memcached_get.html#description">DESCRIPTION</a></li>
-<li class="toctree-l2"><a class="reference internal" href="memcached_get.html#return">RETURN</a></li>
-<li class="toctree-l2"><a class="reference internal" href="memcached_get.html#see-also">SEE ALSO</a></li>
-</ul>
-</li>
-<li class="toctree-l1"><a class="reference internal" href="memcached_result_st.html">Working with result sets</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="memcached_result_st.html#synopsis">SYNOPSIS</a></li>
-<li class="toctree-l2"><a class="reference internal" href="memcached_result_st.html#description">DESCRIPTION</a></li>
-<li class="toctree-l2"><a class="reference internal" href="memcached_result_st.html#return">RETURN</a></li>
-<li class="toctree-l2"><a class="reference internal" href="memcached_result_st.html#see-also">SEE ALSO</a></li>
-</ul>
-</li>
-<li class="toctree-l1"><a class="reference internal" href="memcached_set.html">Store, replace, add, or atomically add data to the server</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="memcached_set.html#synopsis">SYNOPSIS</a></li>
-<li class="toctree-l2"><a class="reference internal" href="memcached_set.html#description">DESCRIPTION</a></li>
-<li class="toctree-l2"><a class="reference internal" href="memcached_set.html#return">RETURN</a></li>
-<li class="toctree-l2"><a class="reference internal" href="memcached_set.html#see-also">SEE ALSO</a></li>
-</ul>
-</li>
-<li class="toctree-l1"><a class="reference internal" href="memcached_append.html">Appending or Prepending to data on the server</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="memcached_append.html#synopsis">SYNOPSIS</a></li>
-<li class="toctree-l2"><a class="reference internal" href="memcached_append.html#description">DESCRIPTION</a></li>
-<li class="toctree-l2"><a class="reference internal" href="memcached_append.html#return">RETURN</a></li>
-<li class="toctree-l2"><a class="reference internal" href="memcached_append.html#see-also">SEE ALSO</a></li>
-</ul>
-</li>
-<li class="toctree-l1"><a class="reference internal" href="memcached_cas.html">Working with data on the server in an atomic fashion</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="memcached_cas.html#synopsis">SYNOPSIS</a></li>
-<li class="toctree-l2"><a class="reference internal" href="memcached_cas.html#description">DESCRIPTION</a></li>
-<li class="toctree-l2"><a class="reference internal" href="memcached_cas.html#return">RETURN</a></li>
-<li class="toctree-l2"><a class="reference internal" href="memcached_cas.html#see-also">SEE ALSO</a></li>
-</ul>
-</li>
-</ul>
-<p class="caption"><span class="caption-text">Advanced Topics</span></p>
+<p class="caption"><span class="caption-text">libmemcachedutil</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="libmemcached-1.0/memcached_set_encoding_key.html">Set encryption key</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="libmemcached-1.0/memcached_set_encoding_key.html#synopsis">SYNOPSIS</a></li>
-<li class="toctree-l2"><a class="reference internal" href="libmemcached-1.0/memcached_set_encoding_key.html#description">DESCRIPTION</a></li>
-<li class="toctree-l2"><a class="reference internal" href="libmemcached-1.0/memcached_set_encoding_key.html#return">RETURN</a></li>
-<li class="toctree-l2"><a class="reference internal" href="libmemcached-1.0/memcached_set_encoding_key.html#see-also">SEE ALSO</a></li>
-</ul>
-</li>
-<li class="toctree-l1"><a class="reference internal" href="memcached_behavior.html">Modifying how the driver behaves</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="memcached_behavior.html#synopsis">SYNOPSIS</a></li>
-<li class="toctree-l2"><a class="reference internal" href="memcached_behavior.html#description">DESCRIPTION</a></li>
-<li class="toctree-l2"><a class="reference internal" href="memcached_behavior.html#return">RETURN</a></li>
-<li class="toctree-l2"><a class="reference internal" href="memcached_behavior.html#notes">NOTES</a></li>
-<li class="toctree-l2"><a class="reference internal" href="memcached_behavior.html#see-also">SEE ALSO</a></li>
+<li class="toctree-l1"><a class="reference internal" href="libmemcachedutil.html">Introduction</a></li>
+<li class="toctree-l1"><a class="reference internal" href="libmemcachedutil/index.html">libmemcachedutil API</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="libmemcachedutil/memcached_pool.html">Working with memcached pools</a></li>
</ul>
</li>
-<li class="toctree-l1"><a class="reference internal" href="memcached_callback.html">Setting callbacks</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="memcached_callback.html#synopsis">SYNOPSIS</a></li>
-<li class="toctree-l2"><a class="reference internal" href="memcached_callback.html#description">DESCRIPTION</a></li>
-<li class="toctree-l2"><a class="reference internal" href="memcached_callback.html#return">RETURN</a></li>
-<li class="toctree-l2"><a class="reference internal" href="memcached_callback.html#see-also">SEE ALSO</a></li>
</ul>
-</li>
-<li class="toctree-l1"><a class="reference internal" href="memcached_dump.html">Dumping data from a server</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="memcached_dump.html#synopsis">SYNOPSIS</a></li>
-<li class="toctree-l2"><a class="reference internal" href="memcached_dump.html#description">DESCRIPTION</a></li>
-<li class="toctree-l2"><a class="reference internal" href="memcached_dump.html#return">RETURN</a></li>
-<li class="toctree-l2"><a class="reference internal" href="memcached_dump.html#see-also">SEE ALSO</a></li>
-</ul>
-</li>
-<li class="toctree-l1"><a class="reference internal" href="memcached_generate_hash_value.html">Generating hash values directly</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="memcached_generate_hash_value.html#synopsis">SYNOPSIS</a></li>
-<li class="toctree-l2"><a class="reference internal" href="memcached_generate_hash_value.html#description">DESCRIPTION</a></li>
-<li class="toctree-l2"><a class="reference internal" href="memcached_generate_hash_value.html#return">RETURN</a></li>
-<li class="toctree-l2"><a class="reference internal" href="memcached_generate_hash_value.html#see-also">SEE ALSO</a></li>
-</ul>
-</li>
-<li class="toctree-l1"><a class="reference internal" href="memcached_memory_allocators.html">Use custom allocators for embedded usage</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="memcached_memory_allocators.html#synopsis">SYNOPSIS</a></li>
-<li class="toctree-l2"><a class="reference internal" href="memcached_memory_allocators.html#description">DESCRIPTION</a></li>
-<li class="toctree-l2"><a class="reference internal" href="memcached_memory_allocators.html#notes">NOTES</a></li>
-<li class="toctree-l2"><a class="reference internal" href="memcached_memory_allocators.html#return">RETURN</a></li>
-<li class="toctree-l2"><a class="reference internal" href="memcached_memory_allocators.html#see-also">SEE ALSO</a></li>
-</ul>
-</li>
-<li class="toctree-l1"><a class="reference internal" href="memcached_quit.html">Disconnecting a client from a server</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="memcached_quit.html#synopsis">SYNOPSIS</a></li>
-<li class="toctree-l2"><a class="reference internal" href="memcached_quit.html#description">DESCRIPTION</a></li>
-<li class="toctree-l2"><a class="reference internal" href="memcached_quit.html#return">RETURN</a></li>
-<li class="toctree-l2"><a class="reference internal" href="memcached_quit.html#see-also">SEE ALSO</a></li>
-</ul>
-</li>
-<li class="toctree-l1"><a class="reference internal" href="libmemcached/memcached_return_t.html">Error Codes (memcached_return_t)</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="libmemcached/memcached_return_t.html#synopsis">SYNOPSIS</a></li>
-<li class="toctree-l2"><a class="reference internal" href="libmemcached/memcached_return_t.html#see-also">SEE ALSO</a></li>
-</ul>
-</li>
-<li class="toctree-l1"><a class="reference internal" href="memcached_sasl.html">SASL support</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="memcached_sasl.html#synopsis">SYNOPSIS</a></li>
-<li class="toctree-l2"><a class="reference internal" href="memcached_sasl.html#description">DESCRIPTION</a></li>
-<li class="toctree-l2"><a class="reference internal" href="memcached_sasl.html#return">RETURN</a></li>
-<li class="toctree-l2"><a class="reference internal" href="memcached_sasl.html#see-also">SEE ALSO</a></li>
-</ul>
-</li>
-<li class="toctree-l1"><a class="reference internal" href="memcached_server_st.html">Managing lists of servers</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="memcached_server_st.html#synopsis">SYNOPSIS</a></li>
-<li class="toctree-l2"><a class="reference internal" href="memcached_server_st.html#description">DESCRIPTION</a></li>
-<li class="toctree-l2"><a class="reference internal" href="memcached_server_st.html#return">RETURN</a></li>
-<li class="toctree-l2"><a class="reference internal" href="memcached_server_st.html#see-also">SEE ALSO</a></li>
-</ul>
-</li>
-<li class="toctree-l1"><a class="reference internal" href="memcached_servers.html">Manipulate the server information stored in memcached_st</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="memcached_servers.html#synopsis">SYNOPSIS</a></li>
-<li class="toctree-l2"><a class="reference internal" href="memcached_servers.html#description">DESCRIPTION</a></li>
-<li class="toctree-l2"><a class="reference internal" href="memcached_servers.html#return">RETURN</a></li>
-<li class="toctree-l2"><a class="reference internal" href="memcached_servers.html#see-also">SEE ALSO</a></li>
-</ul>
-</li>
-<li class="toctree-l1"><a class="reference internal" href="memcached_strerror.html">Converting Errors, memcached_return_t, to strings</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="memcached_strerror.html#synopsis">SYNOPSIS</a></li>
-<li class="toctree-l2"><a class="reference internal" href="memcached_strerror.html#description">DESCRIPTION</a></li>
-<li class="toctree-l2"><a class="reference internal" href="memcached_strerror.html#return">RETURN</a></li>
-<li class="toctree-l2"><a class="reference internal" href="memcached_strerror.html#see-also">SEE ALSO</a></li>
-</ul>
-</li>
-<li class="toctree-l1"><a class="reference internal" href="error_messages.html">Client Error messages</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_AUTH_CONTINUE.html">MEMCACHED_AUTH_CONTINUE</a></li>
-<li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_AUTH_FAILURE.html">MEMCACHED_AUTH_FAILURE</a></li>
-<li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_AUTH_PROBLEM.html">MEMCACHED_AUTH_PROBLEM</a></li>
-<li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_BAD_KEY_PROVIDED.html">MEMCACHED_BAD_KEY_PROVIDED</a></li>
-<li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_BUFFERED.html">MEMCACHED_BUFFERED</a></li>
-<li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_CLIENT_ERROR.html">MEMCACHED_CLIENT_ERROR</a></li>
-<li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_CONNECTION_BIND_FAILURE.html">MEMCACHED_CONNECTION_BIND_FAILURE</a></li>
-<li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_CONNECTION_FAILURE.html">MEMCACHED_CONNECTION_FAILURE</a></li>
-<li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_CONNECTION_SOCKET_CREATE_FAILURE.html">MEMCACHED_CONNECTION_SOCKET_CREATE_FAILURE</a></li>
-<li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_DATA_DOES_NOT_EXIST.html">MEMCACHED_DATA_DOES_NOT_EXIST</a></li>
-<li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_DATA_EXISTS.html">MEMCACHED_DATA_EXISTS</a></li>
-<li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_DELETED.html">MEMCACHED_DELETED</a></li>
-<li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_DEPRECATED.html">MEMCACHED_DEPRECATED</a></li>
-<li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_E2BIG.html">MEMCACHED_E2BIG</a></li>
-<li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_END.html">MEMCACHED_END</a></li>
-<li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_ERRNO.html">MEMCACHED_ERRNO</a></li>
-<li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_FAILURE.html">MEMCACHED_FAILURE</a></li>
-<li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_FAIL_UNIX_SOCKET.html">MEMCACHED_FAIL_UNIX_SOCKET</a></li>
-<li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_FETCH_NOTFINISHED.html">MEMCACHED_FETCH_NOTFINISHED</a></li>
-<li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_HOST_LOOKUP_FAILURE.html">MEMCACHED_HOST_LOOKUP_FAILURE</a></li>
-<li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_INVALID_ARGUMENTS.html">MEMCACHED_INVALID_ARGUMENTS</a></li>
-<li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_INVALID_HOST_PROTOCOL.html">MEMCACHED_INVALID_HOST_PROTOCOL</a></li>
-<li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_ITEM.html">MEMCACHED_ITEM</a></li>
-<li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_KEY_TOO_BIG.html">MEMCACHED_KEY_TOO_BIG</a></li>
-<li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_MAXIMUM_RETURN.html">MEMCACHED_MAXIMUM_RETURN</a></li>
-<li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_MEMORY_ALLOCATION_FAILURE.html">MEMCACHED_MEMORY_ALLOCATION_FAILURE</a></li>
-<li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_NOTFOUND.html">MEMCACHED_NOTFOUND</a></li>
-<li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_NOTSTORED.html">MEMCACHED_NOTSTORED</a></li>
-<li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_NOT_SUPPORTED.html">MEMCACHED_NOT_SUPPORTED</a></li>
-<li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_NO_KEY_PROVIDED.html">MEMCACHED_NO_KEY_PROVIDED</a></li>
-<li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_NO_SERVERS.html">MEMCACHED_NO_SERVERS</a></li>
-<li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_PARSE_ERROR.html">MEMCACHED_PARSE_ERROR</a></li>
-<li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_PARSE_USER_ERROR.html">MEMCACHED_PARSE_USER_ERROR</a></li>
-<li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_PARTIAL_READ.html">MEMCACHED_PARTIAL_READ</a></li>
-<li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_PROTOCOL_ERROR.html">MEMCACHED_PROTOCOL_ERROR</a></li>
-<li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_READ_FAILURE.html">MEMCACHED_READ_FAILURE</a></li>
-<li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_SERVER_ERROR.html">MEMCACHED_SERVER_ERROR</a></li>
-<li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_SERVER_MARKED_DEAD.html">MEMCACHED_SERVER_MARKED_DEAD</a></li>
-<li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_SOME_ERRORS.html">MEMCACHED_SOME_ERRORS</a></li>
-<li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_STAT.html">MEMCACHED_STAT</a></li>
-<li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_STORED.html">MEMCACHED_STORED</a></li>
-<li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_SUCCESS.html">MEMCACHED_SUCCESS</a></li>
-<li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_TIMEOUT.html">MEMCACHED_TIMEOUT</a></li>
-<li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_UNKNOWN_READ_FAILURE.html">MEMCACHED_UNKNOWN_READ_FAILURE</a></li>
-<li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_UNKNOWN_STAT_KEY.html">MEMCACHED_UNKNOWN_STAT_KEY</a></li>
-<li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_VALUE.html">MEMCACHED_VALUE</a></li>
-<li class="toctree-l2"><a class="reference internal" href="client_errors/MEMCACHED_WRITE_FAILURE.html">MEMCACHED_WRITE_FAILURE</a></li>
-</ul>
-</li>
-<li class="toctree-l1"><a class="reference internal" href="memcached_user_data.html">Storing custom user information in the client.</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="memcached_user_data.html#library">LIBRARY</a></li>
-<li class="toctree-l2"><a class="reference internal" href="memcached_user_data.html#synopsis">SYNOPSIS</a></li>
-<li class="toctree-l2"><a class="reference internal" href="memcached_user_data.html#description">DESCRIPTION</a></li>
-<li class="toctree-l2"><a class="reference internal" href="memcached_user_data.html#return">RETURN</a></li>
-<li class="toctree-l2"><a class="reference internal" href="memcached_user_data.html#see-also">SEE ALSO</a></li>
-</ul>
-</li>
-<li class="toctree-l1"><a class="reference internal" href="memcached_verbosity.html">Setting the verbosity of a server</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="memcached_verbosity.html#synopsis">SYNOPSIS</a></li>
-<li class="toctree-l2"><a class="reference internal" href="memcached_verbosity.html#description">DESCRIPTION</a></li>
-<li class="toctree-l2"><a class="reference internal" href="memcached_verbosity.html#return">RETURN</a></li>
-<li class="toctree-l2"><a class="reference internal" href="memcached_verbosity.html#see-also">SEE ALSO</a></li>
-</ul>
-</li>
-<li class="toctree-l1"><a class="reference internal" href="memcached_version.html">Getting version information about the client and server</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="memcached_version.html#synopsis">SYNOPSIS</a></li>
-<li class="toctree-l2"><a class="reference internal" href="memcached_version.html#description">DESCRIPTION</a></li>
-<li class="toctree-l2"><a class="reference internal" href="memcached_version.html#return">RETURN</a></li>
-<li class="toctree-l2"><a class="reference internal" href="memcached_version.html#see-also">SEE ALSO</a></li>
-</ul>
-</li>
-<li class="toctree-l1"><a class="reference internal" href="libmemcached/defaults.html">DEFAULTS</a></li>
-</ul>
-<p class="caption"><span class="caption-text">Interface Versions</span></p>
+<p class="caption"><span class="caption-text">libhashkit</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="libmemcached-1.0/index.html">libmemcached 1.0 API</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="libmemcached-1.0/memcached_touch.html">memcached_touch, memcached_touch_by_key</a></li>
-</ul>
-</li>
-<li class="toctree-l1"><a class="reference internal" href="libmemcached-1.1/index.html">libmemcached 1.1 API</a></li>
-</ul>
-<p class="caption"><span class="caption-text">Deprecated Functions</span></p>
-<ul>
-<li class="toctree-l1"><a class="reference internal" href="libmemcached/memcached_fetch.html">memcached_fetch</a></li>
-</ul>
-<p class="caption"><span class="caption-text">Platform Specifics</span></p>
-<ul>
-<li class="toctree-l1"><a class="reference internal" href="tap.html">Systemtap support</a></li>
-<li class="toctree-l1"><a class="reference internal" href="types.html">Required C types</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="types.html#types">Types</a></li>
-<li class="toctree-l2"><a class="reference internal" href="types.html#c-types-used">C Types Used</a></li>
-</ul>
-</li>
-</ul>
-<p class="caption"><span class="caption-text">Deriving Statistics from a Server</span></p>
-<ul>
-<li class="toctree-l1"><a class="reference internal" href="memcached_analyze.html">Analyzing servers</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="memcached_analyze.html#synopsis">SYNOPSIS</a></li>
-<li class="toctree-l2"><a class="reference internal" href="memcached_analyze.html#description">DESCRIPTION</a></li>
-<li class="toctree-l2"><a class="reference internal" href="memcached_analyze.html#return">RETURN</a></li>
-<li class="toctree-l2"><a class="reference internal" href="memcached_analyze.html#see-also">SEE ALSO</a></li>
-</ul>
-</li>
-<li class="toctree-l1"><a class="reference internal" href="memcached_stats.html">Working with statistical information from a server</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="memcached_stats.html#synopsis">SYNOPSIS</a></li>
-<li class="toctree-l2"><a class="reference internal" href="memcached_stats.html#description">DESCRIPTION</a></li>
-<li class="toctree-l2"><a class="reference internal" href="memcached_stats.html#return">RETURN</a></li>
-<li class="toctree-l2"><a class="reference internal" href="memcached_stats.html#see-also">SEE ALSO</a></li>
-</ul>
-</li>
-</ul>
-<p class="caption"><span class="caption-text">Libmemcachedutil</span></p>
-<ul>
-<li class="toctree-l1"><a class="reference internal" href="libmemcachedutil.html">Introducing libmemcachedutil</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="libmemcachedutil.html#synopsis">SYNOPSIS</a></li>
-<li class="toctree-l2"><a class="reference internal" href="libmemcachedutil.html#description">DESCRIPTION</a></li>
-<li class="toctree-l2"><a class="reference internal" href="libmemcachedutil.html#threads">THREADS</a></li>
-<li class="toctree-l2"><a class="reference internal" href="libmemcachedutil.html#see-also">SEE ALSO</a></li>
-</ul>
-</li>
-<li class="toctree-l1"><a class="reference internal" href="memcached_pool.html">Working with memcached pools</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="memcached_pool.html#synopsis">SYNOPSIS</a></li>
-<li class="toctree-l2"><a class="reference internal" href="memcached_pool.html#description">DESCRIPTION</a></li>
-<li class="toctree-l2"><a class="reference internal" href="memcached_pool.html#return">RETURN</a></li>
-<li class="toctree-l2"><a class="reference internal" href="memcached_pool.html#see-also">SEE ALSO</a></li>
+<li class="toctree-l1"><a class="reference internal" href="libhashkit.html">Introduction</a></li>
+<li class="toctree-l1"><a class="reference internal" href="libhashkit/index.html">libhashkit API</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="libhashkit/hashkit_create.html">Creating a hashkit structure</a></li>
+<li class="toctree-l2"><a class="reference internal" href="libhashkit/hashkit_function.html">Set Hash Function</a></li>
+<li class="toctree-l2"><a class="reference internal" href="libhashkit/hashkit_functions.html">Available Hashes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="libhashkit/hashkit_value.html">Generate hash value</a></li>
</ul>
</li>
</ul>
<p class="caption"><span class="caption-text">Client Applications</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="bin/memcapable.html">memcapable - Checking a Memcached server capabilities and compatibility</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="bin/memcapable.html#synopsis">SYNOPSIS</a></li>
-<li class="toctree-l2"><a class="reference internal" href="bin/memcapable.html#description">DESCRIPTION</a></li>
-<li class="toctree-l2"><a class="reference internal" href="bin/memcapable.html#limitations">LIMITATIONS</a></li>
-<li class="toctree-l2"><a class="reference internal" href="bin/memcapable.html#options">OPTIONS</a></li>
-<li class="toctree-l2"><a class="reference internal" href="bin/memcapable.html#see-also">SEE ALSO</a></li>
-</ul>
-</li>
-<li class="toctree-l1"><a class="reference internal" href="bin/memcat.html">memcat - “cat” data from a server</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="bin/memcat.html#synopsis">SYNOPSIS</a></li>
-<li class="toctree-l2"><a class="reference internal" href="bin/memcat.html#description">DESCRIPTION</a></li>
-<li class="toctree-l2"><a class="reference internal" href="bin/memcat.html#options">OPTIONS</a></li>
-<li class="toctree-l2"><a class="reference internal" href="bin/memcat.html#see-also">SEE ALSO</a></li>
-</ul>
-</li>
-<li class="toctree-l1"><a class="reference internal" href="bin/memcp.html">memcp - Copy data to a server</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="bin/memcp.html#synopsis">SYNOPSIS</a></li>
-<li class="toctree-l2"><a class="reference internal" href="bin/memcp.html#description">DESCRIPTION</a></li>
-<li class="toctree-l2"><a class="reference internal" href="bin/memcp.html#options">OPTIONS</a></li>
-<li class="toctree-l2"><a class="reference internal" href="bin/memcp.html#see-also">SEE ALSO</a></li>
-</ul>
-</li>
-<li class="toctree-l1"><a class="reference internal" href="bin/memdump.html">memdump - Dumping your server</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="bin/memdump.html#synopsis">SYNOPSIS</a></li>
-<li class="toctree-l2"><a class="reference internal" href="bin/memdump.html#description">DESCRIPTION</a></li>
-<li class="toctree-l2"><a class="reference internal" href="bin/memdump.html#options">OPTIONS</a></li>
-<li class="toctree-l2"><a class="reference internal" href="bin/memdump.html#see-also">SEE ALSO</a></li>
-</ul>
-</li>
-<li class="toctree-l1"><a class="reference internal" href="bin/memerror.html">memerror - translate an error code to a string</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="bin/memerror.html#synopsis">SYNOPSIS</a></li>
-<li class="toctree-l2"><a class="reference internal" href="bin/memerror.html#description">DESCRIPTION</a></li>
-<li class="toctree-l2"><a class="reference internal" href="bin/memerror.html#options">OPTIONS</a></li>
-<li class="toctree-l2"><a class="reference internal" href="bin/memerror.html#see-also">SEE ALSO</a></li>
-</ul>
-</li>
-<li class="toctree-l1"><a class="reference internal" href="bin/memflush.html">memflush - flush all data from a server</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="bin/memflush.html#synopsis">SYNOPSIS</a></li>
-<li class="toctree-l2"><a class="reference internal" href="bin/memflush.html#description">DESCRIPTION</a></li>
-<li class="toctree-l2"><a class="reference internal" href="bin/memflush.html#options">OPTIONS</a></li>
-<li class="toctree-l2"><a class="reference internal" href="bin/memflush.html#see-also">SEE ALSO</a></li>
-</ul>
-</li>
-<li class="toctree-l1"><a class="reference internal" href="bin/memrm.html">memrm - Remove data from a server</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="bin/memrm.html#synopsis">SYNOPSIS</a></li>
-<li class="toctree-l2"><a class="reference internal" href="bin/memrm.html#description">DESCRIPTION</a></li>
-<li class="toctree-l2"><a class="reference internal" href="bin/memrm.html#options">OPTIONS</a></li>
-<li class="toctree-l2"><a class="reference internal" href="bin/memrm.html#see-also">SEE ALSO</a></li>
-</ul>
-</li>
-<li class="toctree-l1"><a class="reference internal" href="bin/memslap.html">memslap - Load testing and benchmarking a server</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="bin/memslap.html#synopsis">SYNOPSIS</a></li>
-<li class="toctree-l2"><a class="reference internal" href="bin/memslap.html#description">DESCRIPTION</a></li>
-<li class="toctree-l2"><a class="reference internal" href="bin/memslap.html#options">OPTIONS</a></li>
-<li class="toctree-l2"><a class="reference internal" href="bin/memslap.html#see-also">SEE ALSO</a></li>
-</ul>
-</li>
-<li class="toctree-l1"><a class="reference internal" href="bin/memaslap.html">memaslap - Load testing and benchmarking a server</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="bin/memaslap.html#synopsis">SYNOPSIS</a></li>
-<li class="toctree-l2"><a class="reference internal" href="bin/memaslap.html#description">DESCRIPTION</a></li>
-<li class="toctree-l2"><a class="reference internal" href="bin/memaslap.html#features">FEATURES</a></li>
-<li class="toctree-l2"><a class="reference internal" href="bin/memaslap.html#details">DETAILS</a></li>
-<li class="toctree-l2"><a class="reference internal" href="bin/memaslap.html#usage">USAGE</a></li>
-<li class="toctree-l2"><a class="reference internal" href="bin/memaslap.html#configuration-file">Configuration file</a></li>
-<li class="toctree-l2"><a class="reference internal" href="bin/memaslap.html#format-of-output">Format of output</a></li>
-<li class="toctree-l2"><a class="reference internal" href="bin/memaslap.html#options">OPTIONS</a></li>
-<li class="toctree-l2"><a class="reference internal" href="bin/memaslap.html#examples">EXAMPLES</a></li>
-<li class="toctree-l2"><a class="reference internal" href="bin/memaslap.html#see-also">SEE ALSO</a></li>
-</ul>
-</li>
-<li class="toctree-l1"><a class="reference internal" href="bin/memstat.html">memstat - Gather statistics from a server</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="bin/memstat.html#synopsis">SYNOPSIS</a></li>
-<li class="toctree-l2"><a class="reference internal" href="bin/memstat.html#description">DESCRIPTION</a></li>
-<li class="toctree-l2"><a class="reference internal" href="bin/memstat.html#options">OPTIONS</a></li>
-<li class="toctree-l2"><a class="reference internal" href="bin/memstat.html#see-also">SEE ALSO</a></li>
-</ul>
-</li>
-<li class="toctree-l1"><a class="reference internal" href="bin/memexist.html">memexist - Check for the existence of a key</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="bin/memexist.html#synopsis">SYNOPSIS</a></li>
-<li class="toctree-l2"><a class="reference internal" href="bin/memexist.html#description">DESCRIPTION</a></li>
-<li class="toctree-l2"><a class="reference internal" href="bin/memexist.html#options">OPTIONS</a></li>
-<li class="toctree-l2"><a class="reference internal" href="bin/memexist.html#see-also">SEE ALSO</a></li>
-</ul>
-</li>
-<li class="toctree-l1"><a class="reference internal" href="bin/memparse.html">memparse - Parse an option string</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="bin/memparse.html#synopsis">SYNOPSIS</a></li>
-<li class="toctree-l2"><a class="reference internal" href="bin/memparse.html#description">DESCRIPTION</a></li>
-<li class="toctree-l2"><a class="reference internal" href="bin/memparse.html#options">OPTIONS</a></li>
-<li class="toctree-l2"><a class="reference internal" href="bin/memparse.html#see-also">SEE ALSO</a></li>
-</ul>
-</li>
-<li class="toctree-l1"><a class="reference internal" href="bin/memping.html">memping - Test to see if a server is available.</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="bin/memping.html#synopsis">SYNOPSIS</a></li>
-<li class="toctree-l2"><a class="reference internal" href="bin/memping.html#description">DESCRIPTION</a></li>
-<li class="toctree-l2"><a class="reference internal" href="bin/memping.html#options">OPTIONS</a></li>
-<li class="toctree-l2"><a class="reference internal" href="bin/memping.html#see-also">SEE ALSO</a></li>
-</ul>
-</li>
-<li class="toctree-l1"><a class="reference internal" href="bin/memtouch.html">memtouch - Touches a key.</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="bin/memtouch.html#synopsis">SYNOPSIS</a></li>
-<li class="toctree-l2"><a class="reference internal" href="bin/memtouch.html#description">DESCRIPTION</a></li>
-<li class="toctree-l2"><a class="reference internal" href="bin/memtouch.html#options">OPTIONS</a></li>
-<li class="toctree-l2"><a class="reference internal" href="bin/memtouch.html#see-also">SEE ALSO</a></li>
-</ul>
-</li>
-</ul>
-<p class="caption"><span class="caption-text">Libhashkit</span></p>
-<ul>
-<li class="toctree-l1"><a class="reference internal" href="libhashkit.html">Introducing libhashkit</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="libhashkit.html#description">DESCRIPTION</a></li>
-<li class="toctree-l2"><a class="reference internal" href="libhashkit.html#see-also">SEE ALSO</a></li>
-</ul>
-</li>
-<li class="toctree-l1"><a class="reference internal" href="hashkit_create.html">Creating a hashkit structure</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="hashkit_create.html#synopsis">SYNOPSIS</a></li>
-<li class="toctree-l2"><a class="reference internal" href="hashkit_create.html#description">DESCRIPTION</a></li>
-<li class="toctree-l2"><a class="reference internal" href="hashkit_create.html#return-value">RETURN VALUE</a></li>
-<li class="toctree-l2"><a class="reference internal" href="hashkit_create.html#see-also">SEE ALSO</a></li>
-</ul>
-</li>
-<li class="toctree-l1"><a class="reference internal" href="hashkit_functions.html">Available Hashes</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="hashkit_functions.html#synopsis">SYNOPSIS</a></li>
-<li class="toctree-l2"><a class="reference internal" href="hashkit_functions.html#description">DESCRIPTION</a></li>
-<li class="toctree-l2"><a class="reference internal" href="hashkit_functions.html#return-value">RETURN VALUE</a></li>
-<li class="toctree-l2"><a class="reference internal" href="hashkit_functions.html#see-also">SEE ALSO</a></li>
-</ul>
-</li>
-<li class="toctree-l1"><a class="reference internal" href="hashkit_value.html">hashkit_value</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="hashkit_value.html#synopsis">SYNOPSIS</a></li>
-<li class="toctree-l2"><a class="reference internal" href="hashkit_value.html#description">DESCRIPTION</a></li>
-<li class="toctree-l2"><a class="reference internal" href="hashkit_value.html#return-value">RETURN VALUE</a></li>
-<li class="toctree-l2"><a class="reference internal" href="hashkit_value.html#see-also">SEE ALSO</a></li>
+<li class="toctree-l1"><a class="reference internal" href="bin/index.html">Client Applications</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="bin/memcapable.html">memcapable - Checking a Memcached server capabilities and compatibility</a></li>
+<li class="toctree-l2"><a class="reference internal" href="bin/memcat.html">memcat - “cat” data from a server</a></li>
+<li class="toctree-l2"><a class="reference internal" href="bin/memcp.html">memcp - Copy data to a server</a></li>
+<li class="toctree-l2"><a class="reference internal" href="bin/memdump.html">memdump - Dumping your server</a></li>
+<li class="toctree-l2"><a class="reference internal" href="bin/memerror.html">memerror - translate an error code to a string</a></li>
+<li class="toctree-l2"><a class="reference internal" href="bin/memflush.html">memflush - flush all data from a server</a></li>
+<li class="toctree-l2"><a class="reference internal" href="bin/memrm.html">memrm - Remove data from a server</a></li>
+<li class="toctree-l2"><a class="reference internal" href="bin/memslap.html">memslap - Load testing and benchmarking a server</a></li>
+<li class="toctree-l2"><a class="reference internal" href="bin/memaslap.html">memaslap - Load testing and benchmarking a server</a></li>
+<li class="toctree-l2"><a class="reference internal" href="bin/memstat.html">memstat - Gather statistics from a server</a></li>
+<li class="toctree-l2"><a class="reference internal" href="bin/memexist.html">memexist - Check for the existence of a key</a></li>
+<li class="toctree-l2"><a class="reference internal" href="bin/memparse.html">memparse - Parse an option string</a></li>
+<li class="toctree-l2"><a class="reference internal" href="bin/memping.html">memping - Test to see if a server is available.</a></li>
+<li class="toctree-l2"><a class="reference internal" href="bin/memtouch.html">memtouch - Touches a key.</a></li>
</ul>
</li>
</ul>
<li><a href="index.html">Docs</a> »</li>
- <li>Introducing the C Client Library for memcached</li>
+ <li>C/C++ Client Library for memcached</li>
<li class="wy-breadcrumbs-aside">
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
- <div class="section" id="introducing-the-c-client-library-for-memcached">
-<h1>Introducing the C Client Library for memcached<a class="headerlink" href="#introducing-the-c-client-library-for-memcached" title="Permalink to this headline">¶</a></h1>
+ <div class="section" id="c-c-client-library-for-memcached">
+<h1>C/C++ Client Library for memcached<a class="headerlink" href="#c-c-client-library-for-memcached" title="Permalink to this headline">¶</a></h1>
<div class="section" id="synopsis">
<h2>SYNOPSIS<a class="headerlink" href="#synopsis" title="Permalink to this headline">¶</a></h2>
-<p>#include <libmemcached/memcached.h></p>
-<p>Compile and link with -lmemcached</p>
+<dl class="simple">
+<dt>#include <libmemcached/memcached.h></dt><dd><p>Compile and link with -lmemcached</p>
+</dd>
+</dl>
<hr class="docutils" />
-<p>libMemcached is an open source C/C++ client library and tools for the memcached server (<a class="reference external" href="http://memcached.org/">http://memcached.org/</a>). It has been designed to be light on memory usage, thread safe, and provide full access to server side methods.</p>
-<p>libMemcached was designed to provide the greatest number of options to use Memcached. Some of the features provided:</p>
+<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
+memcached server (<a class="reference external" href="http://memcached.org/">http://memcached.org/</a>). It has been designed to be light on
+memory usage, thread safe, and provide full access to server side methods.</p>
+<p><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">libmemcached</span></code> was designed to provide the greatest number of options to use
+Memcached. Some of the features provided:</p>
<ol class="arabic simple">
<li><p>Asynchronous and Synchronous Transport Support.</p></li>
<li><p>Consistent Hashing and Distribution.</p></li>
<h2>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
<p>“Memcached is a high-performance, distributed memory object caching
system, generic in nature, but intended for use in speeding up dynamic web
-applications by alleviating database load.” <a class="reference external" href="http://memcached.org/">http://memcached.org/</a></p>
-<p><strong class="program">libmemcached</strong> is a small, thread-safe client library for the
+applications by alleviating database load.”
+<a class="reference external" href="http://memcached.org/">http://memcached.org/</a></p>
+<p><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">libmemcached</span></code> is a small, thread-safe client library for the
memcached protocol. The code has all been written to allow
for both web and embedded usage. It handles the work behind routing
individual keys to specific servers specified by the developer (and values are
matched based on server order as supplied by the user). It implements
a modular and consistent method of object distribution.</p>
<p>There are multiple implemented routing and hashing methods. See the
-<a class="reference internal" href="memcached_behavior.html#c.memcached_behavior_set" title="memcached_behavior_set"><code class="xref c c-func docutils literal notranslate"><span class="pre">memcached_behavior_set()</span></code></a> manpage for more information.</p>
-<p>All operations are performed against a <a class="reference internal" href="memcached_create.html#c.memcached_st" title="memcached_st"><code class="xref c c-type docutils literal notranslate"><span class="pre">memcached_st</span></code></a> structure.
+<a class="reference internal" href="libmemcached/memcached_behavior.html#_CPPv422memcached_behavior_setP12memcached_st20memcached_behavior_t8uint64_t" title="memcached_behavior_set"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_behavior_set()</span></code></a> manpage for more information.</p>
+<p>All operations are performed against a <a class="reference internal" href="libmemcached/memcached_create.html#_CPPv412memcached_st" title="memcached_st"><code class="xref cpp cpp-type docutils literal notranslate"><span class="pre">memcached_st</span></code></a> structure.
These structures can either be dynamically allocated or statically
-allocated and then initialized by <a class="reference internal" href="memcached_create.html#c.memcached_create" title="memcached_create"><code class="xref c c-func docutils literal notranslate"><span class="pre">memcached_create()</span></code></a>. Functions have
-been written in order to encapsulate the <a class="reference internal" href="memcached_create.html#c.memcached_st" title="memcached_st"><code class="xref c c-type docutils literal notranslate"><span class="pre">memcached_st</span></code></a>. It is not
+allocated and then initialized by <a class="reference internal" href="libmemcached/memcached_create.html#_CPPv416memcached_createP12memcached_st" title="memcached_create"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_create()</span></code></a>. Functions have
+been written in order to encapsulate the <a class="reference internal" href="libmemcached/memcached_create.html#_CPPv412memcached_st" title="memcached_st"><code class="xref cpp cpp-type docutils literal notranslate"><span class="pre">memcached_st</span></code></a>. It is not
recommended that you operate directly against the structure.</p>
-<p>Nearly all functions return a <a class="reference internal" href="libmemcached/memcached_return_t.html#c.memcached_return_t" title="memcached_return_t"><code class="xref c c-type docutils literal notranslate"><span class="pre">memcached_return_t</span></code></a> value.
+<p>Nearly all functions return a <a class="reference internal" href="libmemcached/memcached_return_t.html#_CPPv418memcached_return_t" title="memcached_return_t"><code class="xref cpp cpp-type docutils literal notranslate"><span class="pre">memcached_return_t</span></code></a> value.
This value can be translated to a printable string with
-<a class="reference internal" href="memcached_strerror.html#c.memcached_strerror" title="memcached_strerror"><code class="xref c c-type docutils literal notranslate"><span class="pre">memcached_strerror</span></code></a>.</p>
-<p>Objects are stored on servers by hashing keys. The hash value maps the key to a particular server. All clients understand how this hashing works, so it is possibly to reliably both push data to a server and retrieve data from a server.</p>
+<a class="reference internal" href="libmemcached/memcached_strerror.html#_CPPv418memcached_strerrorP12memcached_st18memcached_return_t" title="memcached_strerror"><code class="xref cpp cpp-type docutils literal notranslate"><span class="pre">memcached_strerror</span></code></a>.</p>
+<p>Objects are stored on servers by hashing keys. The hash value maps the key to a
+particular server. All clients understand how this hashing works, so it is
+possibly to reliably both push data to a server and retrieve data from a server.</p>
<p>Group keys can be optionally used to group sets of objects with servers.</p>
-<p>Namespaces are supported, and can be used to partition caches so that multiple applications can use the same memcached servers.</p>
-<p><a class="reference internal" href="memcached_create.html#c.memcached_st" title="memcached_st"><code class="xref c c-type docutils literal notranslate"><span class="pre">memcached_st</span></code></a> structures are thread-safe, but each thread must
-contain its own structure (that is, if you want to share these among
-threads you must provide your own locking). No global variables are
-used in this library.</p>
-<p>If you are working with GNU autotools you will want to add the following to
-your COPYING to properly include libmemcached in your application.</p>
-<p>PKG_CHECK_MODULES(DEPS, libmemcached >= 0.8.0)
-AC_SUBST(DEPS_CFLAGS)
-AC_SUBST(DEPS_LIBS)</p>
-<p>Some features of the library must be enabled through <a class="reference internal" href="memcached_behavior.html#c.memcached_behavior_set" title="memcached_behavior_set"><code class="xref c c-func docutils literal notranslate"><span class="pre">memcached_behavior_set()</span></code></a>.</p>
-<p>Hope you enjoy it!</p>
+<p>Namespaces are supported, and can be used to partition caches so that multiple
+applications can use the same memcached servers.</p>
+<p>Some features of the library must be enabled through <a class="reference internal" href="libmemcached/memcached_behavior.html#_CPPv422memcached_behavior_setP12memcached_st20memcached_behavior_t8uint64_t" title="memcached_behavior_set"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_behavior_set()</span></code></a>.</p>
</div>
<div class="section" id="constants">
<h2>CONSTANTS<a class="headerlink" href="#constants" title="Permalink to this headline">¶</a></h2>
<p>A number of constants have been provided for in the library.</p>
-<dl class="macro">
-<dt id="c.MEMCACHED_DEFAULT_PORT">
-<code class="sig-name descname">MEMCACHED_DEFAULT_PORT</code><a class="headerlink" href="#c.MEMCACHED_DEFAULT_PORT" title="Permalink to this definition">¶</a></dt>
-<dd><p>The default port used by memcached(3).</p>
-</dd></dl>
-
-<dl class="macro">
-<dt id="c.MEMCACHED_MAX_KEY">
-<code class="sig-name descname">MEMCACHED_MAX_KEY</code><a class="headerlink" href="#c.MEMCACHED_MAX_KEY" title="Permalink to this definition">¶</a></dt>
-<dd><p>Default maximum size of a key (which includes the null pointer). Master keys
-have no limit, this only applies to keys used for storage.</p>
-</dd></dl>
-
-<dl class="macro">
-<dt id="c.MEMCACHED_MAX_BUFFER">
-<code class="sig-name descname">MEMCACHED_MAX_BUFFER</code><a class="headerlink" href="#c.MEMCACHED_MAX_BUFFER" title="Permalink to this definition">¶</a></dt>
-<dd><p>Default size of read/write buffers (which includes the null pointer).</p>
-</dd></dl>
-
-<dl class="macro">
-<dt id="c.MEMCACHED_STRIDE">
-<code class="sig-name descname">MEMCACHED_STRIDE</code><a class="headerlink" href="#c.MEMCACHED_STRIDE" title="Permalink to this definition">¶</a></dt>
-<dd><p>This is the “stride” used in the consistent hash used between replicas.</p>
-</dd></dl>
-
-<dl class="macro">
-<dt id="c.MEMCACHED_MAX_HOST_LENGTH">
-<code class="sig-name descname">MEMCACHED_MAX_HOST_LENGTH</code><a class="headerlink" href="#c.MEMCACHED_MAX_HOST_LENGTH" title="Permalink to this definition">¶</a></dt>
-<dd><p>Maximum allowed size of the hostname.</p>
-</dd></dl>
-
-<dl class="macro">
-<dt id="c.LIBMEMCACHED_VERSION_STRING">
-<code class="sig-name descname">LIBMEMCACHED_VERSION_STRING</code><a class="headerlink" href="#c.LIBMEMCACHED_VERSION_STRING" title="Permalink to this definition">¶</a></dt>
-<dd><p>String value of libmemcached version such as “1.23.4”</p>
-</dd></dl>
-
-<dl class="macro">
-<dt id="c.LIBMEMCACHED_VERSION_HEX">
-<code class="sig-name descname">LIBMEMCACHED_VERSION_HEX</code><a class="headerlink" href="#c.LIBMEMCACHED_VERSION_HEX" title="Permalink to this definition">¶</a></dt>
-<dd><p>Hex value of the version number. “0x00048000” This can be used for comparing versions based on number.</p>
-</dd></dl>
-
-<dl class="macro">
-<dt id="c.MEMCACHED_PREFIX_KEY_MAX_SIZE">
-<code class="sig-name descname">MEMCACHED_PREFIX_KEY_MAX_SIZE</code><a class="headerlink" href="#c.MEMCACHED_PREFIX_KEY_MAX_SIZE" title="Permalink to this definition">¶</a></dt>
-<dd><p>Maximum length allowed for namespacing of a key.</p>
-</dd></dl>
-
+<p>See <a class="reference internal" href="libmemcached/constants.html"><span class="doc">libmemcached Constants and Defaults</span></a>.</p>
</div>
<div class="section" id="threads-and-processes">
<h2>THREADS AND PROCESSES<a class="headerlink" href="#threads-and-processes" title="Permalink to this headline">¶</a></h2>
-<p>When using threads or forked processes it is important to keep one instance
-of <a class="reference internal" href="memcached_create.html#c.memcached_st" title="memcached_st"><code class="xref c c-type docutils literal notranslate"><span class="pre">memcached_st</span></code></a> per process or thread. Without creating your own
-locking structures you can not share a single <a class="reference internal" href="memcached_create.html#c.memcached_st" title="memcached_st"><code class="xref c c-type docutils literal notranslate"><span class="pre">memcached_st</span></code></a>. However,
-you can call <a class="reference internal" href="memcached_quit.html#c.memcached_quit" title="memcached_quit"><code class="xref c c-func docutils literal notranslate"><span class="pre">memcached_quit()</span></code></a> on a <a class="reference internal" href="memcached_create.html#c.memcached_st" title="memcached_st"><code class="xref c c-type docutils literal notranslate"><span class="pre">memcached_st</span></code></a> and then use the resulting cloned structure.</p>
+<p>No global variables are used in this library.</p>
+<p><a class="reference internal" href="libmemcached/memcached_create.html#_CPPv412memcached_st" title="memcached_st"><code class="xref cpp cpp-type docutils literal notranslate"><span class="pre">memcached_st</span></code></a> structures are thread-safe, but when using threads or
+forked processes it is important to keep one instance of <a class="reference internal" href="libmemcached/memcached_create.html#_CPPv412memcached_st" title="memcached_st"><code class="xref cpp cpp-type docutils literal notranslate"><span class="pre">memcached_st</span></code></a>
+per process or thread. Without creating your own locking structures you can not
+share a single <a class="reference internal" href="libmemcached/memcached_create.html#_CPPv412memcached_st" title="memcached_st"><code class="xref cpp cpp-type docutils literal notranslate"><span class="pre">memcached_st</span></code></a>. However, you can call
+<a class="reference internal" href="libmemcached/memcached_quit.html#_CPPv414memcached_quitP12memcached_st" title="memcached_quit"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_quit()</span></code></a> on a <a class="reference internal" href="libmemcached/memcached_create.html#_CPPv412memcached_st" title="memcached_st"><code class="xref cpp cpp-type docutils literal notranslate"><span class="pre">memcached_st</span></code></a> and then use the resulting
+cloned structure.</p>
+</div>
+<div class="section" id="systemtap">
+<h2>SYSTEMTAP<a class="headerlink" href="#systemtap" title="Permalink to this headline">¶</a></h2>
+<p><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">libmemcached</span></code> can be built to support Systemtap on Linux when enabled at
+compile time.</p>
+<p>Please see <em class="manpage"><a class="manpage reference external" href="http://man7.org/linux/man-pages/man1/stap.1.html">stap(1)</a></em> and <em class="manpage"><a class="manpage reference external" href="http://man7.org/linux/man-pages/man1/dtrace.1.html">dtrace(1)</a></em> for more information
+about Systemtap.</p>
+</div>
+<div class="section" id="client-programs">
+<h2>CLIENT PROGRAMS<a class="headerlink" href="#client-programs" title="Permalink to this headline">¶</a></h2>
+<p><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">libmemcached</span></code> comes with a few useful client programs:</p>
+<ul class="simple">
+<li><p><a class="reference internal" href="bin/memaslap.html"><span class="doc">memaslap - Load testing and benchmarking a server</span></a></p></li>
+<li><p><a class="reference internal" href="bin/memcapable.html"><span class="doc">memcapable - Checking a Memcached server capabilities and compatibility</span></a></p></li>
+<li><p><a class="reference internal" href="bin/memcat.html"><span class="doc">memcat - “cat” data from a server</span></a></p></li>
+<li><p><a class="reference internal" href="bin/memcp.html"><span class="doc">memcp - Copy data to a server</span></a></p></li>
+<li><p><a class="reference internal" href="bin/memdump.html"><span class="doc">memdump - Dumping your server</span></a></p></li>
+<li><p><a class="reference internal" href="bin/memerror.html"><span class="doc">memerror - translate an error code to a string</span></a></p></li>
+<li><p><a class="reference internal" href="bin/memexist.html"><span class="doc">memexist - Check for the existence of a key</span></a></p></li>
+<li><p><a class="reference internal" href="bin/memflush.html"><span class="doc">memflush - flush all data from a server</span></a></p></li>
+<li><p><a class="reference internal" href="bin/memparse.html"><span class="doc">memparse - Parse an option string</span></a></p></li>
+<li><p><a class="reference internal" href="bin/memping.html"><span class="doc">memping - Test to see if a server is available.</span></a></p></li>
+<li><p><a class="reference internal" href="bin/memrm.html"><span class="doc">memrm - Remove data from a server</span></a></p></li>
+<li><p><a class="reference internal" href="bin/memslap.html"><span class="doc">memslap - Load testing and benchmarking a server</span></a></p></li>
+<li><p><a class="reference internal" href="bin/memstat.html"><span class="doc">memstat - Gather statistics from a server</span></a></p></li>
+<li><p><a class="reference internal" href="bin/memtouch.html"><span class="doc">memtouch - Touches a key.</span></a></p></li>
+</ul>
+</div>
+<div class="section" id="utility-libraries">
+<h2>UTILITY LIBRARIES<a class="headerlink" href="#utility-libraries" title="Permalink to this headline">¶</a></h2>
+<ul class="simple">
+<li><p><a class="reference internal" href="libhashkit.html"><span class="doc">libhashkit - C/C++ hashing library</span></a></p></li>
+<li><p><a class="reference internal" href="libmemcachedutil.html"><span class="doc">libmemcachedutil - C/C++ utilities extending libmemcached</span></a></p></li>
+</ul>
</div>
<div class="section" id="see-also">
<h2>SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline">¶</a></h2>
-<p><em class="manpage">memcached(1)</em> <em class="manpage">libmemcached_examples(3)</em>
-<em class="manpage">libmemcached(1)</em> <em class="manpage">memcat(1)</em> <em class="manpage">memcp(1)</em>
-<em class="manpage">memflush(1)</em> <em class="manpage">memrm(1)</em> <em class="manpage">memslap(1)</em>
-<em class="manpage">memstat(1)</em> <em class="manpage">memcached_fetch(3)</em>
-<em class="manpage">memcached_replace(3)</em> <em class="manpage">memcached_server_list_free(3)</em>
-<em class="manpage">libmemcached_examples(3)</em> <em class="manpage">memcached_clone(3)</em>
-<em class="manpage">memcached_free(3)</em> <em class="manpage">memcached_server_add(3)</em>
-<em class="manpage">memcached_server_push(3)</em> <em class="manpage">memcached_add(3)</em>
-<em class="manpage">memcached_get(3)</em> <em class="manpage">memcached_server_count(3)</em>
-<em class="manpage">memcached_create(3)</em> <em class="manpage">memcached_increment(3)</em>
-<em class="manpage">memcached_server_list(3)</em> <em class="manpage">memcached_set(3)</em>
-<em class="manpage">memcached_decrement(3)</em> <em class="manpage">memcached_mget(3)</em>
-<em class="manpage">memcached_server_list_append(3)</em> <em class="manpage">memcached_strerror(3)</em>
-<em class="manpage">memcached_delete(3)</em> <em class="manpage">memcached_quit(3)</em>
-<em class="manpage">memcached_server_list_count(3)</em> <em class="manpage">memcached_verbosity(3)</em>
-<em class="manpage">memcached_server_add_unix_socket(3)</em>
-<em class="manpage">memcached_result_create(3)</em> <em class="manpage">memcached_result_free(3)</em>
-<em class="manpage">memcached_result_key_value(3)</em>
-<em class="manpage">memcached_result_key_length(3)</em>
-<em class="manpage">memcached_result_value(3)</em> <em class="manpage">memcached_result_length(3)</em>
-<em class="manpage">memcached_result_flags(3)</em> <em class="manpage">memcached_result_cas(3)</em>
-<em class="manpage">memcached_result_st(3)</em> <em class="manpage">memcached_append(3)</em>
-<em class="manpage">memcached_prepend(3)</em> <em class="manpage">memcached_fetch_result(3)</em>
-<em class="manpage">memerror(1)</em> <em class="manpage">memcached_get_by_key(3)</em>
-<em class="manpage">memcached_mget_by_key(3)</em> <em class="manpage">memcached_delete_by_key(3)</em>
-<em class="manpage">memcached_fetch_execute(3)</em> <em class="manpage">memcached_callback_get(3)</em>
-<em class="manpage">memcached_callback_set(3)</em> <em class="manpage">memcached_version(3)</em>
-<em class="manpage">memcached_lib_version(3)</em> <em class="manpage">memcached_result_set_value(3)</em>
-<em class="manpage">memcached_dump(3)</em> <em class="manpage">memdump(1)</em>
-<em class="manpage">memcached_set_memory_allocators(3)</em>
-<em class="manpage">memcached_get_memory_allocators(3)</em>
-<em class="manpage">memcached_get_user_data(3)</em> <em class="manpage">memcached_set_user_data(3)</em></p>
+<ul class="simple">
+<li><p><em class="manpage"><a class="manpage reference external" href="http://man7.org/linux/man-pages/man1/memcached.1.html">memcached(1)</a></em></p></li>
+<li><p><a class="reference internal" href="libmemcached/configuration.html"><span class="doc">libmemcached Configuration</span></a></p></li>
+<li><p><a class="reference internal" href="libmemcached/examples.html"><span class="doc">libmemcached Examples</span></a></p></li>
+</ul>
</div>
</div>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
- <a href="versioning.html" class="btn btn-neutral float-right" title="Versioning" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
+ <a href="libmemcached/index.html" class="btn btn-neutral float-right" title="libmemcached API" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
- <a href="index.html" class="btn btn-neutral float-left" title="Welcome to the libmemcached documentation" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+ <a href="index.html" class="btn btn-neutral float-left" title="libmemcached Manual" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
projects / awesomized / libmemcached / blobdiff