if(BUILD_DOCS)
set(SPHINX_OPTIONS ""
CACHE STRING "additional sphinx-build command line options")
- set(SPHINX_THEME "sphinx_rtd_theme"
+ set(SPHINX_THEME "nature" #"sphinx_rtd_theme"
CACHE STRING "sphinx HTML theme")
- set(SPHINX_THEME_OPTIONS "'collapse_navigation':False, 'navigation_depth':2, 'titles_only':False, 'includehidden':False"
+ set(SPHINX_THEME_OPTIONS "" #"'collapse_navigation':False, 'navigation_depth':2, 'titles_only':False, 'includehidden':False"
CACHE STRING "sphinx HTML theme options")
set(SPHINX_EXTENSIONS ""
CACHE STRING "comma separated list of quoted sphinx extensions")
--- /dev/null
+Client Applications
+===================
+
+.. toctree::
+ :titlesonly:
+
+ memcapable
+ memcat
+ memcp
+ memdump
+ memerror
+ memflush
+ memrm
+ memslap
+ memaslap
+ memstat
+ memexist
+ memparse
+ memping
+ memtouch
+++ /dev/null
-=======================
-MEMCACHED_AUTH_CONTINUE
-=======================
-
-.. c:type:: MEMCACHED_AUTH_CONTINUE
-
-Authentication has been paused.
+++ /dev/null
-======================
-MEMCACHED_AUTH_FAILURE
-======================
-
-.. c:type:: MEMCACHED_AUTH_FAILURE
-
-The credentials provided are not valid for this server.
+++ /dev/null
-======================
-MEMCACHED_AUTH_PROBLEM
-======================
-
-.. c:type:: MEMCACHED_AUTH_PROBLEM
-
-An unknown issue has occurred during authentication.
+++ /dev/null
-==========================
-MEMCACHED_BAD_KEY_PROVIDED
-==========================
-
-.. c:type:: MEMCACHED_BAD_KEY_PROVIDED
-
-The key provided is not a valid key.
+++ /dev/null
-==================
-MEMCACHED_BUFFERED
-==================
-
-.. c:type:: MEMCACHED_BUFFERED
-
-The request has been buffered.
+++ /dev/null
-======================
-MEMCACHED_CLIENT_ERROR
-======================
-
-.. c:type:: MEMCACHED_CLIENT_ERROR
-
-An unknown client error has occurred internally.
+++ /dev/null
-=================================
-MEMCACHED_CONNECTION_BIND_FAILURE
-=================================
-
-.. c:type:: MEMCACHED_CONNECTION_BIND_FAILURE
-.. deprecated:: <0.30
-
-We were not able to bind() to the socket.
+++ /dev/null
-============================
-MEMCACHED_CONNECTION_FAILURE
-============================
-
-.. c:type:: MEMCACHED_CONNECTION_FAILURE
-
-A unknown error has occurred while trying to connect to a server.
+++ /dev/null
-==========================================
-MEMCACHED_CONNECTION_SOCKET_CREATE_FAILURE
-==========================================
-
-.. c:type:: MEMCACHED_CONNECTION_SOCKET_CREATE_FAILURE
-.. deprecated:: <0.30
-
-An error has occurred while trying to connect to a server. It is likely that either the number of file descriptors need to be increased or you are out of memory.
+++ /dev/null
-=============================
-MEMCACHED_DATA_DOES_NOT_EXIST
-=============================
-
-.. c:type:: MEMCACHED_DATA_DOES_NOT_EXIST
-
-The data requested with the key given was not found.
+++ /dev/null
-=====================
-MEMCACHED_DATA_EXISTS
-=====================
-
-.. c:type:: MEMCACHED_DATA_EXISTS
-
-The data requested with the key given was not found.
+++ /dev/null
-=================
-MEMCACHED_DELETED
-=================
-
-.. c:type:: MEMCACHED_DELETED
-
-The object requested by the key has been deleted.
+++ /dev/null
-====================
-MEMCACHED_DEPRECATED
-====================
-
-.. c:type:: MEMCACHED_DEPRECATED
-
-The method that was requested has been deprecated.
+++ /dev/null
-===============
-MEMCACHED_E2BIG
-===============
-
-.. c:type:: MEMCACHED_E2BIG
-
-Item is too large for the server to store.
+++ /dev/null
-=============
-MEMCACHED_END
-=============
-
-.. c:type:: MEMCACHED_END
-
-The server has completed returning all of the objects requested.
+++ /dev/null
-===============
-MEMCACHED_ERRNO
-===============
-
-.. c:type:: MEMCACHED_ERRNO
-
-An error has occurred in the driver which has set errno.
+++ /dev/null
-=================
-MEMCACHED_FAILURE
-=================
-
-.. c:type:: MEMCACHED_FAILURE
-.. deprecated:: <0.30
-
-A unknown failure has occurred in the server.
+++ /dev/null
-==========================
-MEMCACHED_FAIL_UNIX_SOCKET
-==========================
-
-.. c:type:: MEMCACHED_FAIL_UNIX_SOCKET
-
-A connection was not established with the server via a unix domain socket.
+++ /dev/null
-===========================
-MEMCACHED_FETCH_NOTFINISHED
-===========================
-
-.. c:type:: MEMCACHED_FETCH_NOTFINISHED
-
-A request has been made, but the server has not finished the fetch of the last request.
+++ /dev/null
-=============================
-MEMCACHED_HOST_LOOKUP_FAILURE
-=============================
-
-.. c:type:: MEMCACHED_HOST_LOOKUP_FAILURE
-
-A DNS failure has occurred.
+++ /dev/null
-===========================
-MEMCACHED_INVALID_ARGUMENTS
-===========================
-
-.. c:type:: MEMCACHED_INVALID_ARGUMENTS
-
-The arguments supplied to the given function were not valid.
+++ /dev/null
-===============================
-MEMCACHED_INVALID_HOST_PROTOCOL
-===============================
-
-.. c:type:: MEMCACHED_INVALID_HOST_PROTOCOL
-
-The server you are connecting too has an invalid protocol. Most likely you are connecting to an older server that does not speak the binary protocol.
+++ /dev/null
-==============
-MEMCACHED_ITEM
-==============
-
-.. c:type:: MEMCACHED_ITEM
-
-An item has been fetched (this is an internal error only).
+++ /dev/null
-=====================
-MEMCACHED_KEY_TOO_BIG
-=====================
-
-.. c:type:: MEMCACHED_KEY_TOO_BIG
-
-The key that has been provided is too large for the given server.
+++ /dev/null
-========================
-MEMCACHED_MAXIMUM_RETURN
-========================
-
-.. c:type:: MEMCACHED_MAXIMUM_RETURN
-
-This in an internal only state.
+++ /dev/null
-===================================
-MEMCACHED_MEMORY_ALLOCATION_FAILURE
-===================================
-
-.. c:type:: MEMCACHED_MEMORY_ALLOCATION_FAILURE
-
-An error has occurred while trying to allocate memory.
+++ /dev/null
-==================
-MEMCACHED_NOTFOUND
-==================
-
-.. c:type:: MEMCACHED_NOTFOUND
-
-The object requested was not found.
+++ /dev/null
-===================
-MEMCACHED_NOTSTORED
-===================
-
-.. c:type:: MEMCACHED_NOTSTORED
-
-The request to store an object failed.
+++ /dev/null
-=======================
-MEMCACHED_NOT_SUPPORTED
-=======================
-
-.. c:type:: MEMCACHED_NOT_SUPPORTED
-
-The given method is not supported in the server.
+++ /dev/null
-=========================
-MEMCACHED_NO_KEY_PROVIDED
-=========================
-
-.. c:type:: MEMCACHED_NO_KEY_PROVIDED
-.. deprecated:: <0.30
- Use :c:type:`MEMCACHED_BAD_KEY_PROVIDED` instead.
-
-No key was provided.
+++ /dev/null
-====================
-MEMCACHED_NO_SERVERS
-====================
-
-.. c:type:: MEMCACHED_NO_SERVERS
-
-No servers have been added to the memcached_st object.
+++ /dev/null
-=====================
-MEMCACHED_PARSE_ERROR
-=====================
-
-.. c:type:: MEMCACHED_PARSE_ERROR
-
-An error has occurred while trying to parse the configuration string. You should use memparse to determine what the error was.
+++ /dev/null
-==========================
-MEMCACHED_PARSE_USER_ERROR
-==========================
-
-.. c:type:: MEMCACHED_PARSE_USER_ERROR
-
-An error has occurred in parsing the configuration string.
+++ /dev/null
-======================
-MEMCACHED_PARTIAL_READ
-======================
-
-.. c:type:: MEMCACHED_PARTIAL_READ
-
-The read was only partially successful.
+++ /dev/null
-========================
-MEMCACHED_PROTOCOL_ERROR
-========================
-
-.. c:type:: MEMCACHED_PROTOCOL_ERROR
-
-An unknown error has occurred in the protocol.
+++ /dev/null
-======================
-MEMCACHED_READ_FAILURE
-======================
-
-.. c:type:: MEMCACHED_READ_FAILURE
-
-A read failure has occurred.
+++ /dev/null
-======================
-MEMCACHED_SERVER_ERROR
-======================
-
-.. c:type:: MEMCACHED_SERVER_ERROR
-
-An unknown error has occurred in the server.
+++ /dev/null
-============================
-MEMCACHED_SERVER_MARKED_DEAD
-============================
-
-.. c:type:: MEMCACHED_SERVER_MARKED_DEAD
-
-The requested server has been marked dead.
+++ /dev/null
-=====================
-MEMCACHED_SOME_ERRORS
-=====================
-
-.. c:type:: MEMCACHED_SOME_ERRORS
-
-A multi request has been made, and some undetermined number of errors have occurred.
+++ /dev/null
-==============
-MEMCACHED_STAT
-==============
-
-.. c:type:: MEMCACHED_STAT
-
-A "stat" command has been returned in the protocol.
+++ /dev/null
-================
-MEMCACHED_STORED
-================
-
-.. c:type:: MEMCACHED_STORED
-
-The requested object has been successfully stored on the server.
+++ /dev/null
-=================
-MEMCACHED_SUCCESS
-=================
-
-.. c:type:: MEMCACHED_SUCCESS
-
-The request was successfully executed.
+++ /dev/null
-=================
-MEMCACHED_TIMEOUT
-=================
-
-.. c:type:: MEMCACHED_TIMEOUT
-
-Operation has timed out.
+++ /dev/null
-==============================
-MEMCACHED_UNKNOWN_READ_FAILURE
-==============================
-
-.. c:type:: MEMCACHED_UNKNOWN_READ_FAILURE
-
-An unknown read failure only occurs when either there is a bug in the server, or in rare cases where an ethernet nic is reporting dubious information.
+++ /dev/null
-==========================
-MEMCACHED_UNKNOWN_STAT_KEY
-==========================
-
-.. c:type:: MEMCACHED_UNKNOWN_STAT_KEY
-
-The server you are communicating with has a stat key which has not be defined in the protocol.
+++ /dev/null
-===============
-MEMCACHED_VALUE
-===============
-
-.. c:type:: MEMCACHED_VALUE
-
-A value has been returned from the server (this is an internal condition only).
+++ /dev/null
-=======================
-MEMCACHED_WRITE_FAILURE
-=======================
-
-.. c:type:: MEMCACHED_WRITE_FAILURE
-
-An error has occurred while trying to write to a server.
master_doc = 'index'
pygments_style = 'sphinx'
+primary_domain = 'cpp'
+default_role = 'any'
+
project = u'libmemcached'
version = '@PROJECT_VERSION_MAJOR@.@PROJECT_VERSION_MINOR@'
release = '@PROJECT_VERSION@'
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
- ('hashkit_create' , 'hashkit_clone' , u'libhashkit Documentation' , man_authors, 3),
- ('hashkit_create' , 'hashkit_create' , u'libhashkit Documentation' , man_authors, 3),
- ('hashkit_create' , 'hashkit_free' , u'libhashkit Documentation' , man_authors, 3),
- ('hashkit_create' , 'hashkit_is_allocated' , u'libhashkit Documentation' , man_authors, 3),
- ('hashkit_function' , 'hashkit_function' , u'libhashkit Documentation' , man_authors, 3),
- ('hashkit_function' , 'hashkit_get_distribution_function' , u'libhashkit Documentation' , man_authors, 3),
- ('hashkit_function' , 'hashkit_get_function' , u'libhashkit Documentation' , man_authors, 3),
- ('hashkit_function' , 'hashkit_set_function' , u'libhashkit Documentation' , man_authors, 3),
- ('hashkit_function' , 'hashkit_set_custom_distribution_function',u'libhashkit Documentation' , man_authors, 3),
- ('hashkit_function' , 'hashkit_set_custom_function' , u'libhashkit Documentation' , man_authors, 3),
- ('hashkit_function' , 'hashkit_set_distribution_function' , u'libhashkit Documentation' , man_authors, 3),
- ('hashkit_functions' , 'hashkit_crc32' , u'libhashkit Documentation' , man_authors, 3),
- ('hashkit_functions' , 'hashkit_fnv1_32' , u'libhashkit Documentation' , man_authors, 3),
- ('hashkit_functions' , 'hashkit_fnv1_64' , u'libhashkit Documentation' , man_authors, 3),
- ('hashkit_functions' , 'hashkit_fnv1a_32' , u'libhashkit Documentation' , man_authors, 3),
- ('hashkit_functions' , 'hashkit_fnv1a_64' , u'libhashkit Documentation' , man_authors, 3),
- ('hashkit_functions' , 'hashkit_functions' , u'libhashkit Documentation' , man_authors, 3),
- ('hashkit_functions' , 'hashkit_hsieh' , u'libhashkit Documentation' , man_authors, 3),
- ('hashkit_functions' , 'hashkit_jenkins' , u'libhashkit Documentation' , man_authors, 3),
- ('hashkit_functions' , 'hashkit_md5' , u'libhashkit Documentation' , man_authors, 3),
- ('hashkit_functions' , 'hashkit_murmur' , u'libhashkit Documentation' , man_authors, 3),
- ('hashkit_value' , 'hashkit_value' , u'libhashkit Documentation' , man_authors, 3),
- ('libhashkit' , 'libhashkit' , u'libhashkit Documentation' , man_authors, 3),
- ('libmemcached' , 'libmemcached' , u'Introducing the C Client Library for memcached' , man_authors, 3),
- ('libmemcached_configuration' , 'libmemcached_check_configuration' , u'libmemcached Documentation' , man_authors, 3),
- ('libmemcached_configuration' , 'libmemcached_configuration' , u'libmemcached Documentation' , man_authors, 3),
- ('libmemcached_configuration' , 'memcached' , u'libmemcached Documentation' , man_authors, 3),
- ('libmemcached_examples' , 'libmemcached_examples' , u'libmemcached Documentation' , man_authors, 3),
- ('libmemcachedutil' , 'libmemcachedutil' , u'libmemcached Documentation' , man_authors, 3),
- ('memcached_analyze' , 'memcached_analyze' , u'libmemcached Documentation' , man_authors, 3),
- ('memcached_append' , 'memcached_append' , u'Appending to or Prepending to data on the server' , man_authors, 3),
- ('memcached_append' , 'memcached_append_by_key' , u'Appending to or Prepending to data on the server' , man_authors, 3),
- ('memcached_append' , 'memcached_prepend' , u'Appending to or Prepending to data on the server' , man_authors, 3),
- ('memcached_append' , 'memcached_prepend_by_key' , u'Appending to or Prepending to data on the server' , man_authors, 3),
- ('memcached_auto' , 'memcached_auto' , u'Incrementing and Decrementing Values' , man_authors, 3),
- ('memcached_auto' , 'memcached_decrement' , u'Incrementing and Decrementing Values' , man_authors, 3),
- ('memcached_auto' , 'memcached_decrement_with_initial' , u'Incrementing and Decrementing Values' , man_authors, 3),
- ('memcached_auto' , 'memcached_increment' , u'Incrementing and Decrementing Values' , man_authors, 3),
- ('memcached_auto' , 'memcached_increment_with_initial' , u'Incrementing and Decrementing Values' , man_authors, 3),
- ('memcached_behavior' , 'memcached_behavior' , u'libmemcached Documentation' , man_authors, 3),
- ('memcached_behavior' , 'memcached_behavior_get' , u'libmemcached Documentation' , man_authors, 3),
- ('memcached_behavior' , 'memcached_behavior_set' , u'libmemcached Documentation' , man_authors, 3),
- ('memcached_callback' , 'memcached_callback' , u'libmemcached Documentation' , man_authors, 3),
- ('memcached_callback' , 'memcached_callback_get' , u'libmemcached Documentation' , man_authors, 3),
- ('memcached_callback' , 'memcached_callback_set' , u'libmemcached Documentation' , man_authors, 3),
- ('memcached_cas' , 'memcached_cas' , u'Working with data on the server in an atomic fashion', man_authors, 3),
- ('memcached_cas' , 'memcached_cas_by_key' , u'Storing and Replacing Data' , man_authors, 3),
- ('memcached_create' , 'memcached_clone' , u'libmemcached Documentation' , man_authors, 3),
- ('memcached_create' , 'memcached_create' , u'libmemcached Documentation' , man_authors, 3),
- ('memcached_create' , 'memcached_free' , u'libmemcached Documentation' , man_authors, 3),
- ('memcached_create' , 'memcached_servers_reset' , u'libmemcached Documentation' , man_authors, 3),
- ('memcached_delete' , 'memcached_delete' , u'libmemcached Documentation' , man_authors, 3),
- ('memcached_delete' , 'memcached_delete_by_key' , u'libmemcached Documentation' , man_authors, 3),
- ('libmemcached-1.0/memcached_touch' , 'memcached_touch' , u'libmemcached Documentation' , man_authors, 3),
- ('libmemcached-1.0/memcached_touch' , 'memcached_touch_by_key' , u'libmemcached Documentation' , man_authors, 3),
- ('libmemcached/memcached_exist' , 'memcached_exist' , u'libmemcached Documentation' , man_authors, 3),
- ('libmemcached/memcached_exist' , 'memcached_exist_by_key' , u'libmemcached Documentation' , man_authors, 3),
- ('memcached_dump' , 'memcached_dump' , u'libmemcached Documentation' , man_authors, 3),
- ('memcached_flush' , 'memcached_flush' , u'libmemcached Documentation' , man_authors, 3),
- ('memcached_flush_buffers' , 'memcached_flush_buffers' , u'libmemcached Documentation' , man_authors, 3),
- ('memcached_generate_hash_value' , 'memcached_generate_hash' , u'Generating hash values directly' , man_authors, 3),
- ('memcached_generate_hash_value' , 'memcached_generate_hash_value' , u'Generating hash values directly' , man_authors, 3),
- ('libmemcached/memcached_fetch' , 'memcached_fetch' , u'Retrieving data from the server' , man_authors, 3),
- ('memcached_get' , 'memcached_fetch_execute' , u'Retrieving data from the server' , man_authors, 3),
- ('memcached_get' , 'memcached_fetch_result' , u'Retrieving data from the server' , man_authors, 3),
- ('memcached_get' , 'memcached_get' , u'Retrieving data from the server' , man_authors, 3),
- ('memcached_get' , 'memcached_get_by_key' , u'Retrieving data from the server' , man_authors, 3),
- ('libmemcached/memcached_return_t' , 'memcached_return_t' , u'Return type values ' , man_authors, 3),
- ('memcached_get' , 'memcached_mget' , u'Retrieving data from the server' , man_authors, 3),
- ('memcached_get' , 'memcached_mget_by_key' , u'Retrieving data from the server' , man_authors, 3),
- ('memcached_get' , 'memcached_mget_execute' , u'Retrieving data from the server' , man_authors, 3),
- ('memcached_get' , 'memcached_mget_execute_by_key' , u'Retrieving data from the server' , man_authors, 3),
- ('libmemcached/memcached_last_error_message' , 'memcached_last_error_message' , u'libmemcached Documentation' , man_authors, 3),
- ('memcached_memory_allocators' , 'memcached_get_memory_allocators' , u'libmemcached Documentation' , man_authors, 3),
- ('memcached_memory_allocators' , 'memcached_memory_allocators' , u'libmemcached Documentation' , man_authors, 3),
- ('memcached_memory_allocators' , 'memcached_set_memory_allocators' , u'libmemcached Documentation' , man_authors, 3),
- ('memcached_memory_allocators' , 'memcached_set_memory_allocators_context', u'libmemcached Documentation' , man_authors, 3),
- ('memcached_pool' , 'memcached_pool' , u'libmemcached Documentation' , man_authors, 3),
- ('memcached_pool' , 'memcached_pool_behavior_get' , u'libmemcached Documentation' , man_authors, 3),
- ('memcached_pool' , 'memcached_pool_behavior_set' , u'libmemcached Documentation' , man_authors, 3),
- ('memcached_pool' , 'memcached_pool_create' , u'libmemcached Documentation' , man_authors, 3),
- ('memcached_pool' , 'memcached_pool_destroy' , u'libmemcached Documentation' , man_authors, 3),
- ('memcached_pool' , 'memcached_pool_fetch' , u'libmemcached Documentation' , man_authors, 3),
- ('memcached_pool' , 'memcached_pool_pop' , u'libmemcached Documentation' , man_authors, 3),
- ('memcached_pool' , 'memcached_pool_push' , u'libmemcached Documentation' , man_authors, 3),
- ('memcached_pool' , 'memcached_pool_release' , u'libmemcached Documentation' , man_authors, 3),
- ('memcached_pool' , 'memcached_pool_st' , u'libmemcached Documentation' , man_authors, 3),
- ('memcached_quit' , 'memcached_quit' , u'libmemcached Documentation' , man_authors, 3),
- ('libmemcached-1.0/memcached_set_encoding_key', 'memcached_set_encoding_key' , u'libmemcached Documentation' , man_authors, 3),
- ('memcached_result_st' , 'memcached_result_cas' , u'Working with result sets' , man_authors, 3),
- ('memcached_result_st' , 'memcached_result_create' , u'Working with result sets' , man_authors, 3),
- ('memcached_result_st' , 'memcached_result_flags' , u'Working with result sets' , man_authors, 3),
- ('memcached_result_st' , 'memcached_result_free' , u'Working with result sets' , man_authors, 3),
- ('memcached_result_st' , 'memcached_result_key_length' , u'Working with result sets' , man_authors, 3),
- ('memcached_result_st' , 'memcached_result_key_value' , u'Working with result sets' , man_authors, 3),
- ('memcached_result_st' , 'memcached_result_length' , u'Working with result sets' , man_authors, 3),
- ('memcached_result_st' , 'memcached_result_st' , u'Working with result sets' , man_authors, 3),
- ('memcached_result_st' , 'memcached_result_value' , u'Working with result sets' , man_authors, 3),
- ('memcached_sasl' , 'memcached_destroy_sasl_auth_data' , u'libmemcached Documentation' , man_authors, 3),
- ('memcached_sasl' , 'memcached_get_sasl_callbacks' , u'libmemcached Documentation' , man_authors, 3),
- ('memcached_sasl' , 'memcached_sasl' , u'libmemcached Documentation' , man_authors, 3),
- ('memcached_sasl' , 'memcached_sasl_set_auth_data' , u'libmemcached Documentation' , man_authors, 3),
- ('memcached_sasl' , 'memcached_set_sasl_callbacks' , u'libmemcached Documentation' , man_authors, 3),
- ('memcached_server_st' , 'memcached_server_list_append' , u'libmemcached Documentation' , man_authors, 3),
- ('memcached_server_st' , 'memcached_server_list_count' , u'libmemcached Documentation' , man_authors, 3),
- ('memcached_server_st' , 'memcached_server_list_free' , u'libmemcached Documentation' , man_authors, 3),
- ('memcached_server_st' , 'memcached_servers_parse' , u'libmemcached Documentation' , man_authors, 3),
- ('memcached_servers' , 'memcached_server_add' , u'libmemcached Documentation' , man_authors, 3),
- ('memcached_servers' , 'memcached_server_add_unix_socket' , u'libmemcached Documentation' , man_authors, 3),
- ('memcached_servers' , 'memcached_server_count' , u'libmemcached Documentation' , man_authors, 3),
- ('memcached_servers' , 'memcached_server_cursor' , u'libmemcached Documentation' , man_authors, 3),
- ('memcached_servers' , 'memcached_server_list' , u'libmemcached Documentation' , man_authors, 3),
- ('memcached_servers' , 'memcached_server_push' , u'libmemcached Documentation' , man_authors, 3),
- ('memcached_servers' , 'memcached_server_st' , u'libmemcached Documentation' , man_authors, 3),
- ('memcached_servers' , 'memcached_servers' , u'libmemcached Documentation' , man_authors, 3),
- ('memcached_set' , 'memcached_add' , u'Storing and Replacing Data' , man_authors, 3),
- ('memcached_set' , 'memcached_add_by_key' , u'Storing and Replacing Data' , man_authors, 3),
- ('memcached_set' , 'memcached_replace' , u'Storing and Replacing Data' , man_authors, 3),
- ('memcached_set' , 'memcached_replace_by_key' , u'Storing and Replacing Data' , man_authors, 3),
- ('memcached_set' , 'memcached_set' , u'Storing and Replacing Data' , man_authors, 3),
- ('memcached_set' , 'memcached_set_by_key' , u'Storing and Replacing Data' , man_authors, 3),
- ('memcached_stats' , 'memcached_stat' , u'libmemcached Documentation' , man_authors, 3),
- ('memcached_stats' , 'memcached_stat_execute' , u'libmemcached Documentation' , man_authors, 3),
- ('memcached_stats' , 'memcached_stat_get_keys' , u'libmemcached Documentation' , man_authors, 3),
- ('memcached_stats' , 'memcached_stat_get_value' , u'libmemcached Documentation' , man_authors, 3),
- ('memcached_stats' , 'memcached_stat_servername' , u'libmemcached Documentation' , man_authors, 3),
- ('memcached_stats' , 'memcached_stats' , u'libmemcached Documentation' , man_authors, 3),
- ('memcached_strerror' , 'memcached_strerror' , u'libmemcached Documentation' , man_authors, 3),
- ('memcached_user_data' , 'memcached_get_user_data' , u'libmemcached Documentation' , man_authors, 3),
- ('memcached_user_data' , 'memcached_set_user_data' , u'libmemcached Documentation' , man_authors, 3),
- ('memcached_user_data' , 'memcached_user_data' , u'libmemcached Documentation' , man_authors, 3),
- ('memcached_verbosity' , 'memcached_verbosity' , u'libmemcached Documentation' , man_authors, 3),
- ('memcached_version' , 'memcached_lib_version' , u'libmemcached Documentation' , man_authors, 3),
- ('memcached_version' , 'memcached_version' , u'libmemcached Documentation' , man_authors, 3),
- ('bin/memcapable' , 'memcapable' , u'libmemcached Documentation' , man_authors, 1),
- ('bin/memcat' , 'memcat' , u'libmemcached Documentation' , man_authors, 1),
- ('bin/memcp' , 'memcp' , u'libmemcached Documentation' , man_authors, 1),
- ('bin/memdump' , 'memdump' , u'libmemcached Documentation' , man_authors, 1),
- ('bin/memerror' , 'memerror' , u'libmemcached Documentation' , man_authors, 1),
- ('bin/memflush' , 'memflush' , u'libmemcached Documentation' , man_authors, 1),
- ('bin/memrm' , 'memrm' , u'libmemcached Documentation' , man_authors, 1),
- ('bin/memaslap' , 'memaslap' , u'libmemcached Documentation' , man_authors, 1),
- ('bin/memslap' , 'memslap' , u'libmemcached Documentation' , man_authors, 1),
- ('bin/memstat' , 'memstat' , u'libmemcached Documentation' , man_authors, 1),
- ('bin/memexist' , 'memexist' , u'libmemcached Documentation' , man_authors, 1),
- ('bin/memparse' , 'memparse' , u'libmemcached Documentation' , man_authors, 1),
- ('bin/memping' , 'memping' , u'libmemcached Documentation' , man_authors, 1),
- ('bin/memtouch' , 'memtouch' , u'libmemcached Documentation' , man_authors, 1),
+ ('libhashkit' ,'libhashkit' ,u'libhashkit Documentation' ,man_authors,3),
+ ('libhashkit/hashkit_create' ,'hashkit_clone' ,u'libhashkit Documentation' ,man_authors,3),
+ ('libhashkit/hashkit_create' ,'hashkit_create' ,u'libhashkit Documentation' ,man_authors,3),
+ ('libhashkit/hashkit_create' ,'hashkit_free' ,u'libhashkit Documentation' ,man_authors,3),
+ ('libhashkit/hashkit_create' ,'hashkit_is_allocated' ,u'libhashkit Documentation' ,man_authors,3),
+ ('libhashkit/hashkit_function' ,'hashkit_function' ,u'libhashkit Documentation' ,man_authors,3),
+ ('libhashkit/hashkit_function' ,'hashkit_get_distribution_function' ,u'libhashkit Documentation' ,man_authors,3),
+ ('libhashkit/hashkit_function' ,'hashkit_get_function' ,u'libhashkit Documentation' ,man_authors,3),
+ ('libhashkit/hashkit_function' ,'hashkit_set_custom_distribution_function',u'libhashkit Documentation' ,man_authors,3),
+ ('libhashkit/hashkit_function' ,'hashkit_set_custom_function' ,u'libhashkit Documentation' ,man_authors,3),
+ ('libhashkit/hashkit_function' ,'hashkit_set_distribution_function' ,u'libhashkit Documentation' ,man_authors,3),
+ ('libhashkit/hashkit_function' ,'hashkit_set_function' ,u'libhashkit Documentation' ,man_authors,3),
+ ('libhashkit/hashkit_functions' ,'hashkit_crc32' ,u'libhashkit Documentation' ,man_authors,3),
+ ('libhashkit/hashkit_functions' ,'hashkit_fnv1_32' ,u'libhashkit Documentation' ,man_authors,3),
+ ('libhashkit/hashkit_functions' ,'hashkit_fnv1_64' ,u'libhashkit Documentation' ,man_authors,3),
+ ('libhashkit/hashkit_functions' ,'hashkit_fnv1a_32' ,u'libhashkit Documentation' ,man_authors,3),
+ ('libhashkit/hashkit_functions' ,'hashkit_fnv1a_64' ,u'libhashkit Documentation' ,man_authors,3),
+ ('libhashkit/hashkit_functions' ,'hashkit_functions' ,u'libhashkit Documentation' ,man_authors,3),
+ ('libhashkit/hashkit_functions' ,'hashkit_hsieh' ,u'libhashkit Documentation' ,man_authors,3),
+ ('libhashkit/hashkit_functions' ,'hashkit_jenkins' ,u'libhashkit Documentation' ,man_authors,3),
+ ('libhashkit/hashkit_functions' ,'hashkit_md5' ,u'libhashkit Documentation' ,man_authors,3),
+ ('libhashkit/hashkit_functions' ,'hashkit_murmur' ,u'libhashkit Documentation' ,man_authors,3),
+ ('libhashkit/hashkit_value' ,'hashkit_value' ,u'libhashkit Documentation' ,man_authors,3),
+
+ ('libmemcached' ,'libmemcached' ,u'C/C++ Client Library for memcached' ,man_authors,3),
+ ('libmemcached/configuration' ,'libmemcached_check_configuration' ,u'libmemcached Documentation' ,man_authors,3),
+ ('libmemcached/configuration' ,'libmemcached_configuration' ,u'libmemcached Documentation' ,man_authors,3),
+ ('libmemcached/configuration' ,'memcached' ,u'libmemcached Documentation' ,man_authors,3),
+ ('libmemcached/examples' ,'libmemcached_examples' ,u'libmemcached Documentation' ,man_authors,3),
+ ('libmemcached/memcached_analyze' ,'memcached_analyze' ,u'libmemcached Documentation' ,man_authors,3),
+ ('libmemcached/memcached_append' ,'memcached_append_by_key' ,u'Appending to or Prepending Data' ,man_authors,3),
+ ('libmemcached/memcached_append' ,'memcached_append' ,u'Appending to or Prepending Data' ,man_authors,3),
+ ('libmemcached/memcached_append' ,'memcached_prepend_by_key' ,u'Appending to or Prepending Data' ,man_authors,3),
+ ('libmemcached/memcached_append' ,'memcached_prepend' ,u'Appending to or Prepending Data' ,man_authors,3),
+ ('libmemcached/memcached_auto' ,'memcached_auto' ,u'Incrementing and Decrementing Values',man_authors,3),
+ ('libmemcached/memcached_auto' ,'memcached_decrement' ,u'Incrementing and Decrementing Values',man_authors,3),
+ ('libmemcached/memcached_auto' ,'memcached_decrement_with_initial' ,u'Incrementing and Decrementing Values',man_authors,3),
+ ('libmemcached/memcached_auto' ,'memcached_increment' ,u'Incrementing and Decrementing Values',man_authors,3),
+ ('libmemcached/memcached_auto' ,'memcached_increment_with_initial' ,u'Incrementing and Decrementing Values',man_authors,3),
+ ('libmemcached/memcached_behavior' ,'memcached_behavior_get' ,u'libmemcached Documentation' ,man_authors,3),
+ ('libmemcached/memcached_behavior' ,'memcached_behavior_set' ,u'libmemcached Documentation' ,man_authors,3),
+ ('libmemcached/memcached_behavior' ,'memcached_behavior' ,u'libmemcached Documentation' ,man_authors,3),
+ ('libmemcached/memcached_callback' ,'memcached_callback_get' ,u'libmemcached Documentation' ,man_authors,3),
+ ('libmemcached/memcached_callback' ,'memcached_callback_set' ,u'libmemcached Documentation' ,man_authors,3),
+ ('libmemcached/memcached_callback' ,'memcached_callback' ,u'libmemcached Documentation' ,man_authors,3),
+ ('libmemcached/memcached_cas' ,'memcached_cas_by_key' ,u'Storing and Replacing Data' ,man_authors,3),
+ ('libmemcached/memcached_cas' ,'memcached_cas' ,u'Atomic Compare and Swap' ,man_authors,3),
+ ('libmemcached/memcached_create' ,'memcached_clone' ,u'libmemcached Documentation' ,man_authors,3),
+ ('libmemcached/memcached_create' ,'memcached_create' ,u'libmemcached Documentation' ,man_authors,3),
+ ('libmemcached/memcached_create' ,'memcached_free' ,u'libmemcached Documentation' ,man_authors,3),
+ ('libmemcached/memcached_create' ,'memcached_servers_reset' ,u'libmemcached Documentation' ,man_authors,3),
+ ('libmemcached/memcached_delete' ,'memcached_delete_by_key' ,u'libmemcached Documentation' ,man_authors,3),
+ ('libmemcached/memcached_delete' ,'memcached_delete' ,u'libmemcached Documentation' ,man_authors,3),
+ ('libmemcached/memcached_dump' ,'memcached_dump' ,u'libmemcached Documentation' ,man_authors,3),
+ ('libmemcached/memcached_exist' ,'memcached_exist_by_key' ,u'libmemcached Documentation' ,man_authors,3),
+ ('libmemcached/memcached_exist' ,'memcached_exist' ,u'libmemcached Documentation' ,man_authors,3),
+ ('libmemcached/memcached_fetch' ,'memcached_fetch' ,u'Retrieving data from the server' ,man_authors,3),
+ ('libmemcached/memcached_flush_buffers' ,'memcached_flush_buffers' ,u'libmemcached Documentation' ,man_authors,3),
+ ('libmemcached/memcached_flush' ,'memcached_flush' ,u'libmemcached Documentation' ,man_authors,3),
+ ('libmemcached/memcached_generate_hash_value','memcached_generate_hash' ,u'Generating hash values directly' ,man_authors,3),
+ ('libmemcached/memcached_generate_hash_value','memcached_generate_hash_value' ,u'Generating hash values directly' ,man_authors,3),
+ ('libmemcached/memcached_get' ,'memcached_fetch_execute' ,u'Retrieving data from the server' ,man_authors,3),
+ ('libmemcached/memcached_get' ,'memcached_fetch_result' ,u'Retrieving data from the server' ,man_authors,3),
+ ('libmemcached/memcached_get' ,'memcached_get_by_key' ,u'Retrieving data from the server' ,man_authors,3),
+ ('libmemcached/memcached_get' ,'memcached_get' ,u'Retrieving data from the server' ,man_authors,3),
+ ('libmemcached/memcached_get' ,'memcached_mget_by_key' ,u'Retrieving data from the server' ,man_authors,3),
+ ('libmemcached/memcached_get' ,'memcached_mget_execute_by_key' ,u'Retrieving data from the server' ,man_authors,3),
+ ('libmemcached/memcached_get' ,'memcached_mget_execute' ,u'Retrieving data from the server' ,man_authors,3),
+ ('libmemcached/memcached_get' ,'memcached_mget' ,u'Retrieving data from the server' ,man_authors,3),
+ ('libmemcached/memcached_last_error' ,'memcached_last_error_errno' ,u'libmemcached Documentation' ,man_authors,3),
+ ('libmemcached/memcached_last_error' ,'memcached_last_error_message' ,u'libmemcached Documentation' ,man_authors,3),
+ ('libmemcached/memcached_last_error' ,'memcached_last_error' ,u'libmemcached Documentation' ,man_authors,3),
+ ('libmemcached/memcached_memory_allocators' ,'memcached_get_memory_allocators' ,u'libmemcached Documentation' ,man_authors,3),
+ ('libmemcached/memcached_memory_allocators' ,'memcached_memory_allocators' ,u'libmemcached Documentation' ,man_authors,3),
+ ('libmemcached/memcached_memory_allocators' ,'memcached_set_memory_allocators_context' ,u'libmemcached Documentation' ,man_authors,3),
+ ('libmemcached/memcached_memory_allocators' ,'memcached_set_memory_allocators' ,u'libmemcached Documentation' ,man_authors,3),
+ ('libmemcached/memcached_quit' ,'memcached_quit' ,u'libmemcached Documentation' ,man_authors,3),
+ ('libmemcached/memcached_result_st' ,'memcached_result_cas' ,u'Working with result sets' ,man_authors,3),
+ ('libmemcached/memcached_result_st' ,'memcached_result_create' ,u'Working with result sets' ,man_authors,3),
+ ('libmemcached/memcached_result_st' ,'memcached_result_flags' ,u'Working with result sets' ,man_authors,3),
+ ('libmemcached/memcached_result_st' ,'memcached_result_free' ,u'Working with result sets' ,man_authors,3),
+ ('libmemcached/memcached_result_st' ,'memcached_result_key_length' ,u'Working with result sets' ,man_authors,3),
+ ('libmemcached/memcached_result_st' ,'memcached_result_key_value' ,u'Working with result sets' ,man_authors,3),
+ ('libmemcached/memcached_result_st' ,'memcached_result_length' ,u'Working with result sets' ,man_authors,3),
+ ('libmemcached/memcached_result_st' ,'memcached_result_st' ,u'Working with result sets' ,man_authors,3),
+ ('libmemcached/memcached_result_st' ,'memcached_result_value' ,u'Working with result sets' ,man_authors,3),
+ ('libmemcached/memcached_return_t' ,'memcached_return_t' ,u'Return type values ' ,man_authors,3),
+ ('libmemcached/memcached_sasl' ,'memcached_destroy_sasl_auth_data' ,u'libmemcached Documentation' ,man_authors,3),
+ ('libmemcached/memcached_sasl' ,'memcached_get_sasl_callbacks' ,u'libmemcached Documentation' ,man_authors,3),
+ ('libmemcached/memcached_sasl' ,'memcached_sasl_set_auth_data' ,u'libmemcached Documentation' ,man_authors,3),
+ ('libmemcached/memcached_sasl' ,'memcached_sasl' ,u'libmemcached Documentation' ,man_authors,3),
+ ('libmemcached/memcached_sasl' ,'memcached_set_sasl_callbacks' ,u'libmemcached Documentation' ,man_authors,3),
+ ('libmemcached/memcached_servers' ,'memcached_server_add' ,u'libmemcached Documentation' ,man_authors,3),
+ ('libmemcached/memcached_servers' ,'memcached_server_add_unix_socket' ,u'libmemcached Documentation' ,man_authors,3),
+ ('libmemcached/memcached_servers' ,'memcached_server_count' ,u'libmemcached Documentation' ,man_authors,3),
+ ('libmemcached/memcached_servers' ,'memcached_server_cursor' ,u'libmemcached Documentation' ,man_authors,3),
+ ('libmemcached/memcached_servers' ,'memcached_server_list' ,u'libmemcached Documentation' ,man_authors,3),
+ ('libmemcached/memcached_servers' ,'memcached_server_push' ,u'libmemcached Documentation' ,man_authors,3),
+ ('libmemcached/memcached_servers' ,'memcached_server_st' ,u'libmemcached Documentation' ,man_authors,3),
+ ('libmemcached/memcached_servers' ,'memcached_servers' ,u'libmemcached Documentation' ,man_authors,3),
+ ('libmemcached/memcached_server_st' ,'memcached_server_list_append' ,u'libmemcached Documentation' ,man_authors,3),
+ ('libmemcached/memcached_server_st' ,'memcached_server_list_count' ,u'libmemcached Documentation' ,man_authors,3),
+ ('libmemcached/memcached_server_st' ,'memcached_server_list_free' ,u'libmemcached Documentation' ,man_authors,3),
+ ('libmemcached/memcached_server_st' ,'memcached_servers_parse' ,u'libmemcached Documentation' ,man_authors,3),
+ ('libmemcached/memcached_set_encoding_key' ,'memcached_set_encoding_key' ,u'libmemcached Documentation' ,man_authors,3),
+ ('libmemcached/memcached_set' ,'memcached_add_by_key' ,u'Storing and Replacing Data' ,man_authors,3),
+ ('libmemcached/memcached_set' ,'memcached_add' ,u'Storing and Replacing Data' ,man_authors,3),
+ ('libmemcached/memcached_set' ,'memcached_replace_by_key' ,u'Storing and Replacing Data' ,man_authors,3),
+ ('libmemcached/memcached_set' ,'memcached_replace' ,u'Storing and Replacing Data' ,man_authors,3),
+ ('libmemcached/memcached_set' ,'memcached_set_by_key' ,u'Storing and Replacing Data' ,man_authors,3),
+ ('libmemcached/memcached_set' ,'memcached_set' ,u'Storing and Replacing Data' ,man_authors,3),
+ ('libmemcached/memcached_stats' ,'memcached_stat_execute' ,u'libmemcached Documentation' ,man_authors,3),
+ ('libmemcached/memcached_stats' ,'memcached_stat_get_keys' ,u'libmemcached Documentation' ,man_authors,3),
+ ('libmemcached/memcached_stats' ,'memcached_stat_get_value' ,u'libmemcached Documentation' ,man_authors,3),
+ ('libmemcached/memcached_stats' ,'memcached_stat_servername' ,u'libmemcached Documentation' ,man_authors,3),
+ ('libmemcached/memcached_stats' ,'memcached_stats' ,u'libmemcached Documentation' ,man_authors,3),
+ ('libmemcached/memcached_stats' ,'memcached_stat' ,u'libmemcached Documentation' ,man_authors,3),
+ ('libmemcached/memcached_strerror' ,'memcached_strerror' ,u'libmemcached Documentation' ,man_authors,3),
+ ('libmemcached/memcached_touch' ,'memcached_touch_by_key' ,u'libmemcached Documentation' ,man_authors,3),
+ ('libmemcached/memcached_touch' ,'memcached_touch' ,u'libmemcached Documentation' ,man_authors,3),
+ ('libmemcached/memcached_user_data' ,'memcached_get_user_data' ,u'libmemcached Documentation' ,man_authors,3),
+ ('libmemcached/memcached_user_data' ,'memcached_set_user_data' ,u'libmemcached Documentation' ,man_authors,3),
+ ('libmemcached/memcached_user_data' ,'memcached_user_data' ,u'libmemcached Documentation' ,man_authors,3),
+ ('libmemcached/memcached_verbosity' ,'memcached_verbosity' ,u'libmemcached Documentation' ,man_authors,3),
+ ('libmemcached/memcached_version' ,'memcached_lib_version' ,u'libmemcached Documentation' ,man_authors,3),
+ ('libmemcached/memcached_version' ,'memcached_version' ,u'libmemcached Documentation' ,man_authors,3),
+
+ ('libmemcachedutil' ,'libmemcachedutil' ,u'libmemcached Documentation' ,man_authors,3),
+ ('libmemcachedutil/memcached_pool' ,'memcached_pool_behavior_get' ,u'libmemcached Documentation' ,man_authors,3),
+ ('libmemcachedutil/memcached_pool' ,'memcached_pool_behavior_set' ,u'libmemcached Documentation' ,man_authors,3),
+ ('libmemcachedutil/memcached_pool' ,'memcached_pool_create' ,u'libmemcached Documentation' ,man_authors,3),
+ ('libmemcachedutil/memcached_pool' ,'memcached_pool_destroy' ,u'libmemcached Documentation' ,man_authors,3),
+ ('libmemcachedutil/memcached_pool' ,'memcached_pool_fetch' ,u'libmemcached Documentation' ,man_authors,3),
+ ('libmemcachedutil/memcached_pool' ,'memcached_pool_pop' ,u'libmemcached Documentation' ,man_authors,3),
+ ('libmemcachedutil/memcached_pool' ,'memcached_pool_push' ,u'libmemcached Documentation' ,man_authors,3),
+ ('libmemcachedutil/memcached_pool' ,'memcached_pool_release' ,u'libmemcached Documentation' ,man_authors,3),
+ ('libmemcachedutil/memcached_pool' ,'memcached_pool_st' ,u'libmemcached Documentation' ,man_authors,3),
+ ('libmemcachedutil/memcached_pool' ,'memcached_pool' ,u'libmemcached Documentation' ,man_authors,3),
+
+ ('bin/memcapable' , 'memcapable' , u'libmemcached Documentation' , man_authors, 1),
+ ('bin/memcat' , 'memcat' , u'libmemcached Documentation' , man_authors, 1),
+ ('bin/memcp' , 'memcp' , u'libmemcached Documentation' , man_authors, 1),
+ ('bin/memdump' , 'memdump' , u'libmemcached Documentation' , man_authors, 1),
+ ('bin/memerror' , 'memerror' , u'libmemcached Documentation' , man_authors, 1),
+ ('bin/memflush' , 'memflush' , u'libmemcached Documentation' , man_authors, 1),
+ ('bin/memrm' , 'memrm' , u'libmemcached Documentation' , man_authors, 1),
+ ('bin/memaslap' , 'memaslap' , u'libmemcached Documentation' , man_authors, 1),
+ ('bin/memslap' , 'memslap' , u'libmemcached Documentation' , man_authors, 1),
+ ('bin/memstat' , 'memstat' , u'libmemcached Documentation' , man_authors, 1),
+ ('bin/memexist' , 'memexist' , u'libmemcached Documentation' , man_authors, 1),
+ ('bin/memparse' , 'memparse' , u'libmemcached Documentation' , man_authors, 1),
+ ('bin/memping' , 'memping' , u'libmemcached Documentation' , man_authors, 1),
+ ('bin/memtouch' , 'memtouch' , u'libmemcached Documentation' , man_authors, 1),
]
rst_prolog = """
-=========
Copyright
=========
+++ /dev/null
-=====================
-Client Error messages
-=====================
-
-.. toctree::
- :maxdepth: 1
-
- client_errors/MEMCACHED_AUTH_CONTINUE
- client_errors/MEMCACHED_AUTH_FAILURE
- client_errors/MEMCACHED_AUTH_PROBLEM
- client_errors/MEMCACHED_BAD_KEY_PROVIDED
- client_errors/MEMCACHED_BUFFERED
- client_errors/MEMCACHED_CLIENT_ERROR
- client_errors/MEMCACHED_CONNECTION_BIND_FAILURE
- client_errors/MEMCACHED_CONNECTION_FAILURE
- client_errors/MEMCACHED_CONNECTION_SOCKET_CREATE_FAILURE
- client_errors/MEMCACHED_DATA_DOES_NOT_EXIST
- client_errors/MEMCACHED_DATA_EXISTS
- client_errors/MEMCACHED_DELETED
- client_errors/MEMCACHED_DEPRECATED
- client_errors/MEMCACHED_E2BIG
- client_errors/MEMCACHED_END
- client_errors/MEMCACHED_ERRNO
- client_errors/MEMCACHED_FAILURE
- client_errors/MEMCACHED_FAIL_UNIX_SOCKET
- client_errors/MEMCACHED_FETCH_NOTFINISHED
- client_errors/MEMCACHED_HOST_LOOKUP_FAILURE
- client_errors/MEMCACHED_INVALID_ARGUMENTS
- client_errors/MEMCACHED_INVALID_HOST_PROTOCOL
- client_errors/MEMCACHED_ITEM
- client_errors/MEMCACHED_KEY_TOO_BIG
- client_errors/MEMCACHED_MAXIMUM_RETURN
- client_errors/MEMCACHED_MEMORY_ALLOCATION_FAILURE
- client_errors/MEMCACHED_NOTFOUND
- client_errors/MEMCACHED_NOTSTORED
- client_errors/MEMCACHED_NOT_SUPPORTED
- client_errors/MEMCACHED_NO_KEY_PROVIDED
- client_errors/MEMCACHED_NO_SERVERS
- client_errors/MEMCACHED_PARSE_ERROR
- client_errors/MEMCACHED_PARSE_USER_ERROR
- client_errors/MEMCACHED_PARTIAL_READ
- client_errors/MEMCACHED_PROTOCOL_ERROR
- client_errors/MEMCACHED_READ_FAILURE
- client_errors/MEMCACHED_SERVER_ERROR
- client_errors/MEMCACHED_SERVER_MARKED_DEAD
- client_errors/MEMCACHED_SOME_ERRORS
- client_errors/MEMCACHED_STAT
- client_errors/MEMCACHED_STORED
- client_errors/MEMCACHED_SUCCESS
- client_errors/MEMCACHED_TIMEOUT
- client_errors/MEMCACHED_UNKNOWN_READ_FAILURE
- client_errors/MEMCACHED_UNKNOWN_STAT_KEY
- client_errors/MEMCACHED_VALUE
- client_errors/MEMCACHED_WRITE_FAILURE
-
+++ /dev/null
-Creating a hashkit structure
-============================
-
-.. index:: object: hashkit_st
-
-Create, copy and free a hashkit structure
-
-SYNOPSIS
---------
-
-#include <libhashkit-|libhashkit_version|/hashkit.h>
- Compile and link with -lhashkit
-
-.. c:type:: struct hashkit_st
-
- typedef struct hashkit_st hashkit_st;
-
-.. c:function:: hashkit_st *hashkit_create(hashkit_st *hash)
-
-.. c:function:: hashkit_st *hashkit_clone(hashkit_st *destination, const hashkit_st *ptr)
-
-.. c:function:: void hashkit_free(hashkit_st *hash)
-
-.. c:function:: bool hashkit_is_allocated(const hashkit_st *hash)
-
-DESCRIPTION
------------
-
-The :c:func:`hashkit_create` function initializes a hashkit object for use. If
-you pass a NULL argument for hash, then the memory for the object is
-allocated. If you specify a pre-allocated piece of memory, that is
-initialized for use.
-
-The :c:func:`hashkit_clone` function initializes a hashkit object much like
-:c:func:`hashkit_create`, but instead of using default settings it will use
-the settings of the ptr hashkit object.
-
-The :c:func:`hashkit_free` frees any resources being consumed by the hashkit
-objects that were initialized with :c:func:`hashkit_create` or :c:func:`hashkit_clone`.
-
-The :c:func:`hashkit_is_allocated` reports where the memory was allocated
-for a hashkit object.
-
-RETURN VALUE
-------------
-
-:c:func:`hashkit_create` and :c:func:`hashkit_clone` will return NULL on
-failure or non-NULL on success.
-
-:c:func:`hashkit_is_allocated` returns true if the memory for the hashkit
-object was allocated inside of :c:func:`hashkit_create` or
-:c:func:`hashkit_clone`, otherwise it is false and was user-supplied memory.
-
-SEE ALSO
---------
-
-.. only:: man
-
- :manpage:`libhashkit(3)`
- :manpage:`hashkit_value(3)`
- :manpage:`hashkit_function3)`
-
-.. only:: html
-
- * :doc:`libhashkit`
- * :doc:`hashkit_value`
- * :doc:`hashkit_function`
+++ /dev/null
-Set Hash Function
-=================
-
-.. index:: object: hashkit_st
-.. index:: object: hashkit_hash_fn
-
-Set hash functions to use for calculating values for keys
-
-SYNOPSIS
---------
-
-#include <libhashkit-|libhashkit_version|/hashkit.h>
- Compile and link with -lhashkit
-
-.. c:type:: hashkit_hash_fn
-
-.. code-block:: c
-
- typedef uint32_t (*hashkit_hash_fn)(const char *key, size_t key_length, void *context);
-
-.. c:function:: hashkit_return_t hashkit_set_function(hashkit_st *hash, hashkit_hash_algorithm_t hash_algorithm)
-
-.. c:function:: hashkit_return_t hashkit_set_custom_function(hashkit_st *hash, hashkit_hash_fn function, void *context)
-
-.. c:function:: hashkit_hash_algorithm_t hashkit_get_function(const hashkit_st *hash)
-
-.. c:function:: hashkit_return_t hashkit_set_distribution_function(hashkit_st *hash, hashkit_hash_algorithm_t hash_algorithm)
-
-.. c:function:: hashkit_return_t hashkit_set_custom_distribution_function(hashkit_st *self, hashkit_hash_fn function, void *context)
-
-.. c:function:: hashkit_hash_algorithm_t hashkit_get_distribution_function(const hashkit_st *self)
-
-DESCRIPTION
------------
-
-These functions are used to set and retrieve the key and distribution hash functions.
-
-
-RETURN VALUE
-------------
-
-:c:func:`hashkit_set_function`, :c:func:`hashkit_set_custom_function` and the distribution equivalents
-return :c:type:`hashkit_return_t` `HASHKIT_SUCCESS` on success.
-
-:c:func:`hashkit_get_function` and :c:func:`hashkit_get_distribution_function` return :c:type:`hashkit_hash_algorithm_t`
-indicating the hash function used.
-
-SEE ALSO
---------
-
-.. only:: man
-
- :manpage:`libhashkit(3)`
- :manpage:`hashkit_create(3)`
- :manpage:`hashkit_functions(3)`
-
-.. only:: html
-
- * :doc:`libhashkit`
- * :doc:`hashkit_create`
- * :doc:`hashkit_functions`
-
+++ /dev/null
-Available Hashes
-================
-
-.. index:: object: hashkit_st
-
-Various hash functions to use for calculating values for keys
-
-SYNOPSIS
---------
-
-#include <libhashkit-|libhashkit_version|/hashkit.h>
- Compile and link with -lhashkit
-
-.. c:function:: uint32_t hashkit_default(const char *key, size_t key_length)
-
-.. c:function:: uint32_t hashkit_fnv1_64(const char *key, size_t key_length)
-
-.. c:function:: uint32_t hashkit_fnv1a_64(const char *key, size_t key_length)
-
-.. c:function:: uint32_t hashkit_fnv1_32(const char *key, size_t key_length)
-
-.. c:function:: uint32_t hashkit_fnv1a_32(const char *key, size_t key_length)
-
-.. c:function:: uint32_t hashkit_crc32(const char *key, size_t key_length)
-
-.. c:function:: uint32_t hashkit_hsieh(const char *key, size_t key_length)
-
-.. c:function:: uint32_t hashkit_murmur(const char *key, size_t key_length)
-
-.. c:function:: uint32_t hashkit_murmur3(const char *key, size_t key_length)
-
-.. c:function:: uint32_t hashkit_jenkins(const char *key, size_t key_length)
-
-.. c:function:: uint32_t hashkit_md5(const char *key, size_t key_length)
-
-DESCRIPTION
------------
-
-These functions generate hash values from a key using a variety of
-algorithms. These functions can be used standalone, or as arguments
-to :c:func:`hashkit_set_hash_fn` or :c:func:`hashkit_set_continuum_hash_fn`.
-
-The :c:func:`hashkit_hsieh` is only available if the library is built with
-the appropriate flag enabled.
-
-RETURN VALUE
-------------
-
-A 32-bit hash value.
-
-SEE ALSO
---------
-
-.. only:: man
-
- :manpage:`libhashkit(3)`
- :manpage:`hashkit_create(3)`
- :manpage:`hashkit_function(3)`
-
-.. only:: html
-
- * :doc:`libhashkit`
- * :doc:`hashkit_create`
- * :doc:`hashkit_function`
-
+++ /dev/null
-Generate hash value
-===================
-
-.. index:: object: hashkit_st
-
-Generate a value for the given key
-
-SYNOPSIS
---------
-
-#include <libhashkit-|libhashkit_version|/hashkit.h>
- Compile and link with -lhashkit
-
-.. c:function:: uint32_t hashkit_value(hashkit_st *hash, const char *key, size_t key_length)
-
-DESCRIPTION
------------
-
-The :c:func:`hashkit_value` function generates a 32-bit hash value from the
-given key and key_length. The hash argument is an initialized hashkit
-object, and distribution type and hash function is used from this
-object while generating the value.
-
-RETURN VALUE
-------------
-
-A 32-bit hash value.
-
-SEE ALSO
---------
-
-.. only:: man
-
- :manpage:`libhashkit(3)`
- :manpage:`hashkit_create(3)`
- :manpage:`hashkit_function(3)`
- :manpage:`hashkit_functions(3)`
-
-.. only:: html
-
- * :doc:`libhashkit`
- * :doc:`hashkit_create`
- * :doc:`hashkit_function`
- * :doc:`hashkit_functions`
-
-=========================================
-Welcome to the libmemcached documentation
-=========================================
+libmemcached Manual
+===================
-------------
-Libmemcached
-------------
+`libmemcached` is an open source C/C++ client library and tools for the
+memcached server (http://memcached.org/). It has been designed to be light on
+memory usage, thread safe, and provide full access to server side methods.
-.. toctree::
- :maxdepth: 1
- :caption: Basics
-
- libmemcached
- versioning
- memcached_create
- libmemcached_examples
- libmemcached_configuration
- libmemcached/memcached_last_error_message
-
-.. toctree::
- :maxdepth: 1
- :caption: Working with Data
-
- memcached_auto
- memcached_delete
- libmemcached/memcached_exist
- memcached_flush_buffers
- memcached_flush
- memcached_get
- memcached_result_st
- memcached_set
- memcached_append
- memcached_cas
-
-.. toctree::
- :maxdepth: 1
- :caption: Advanced Topics
-
- libmemcached-1.0/memcached_set_encoding_key
- memcached_behavior
- memcached_callback
- memcached_dump
- memcached_generate_hash_value
- memcached_memory_allocators
- memcached_quit
- libmemcached/memcached_return_t
- memcached_sasl
- memcached_server_st
- memcached_servers
- memcached_strerror
- error_messages
- memcached_user_data
- memcached_verbosity
- memcached_version
- libmemcached/defaults
-
-.. toctree::
- :titlesonly:
- :caption: Interface Versions
-
- libmemcached-1.0/index
- libmemcached-1.1/index
+* :ref:`genindex`
+* :ref:`search`
.. toctree::
- :titlesonly:
- :caption: Deprecated Functions
-
- libmemcached/memcached_fetch
+ :titlesonly:
+ :caption: libmemcached
-.. toctree::
- :maxdepth: 1
- :caption: Platform Specifics
+ Introduction <libmemcached>
+ libmemcached/index
+ libmemcached/index_misc
- tap
- types
.. toctree::
- :maxdepth: 1
- :caption: Deriving Statistics from a Server
+ :titlesonly:
+ :caption: libmemcachedutil
- memcached_analyze
- memcached_stats
+ Introduction <libmemcachedutil>
+ libmemcachedutil/index
.. toctree::
- :maxdepth: 1
- :caption: Libmemcachedutil
+ :titlesonly:
+ :caption: libhashkit
- libmemcachedutil
- memcached_pool
+ Introduction <libhashkit>
+ libhashkit/index
.. toctree::
- :maxdepth: 1
- :caption: Client Applications
-
- bin/memcapable
- bin/memcat
- bin/memcp
- bin/memdump
- bin/memerror
- bin/memflush
- bin/memrm
- bin/memslap
- bin/memaslap
- bin/memstat
- bin/memexist.rst
- bin/memparse.rst
- bin/memping.rst
- bin/memtouch.rst
+ :maxdepth: 1
+ :caption: Client Applications
-.. toctree::
- :maxdepth: 1
- :caption: Libhashkit
-
- libhashkit
- hashkit_create
- hashkit_function
- hashkit_functions
- hashkit_value
-
-==================
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`search`
+ bin/index
.. toctree::
- :caption: Copyright
- :hidden:
+ :caption: Copyright
+ :hidden:
- copyright
+ copyright
-Introducing libhashkit
-======================
+libhashkit - C/C++ hashing library
+==================================
SYNOPSIS
--------
DESCRIPTION
-----------
-libhashkit is a small and thread-safe client library that provides a collection of useful hashing algorithm.
+`libhashkit` is a small and thread-safe client library that provides a collection
+of useful hashing algorithm.
-libhashkit is distributed with libmemcached.
+`libhashkit` is distributed with `libmemcached`.
SEE ALSO
--------
.. only:: html
* :doc:`libmemcached`
- * :doc:`hashkit_create`
- * :doc:`hashkit_function`
- * :doc:`hashkit_functions`
- * :doc:`hashkit_value`
+ * :doc:`libhashkit/hashkit_create`
+ * :doc:`libhashkit/hashkit_function`
+ * :doc:`libhashkit/hashkit_functions`
+ * :doc:`libhashkit/hashkit_value`
--- /dev/null
+Creating a hashkit structure
+============================
+
+Create, copy and free a hashkit structure
+
+SYNOPSIS
+--------
+
+#include <libhashkit-|libhashkit_version|/hashkit.h>
+ Compile and link with -lhashkit
+
+.. type:: struct hashkit_st hashkit_st
+
+.. function:: hashkit_st *hashkit_create(hashkit_st *hash)
+
+.. function:: hashkit_st *hashkit_clone(hashkit_st *destination, const hashkit_st *ptr)
+
+.. function:: void hashkit_free(hashkit_st *hash)
+
+.. function:: bool hashkit_is_allocated(const hashkit_st *hash)
+
+DESCRIPTION
+-----------
+
+The :func:`hashkit_create` function initializes a hashkit object for use. If
+you pass a NULL argument for hash, then the memory for the object is
+allocated. If you specify a pre-allocated piece of memory, that is
+initialized for use.
+
+The :func:`hashkit_clone` function initializes a hashkit object much like
+:func:`hashkit_create`, but instead of using default settings it will use
+the settings of the ptr hashkit object.
+
+The :func:`hashkit_free` frees any resources being consumed by the hashkit
+objects that were initialized with :func:`hashkit_create` or :func:`hashkit_clone`.
+
+The :func:`hashkit_is_allocated` reports where the memory was allocated
+for a hashkit object.
+
+RETURN VALUE
+------------
+
+:func:`hashkit_create` and :func:`hashkit_clone` will return NULL on
+failure or non-NULL on success.
+
+:func:`hashkit_is_allocated` returns true if the memory for the hashkit
+object was allocated inside of :func:`hashkit_create` or
+:func:`hashkit_clone`, otherwise it is false and was user-supplied memory.
+
+SEE ALSO
+--------
+
+.. only:: man
+
+ :manpage:`libhashkit(3)`
+ :manpage:`hashkit_value(3)`
+ :manpage:`hashkit_function3)`
+
+.. only:: html
+
+ * :doc:`../libhashkit`
+ * :doc:`hashkit_value`
+ * :doc:`hashkit_function`
--- /dev/null
+Set Hash Function
+=================
+
+.. index:: object: hashkit_st
+.. index:: object: hashkit_hash_fn
+
+Set hash functions to use for calculating values for keys
+
+SYNOPSIS
+--------
+
+#include <libhashkit-|libhashkit_version|/hashkit.h>
+ Compile and link with -lhashkit
+
+.. type:: uint32_t (*hashkit_hash_fn)(const char *key, size_t key_length, void *context)
+
+.. function:: hashkit_return_t hashkit_set_function(hashkit_st *hash, hashkit_hash_algorithm_t hash_algorithm)
+
+.. function:: hashkit_return_t hashkit_set_custom_function(hashkit_st *hash, hashkit_hash_fn function, void *context)
+
+.. function:: hashkit_hash_algorithm_t hashkit_get_function(const hashkit_st *hash)
+
+.. function:: hashkit_return_t hashkit_set_distribution_function(hashkit_st *hash, hashkit_hash_algorithm_t hash_algorithm)
+
+.. function:: hashkit_return_t hashkit_set_custom_distribution_function(hashkit_st *self, hashkit_hash_fn function, void *context)
+
+.. function:: hashkit_hash_algorithm_t hashkit_get_distribution_function(const hashkit_st *self)
+
+DESCRIPTION
+-----------
+
+These functions are used to set and retrieve the key and distribution hash functions.
+
+
+RETURN VALUE
+------------
+
+:func:`hashkit_set_function`, :func:`hashkit_set_custom_function` and the distribution equivalents
+return :type:`hashkit_return_t` `HASHKIT_SUCCESS` on success.
+
+:func:`hashkit_get_function` and :func:`hashkit_get_distribution_function` return :type:`hashkit_hash_algorithm_t`
+indicating the hash function used.
+
+SEE ALSO
+--------
+
+.. only:: man
+
+ :manpage:`libhashkit(3)`
+ :manpage:`hashkit_create(3)`
+ :manpage:`hashkit_functions(3)`
+
+.. only:: html
+
+ * :doc:`../libhashkit`
+ * :doc:`hashkit_create`
+ * :doc:`hashkit_functions`
+
--- /dev/null
+Available Hashes
+================
+
+.. index:: object: hashkit_st
+
+Various hash functions to use for calculating hash values for keys
+
+SYNOPSIS
+--------
+
+#include <libhashkit-|libhashkit_version|/hashkit.h>
+ Compile and link with -lhashkit
+
+.. function:: uint32_t hashkit_default(const char *key, size_t key_length)
+
+.. function:: uint32_t hashkit_fnv1_64(const char *key, size_t key_length)
+
+.. function:: uint32_t hashkit_fnv1a_64(const char *key, size_t key_length)
+
+.. function:: uint32_t hashkit_fnv1_32(const char *key, size_t key_length)
+
+.. function:: uint32_t hashkit_fnv1a_32(const char *key, size_t key_length)
+
+.. function:: uint32_t hashkit_crc32(const char *key, size_t key_length)
+
+.. function:: uint32_t hashkit_hsieh(const char *key, size_t key_length)
+
+.. function:: uint32_t hashkit_murmur(const char *key, size_t key_length)
+
+.. function:: uint32_t hashkit_murmur3(const char *key, size_t key_length)
+
+.. function:: uint32_t hashkit_jenkins(const char *key, size_t key_length)
+
+.. function:: uint32_t hashkit_md5(const char *key, size_t key_length)
+
+DESCRIPTION
+-----------
+
+These functions generate hash values from a key using a variety of
+algorithms. These functions can be used standalone, or as arguments
+to :func:`hashkit_set_hash_fn` or :func:`hashkit_set_continuum_hash_fn`.
+
+The :func:`hashkit_hsieh` is only available if the library is built with
+the appropriate flag enabled.
+
+RETURN VALUE
+------------
+
+A 32-bit hash value.
+
+SEE ALSO
+--------
+
+.. only:: man
+
+ :manpage:`libhashkit(3)`
+ :manpage:`hashkit_create(3)`
+ :manpage:`hashkit_function(3)`
+
+.. only:: html
+
+ * :doc:`../libhashkit`
+ * :doc:`hashkit_create`
+ * :doc:`hashkit_function`
+
--- /dev/null
+Generate hash value
+===================
+
+.. index:: object: hashkit_st
+
+Generate a value for the given key
+
+SYNOPSIS
+--------
+
+#include <libhashkit-|libhashkit_version|/hashkit.h>
+ Compile and link with -lhashkit
+
+.. function:: uint32_t hashkit_value(hashkit_st *hash, const char *key, size_t key_length)
+
+DESCRIPTION
+-----------
+
+The :func:`hashkit_value` function generates a 32-bit hash value from the
+given key and key_length. The hash argument is an initialized hashkit
+object, and distribution type and hash function is used from this
+object while generating the value.
+
+RETURN VALUE
+------------
+
+A 32-bit hash value.
+
+SEE ALSO
+--------
+
+.. only:: man
+
+ :manpage:`libhashkit(3)`
+ :manpage:`hashkit_create(3)`
+ :manpage:`hashkit_function(3)`
+ :manpage:`hashkit_functions(3)`
+
+.. only:: html
+
+ * :doc:`../libhashkit`
+ * :doc:`hashkit_create`
+ * :doc:`hashkit_function`
+ * :doc:`hashkit_functions`
+
--- /dev/null
+libhashkit API
+==============
+
+.. toctree::
+ :titlesonly:
+ :caption: Hashkit API
+
+ hashkit_create
+ hashkit_function
+ hashkit_functions
+ hashkit_value
+++ /dev/null
-====================
-libmemcached 1.0 API
-====================
-
-
-.. toctree::
- :titlesonly:
-
- memcached_touch
+++ /dev/null
-==================
-Set encryption key
-==================
-
-.. index:: object: memcached_st
-
---------
-SYNOPSIS
---------
-
-#include <libmemcached/memcached.h>
-
-.. c:function:: void memcached_set_encoding_key (memcached_st *ptr, const char *string, const size_t string_length)
-
-Compile and link with -lmemcached
-
------------
-DESCRIPTION
------------
-
-
-:c:func:`memcached_set_encoding_key` sets the key that will be used to encrypt and decrypt data as it is sent and received from the server.
-
-Currently only AES is is supported.
-
-
-------
-RETURN
-------
-
-
-A value of type :c:type:`memcached_return_t` is returned On success that value
-will be :c:type:`MEMCACHED_SUCCESS`. Use :c:func:`memcached_strerror` to
-translate this value to a printable string.
-
-
-
---------
-SEE ALSO
---------
-
-.. only:: man
-
- :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
+++ /dev/null
-===========================================
-memcached_touch, memcached_touch_by_key
-===========================================
-
-.. index:: object: memcached_st
-
---------
-SYNOPSIS
---------
-
-
-#include <libmemcached/memcached.h>
-
-.. c:function:: memcached_return_t memcached_touch (memcached_st *ptr, const char *key, size_t key_length, time_t expiration)
-
-.. c:function:: memcached_return_t memcached_touch_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, time_t expiration)
-
-Compile and link with -lmemcached
-
------------
-DESCRIPTION
------------
-
-
-:c:func:`memcached_touch` is used to update the expiration time on an existing key.
-:c:func:`memcached_touch_by_key` works the same, but it takes a master key
-to find the given value.
-
-
-------
-RETURN
-------
-
-
-A value of type :c:type:`memcached_return_t` is returned
-On success that value will be :c:type:`MEMCACHED_SUCCESS`.
-Use :c:func:`memcached_strerror` to translate this value to a printable
-string.
-
-
-
---------
-SEE ALSO
---------
-
-.. only:: man
-
- :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
-
+++ /dev/null
-====================
-libmemcached 1.1 API
-====================
-
-The 1.1 is still being finalized. It will be the 1.0 API minus deprecated functions.
-==============================================
-Introducing the C Client Library for memcached
-==============================================
+C/C++ Client Library for memcached
+==================================
---------
SYNOPSIS
--------
=======
-libMemcached is an open source C/C++ client library and tools for the memcached server (http://memcached.org/).
-It has been designed to be light on memory usage, thread safe, and provide full access to server side methods.
+`libmemcached` is an open source C/C++ client library and tools for the
+memcached server (http://memcached.org/). It has been designed to be light on
+memory usage, thread safe, and provide full access to server side methods.
-libMemcached was designed to provide the greatest number of options to use Memcached. Some of the features provided:
+`libmemcached` was designed to provide the greatest number of options to use
+Memcached. Some of the features provided:
1. Asynchronous and Synchronous Transport Support.
2. Consistent Hashing and Distribution.
6. A complete reference guide and documentation to the API.
7. Tools to Manage your Memcached networks.
------------
DESCRIPTION
-----------
-
"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." `http://memcached.org/ <http://memcached.org/>`_
+applications by alleviating database load."
+`http://memcached.org/ <http://memcached.org/>`_
-:program:`libmemcached` is a small, thread-safe client library for the
+`libmemcached` 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
a modular and consistent method of object distribution.
There are multiple implemented routing and hashing methods. See the
-:c:func:`memcached_behavior_set` manpage for more information.
+:func:`memcached_behavior_set` manpage for more information.
-All operations are performed against a :c:type:`memcached_st` structure.
+All operations are performed against a :type:`memcached_st` structure.
These structures can either be dynamically allocated or statically
-allocated and then initialized by :c:func:`memcached_create`. Functions have
-been written in order to encapsulate the :c:type:`memcached_st`. It is not
+allocated and then initialized by :func:`memcached_create`. Functions have
+been written in order to encapsulate the :type:`memcached_st`. It is not
recommended that you operate directly against the structure.
-Nearly all functions return a :c:type:`memcached_return_t` value.
+Nearly all functions return a :type:`memcached_return_t` value.
This value can be translated to a printable string with
-:c:type:`memcached_strerror`.
+:type:`memcached_strerror`.
-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.
+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.
Group keys can be optionally used to group sets of objects with servers.
-Namespaces are supported, and can be used to partition caches so that multiple applications can use the same memcached servers.
-
-:c:type:`memcached_st` 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.
-
-If you are working with GNU autotools you will want to add the following to
-your COPYING to properly include libmemcached in your application.
-
-PKG_CHECK_MODULES(DEPS, libmemcached >= 0.8.0)
-AC_SUBST(DEPS_CFLAGS)
-AC_SUBST(DEPS_LIBS)
+Namespaces are supported, and can be used to partition caches so that multiple
+applications can use the same memcached servers.
-Some features of the library must be enabled through :c:func:`memcached_behavior_set`.
+Some features of the library must be enabled through `memcached_behavior_set`.
-
----------
CONSTANTS
---------
-
A number of constants have been provided for in the library.
+.. only:: man
-.. c:macro:: MEMCACHED_DEFAULT_PORT
-
- The default port used by memcached(3).
-
-
-.. c:macro:: MEMCACHED_MAX_KEY
-
- Default maximum size of a key (which includes the null pointer). Master keys
- have no limit, this only applies to keys used for storage.
-
-
-.. c:macro:: MEMCACHED_MAX_BUFFER
-
- Default size of read/write buffers (which includes the null pointer).
-
-
-.. c:macro:: MEMCACHED_STRIDE
-
- This is the "stride" used in the consistent hash used between replicas.
-
-
-.. c:macro:: MEMCACHED_MAX_HOST_LENGTH
-
- Maximum allowed size of the hostname.
-
-
-.. c:macro:: LIBMEMCACHED_VERSION_STRING
-
- String value of libmemcached version such as "1.23.4"
-
-
-.. c:macro:: LIBMEMCACHED_VERSION_HEX
-
- Hex value of the version number. "0x00048000" This can be used for comparing versions based on number.
-
-
-.. c:macro:: MEMCACHED_PREFIX_KEY_MAX_SIZE
-
- Maximum length allowed for namespacing of a key.
+ See :manpage:`libmemcached_constants(3)`.
+.. only:: html
+ See :doc:`libmemcached/constants`.
----------------------
THREADS AND PROCESSES
---------------------
+No global variables are used in this library.
-When using threads or forked processes it is important to keep one instance
-of :c:type:`memcached_st` per process or thread. Without creating your own
-locking structures you can not share a single :c:type:`memcached_st`. However,
-you can call :c:func:`memcached_quit` on a :c:type:`memcached_st` and then use the resulting cloned structure.
+:type:`memcached_st` structures are thread-safe, but when using threads or
+forked processes it is important to keep one instance of :type:`memcached_st`
+per process or thread. Without creating your own locking structures you can not
+share a single :type:`memcached_st`. However, you can call
+:func:`memcached_quit` on a :type:`memcached_st` and then use the resulting
+cloned structure.
+SYSTEMTAP
+---------
+`libmemcached` can be built to support Systemtap on Linux when enabled at
+compile time.
---------
-SEE ALSO
---------
+Please see :manpage:`stap(1)` and :manpage:`dtrace(1)` for more information
+about Systemtap.
+
+CLIENT PROGRAMS
+---------------
+
+`libmemcached` comes with a few useful client programs:
.. only:: man
:manpage:`memslap(1)`
:manpage:`memstat(1)`
:manpage:`memtouch(1)`
+
+.. only:: html
+
+ * :doc:`bin/memaslap`
+ * :doc:`bin/memcapable`
+ * :doc:`bin/memcat`
+ * :doc:`bin/memcp`
+ * :doc:`bin/memdump`
+ * :doc:`bin/memerror`
+ * :doc:`bin/memexist`
+ * :doc:`bin/memflush`
+ * :doc:`bin/memparse`
+ * :doc:`bin/memping`
+ * :doc:`bin/memrm`
+ * :doc:`bin/memslap`
+ * :doc:`bin/memstat`
+ * :doc:`bin/memtouch`
+
+UTILITY LIBRARIES
+-----------------
+
+.. only:: man
+
:manpage:`libhashkit(3)`
+ :manpage:`libmemcachedutil(3)`
+
+.. only:: html
+
+ * :doc:`libhashkit`
+ * :doc:`libmemcachedutil`
+
+
+SEE ALSO
+--------
+
+.. only:: man
+
+ :manpage:`memcached(1)`
+
:manpage:`libmemcached_configuration(3)`
:manpage:`libmemcached_examples(3)`
- :manpage:`libmemcachedutil(3)`
+
:manpage:`memcached_analyze(3)`
:manpage:`memcached_append(3)`
:manpage:`memcached_auto(3)`
.. only:: html
* :manpage:`memcached(1)`
- * :doc:`bin/memaslap`
- * :doc:`bin/memcapable`
- * :doc:`bin/memcat`
- * :doc:`bin/memcp`
- * :doc:`bin/memdump`
- * :doc:`bin/memerror`
- * :doc:`bin/memexist`
- * :doc:`bin/memflush`
- * :doc:`bin/memparse`
- * :doc:`bin/memping`
- * :doc:`bin/memrm`
- * :doc:`bin/memslap`
- * :doc:`bin/memstat`
- * :doc:`bin/memtouch`
- * :doc:`libhashkit`
- * :doc:`libmemcached_configuration`
- * :doc:`libmemcached_examples`
- * :doc:`libmemcachedutil`
- * :doc:`memcached_analyze`
- * :doc:`memcached_append`
- * :doc:`memcached_auto`
- * :doc:`memcached_behavior`
- * :doc:`memcached_callback`
- * :doc:`memcached_cas`
- * :doc:`memcached_create`
- * :doc:`memcached_delete`
- * :doc:`memcached_dump`
- * :doc:`libmemcached/memcached_exist`
- * :doc:`libmemcached/memcached_fetch`
- * :doc:`memcached_flush`
- * :doc:`memcached_flush_buffers`
- * :doc:`memcached_generate_hash_value`
- * :doc:`memcached_get`
- * :doc:`libmemcached/memcached_last_error_message`
- * :doc:`memcached_memory_allocators`
- * :doc:`memcached_pool`
- * :doc:`memcached_quit`
- * :doc:`memcached_result_st`
- * :doc:`libmemcached/memcached_return_t`
- * :doc:`memcached_sasl`
- * :doc:`memcached_servers`
- * :doc:`memcached_server_st`
- * :doc:`memcached_set`
- * :doc:`libmemcached-1.0/memcached_set_encoding_key`
- * :doc:`memcached_stats`
- * :doc:`memcached_strerror`
- * :doc:`libmemcached-1.0/memcached_touch`
- * :doc:`memcached_user_data`
- * :doc:`memcached_verbosity`
- * :doc:`memcached_version`
+
+ * :doc:`libmemcached/configuration`
+ * :doc:`libmemcached/examples`
+
--- /dev/null
+libmemcached Configuration
+==========================
+
+SYNOPSIS
+--------
+
+#include <libmemcached-1.0/memcached.h>
+ Compile and link with -lmemcached
+
+.. function:: memcached_st *memcached(const char *string, size_t string_length)
+
+.. function:: memcached_return_t libmemcached_check_configuration(const char *option_string, size_t length, char *error_buffer, size_t error_buffer_size)
+
+DESCRIPTION
+-----------
+
+`libmemcached` implements a custom language for configuring and modifying
+servers. By passing in an option string you can generate a `memcached_st` object
+that you can use in your application directly.
+
+General Options:
+~~~~~~~~~~~~~~~~
+
+.. describe:: --SERVER=<servername>:<optional_port>/?<optional_weight>
+
+ Provide a servername to be used by the client.
+
+ Providing a weight will cause weighting to occur with all hosts with each
+ server getting a default weight of 1.
+
+.. describe:: --SOCKET=\"<filepath>/?<optional_weight>\"
+
+ Provide a filepath to a UNIX socket file. Providing a weight will cause
+ weighting to occur with all hosts with each server getting a default weight
+ of 1.
+
+.. describe:: --VERIFY-KEY
+
+ Verify that keys that are being used fit within the design of the protocol
+ being used.
+
+.. describe:: --REMOVE_FAILED_SERVERS
+
+ Enable the behavior `MEMCACHED_BEHAVIOR_REMOVE_FAILED_SERVERS`.
+
+.. describe:: --BINARY-PROTOCOL
+
+ Force all connections to use the binary protocol.
+
+.. describe:: --BUFFER-REQUESTS
+
+ Please see `MEMCACHED_BEHAVIOR_BUFFER_REQUESTS`.
+
+.. describe:: --CONFIGURE-FILE=
+
+ Provide a configuration file to be used to load requests. Beware that by
+ using a configuration file `libmemcached` will reset `memcached_st` based
+ on information only contained in the file.
+
+.. describe:: --CONNECT-TIMEOUT=
+
+ See `memcached_behavior_set` for `MEMCACHED_BEHAVIOR_CONNECT_TIMEOUT`.
+
+.. describe:: --DISTRIBUTION=
+
+ Set the distribution model used by the client.
+ See `memcached_behavior_set` for more details.
+
+.. describe:: --HASH=
+
+ Set the hashing algorithm used for placing keys on servers.
+
+.. describe:: --HASH-WITH-NAMESPACE
+
+ When enabled the prefix key will be added to the key when determining which
+ server to store the data in.
+
+.. describe:: --NOREPLY
+
+ Enable "no reply" for all calls that support this. It is highly recommended
+ that you use this option with the binary protocol only.
+
+.. describe:: --NUMBER-OF-REPLICAS=
+
+ Set the number of servers that keys will be replicated to.
+
+.. describe:: --RANDOMIZE-REPLICA-READ
+
+ Select randomly the server within the replication pool to read from.
+
+.. describe:: --SORT-HOSTS
+
+ When adding new servers always calculate their distribution based on sorted
+ naming order.
+
+.. describe:: --SUPPORT-CAS
+
+ See `memcached_behavior_set` for `MEMCACHED_BEHAVIOR_SUPPORT_CAS`
+
+.. describe:: --USE-UDP
+
+ See `memcached_behavior_set` for `MEMCACHED_BEHAVIOR_USE_UDP`
+
+.. describe:: --NAMESPACE=
+
+ A namespace is a container that provides context for keys, only other
+ requests that know the namespace can access these values. This is
+ accomplished by prepending the namespace value to all keys.
+
+Memcached Pool Options:
+~~~~~~~~~~~~~~~~~~~~~~~
+
+.. describe:: --POOL-MIN
+
+ Initial size of pool.
+
+.. describe:: --POOL-MAX
+
+ Maximize size of the pool.
+
+I/O Options:
+~~~~~~~~~~~~
+
+.. describe:: --TCP-NODELAY
+
+ See `memcached_behavior_set` for `MEMCACHED_BEHAVIOR_TCP_NODELAY`
+
+.. describe:: --TCP-KEEPALIVE
+
+ See `memcached_behavior_set` for `MEMCACHED_BEHAVIOR_TCP_KEEPALIVE`
+
+.. describe:: --RETRY-TIMEOUT=
+
+ See `memcached_behavior_set` for `MEMCACHED_BEHAVIOR_RETRY_TIMEOUT`
+
+.. describe:: --SERVER-FAILURE-LIMIT=
+
+ See `memcached_behavior_set` for `MEMCACHED_BEHAVIOR_SERVER_FAILURE_LIMIT`
+
+.. describe:: --SND-TIMEOUT=
+
+ See `memcached_behavior_set` for `MEMCACHED_BEHAVIOR_SND_TIMEOUT`
+
+.. describe:: --SOCKET-RECV-SIZE=
+
+ See `memcached_behavior_set` for `MEMCACHED_BEHAVIOR_SOCKET_RECV_SIZE`
+
+.. describe:: --SOCKET-SEND-SIZE=
+
+ See `memcached_behavior_set` for `MEMCACHED_BEHAVIOR_SOCKET_SEND_SIZE`
+
+.. describe:: --POLL-TIMEOUT=
+
+ Set the timeout used by :manpage:`poll(3)`.
+
+.. describe:: --IO-BYTES-WATERMARK=
+
+.. describe:: --IO-KEY-PREFETCH=
+
+.. describe:: --IO-MSG-WATERMARK=
+
+.. describe:: --TCP-KEEPIDLE
+
+.. describe:: --RCV-TIMEOUT=
+
+Other Options:
+~~~~~~~~~~~~~~
+
+.. describe:: INCLUDE
+
+ Include a file in configuration.
+ Unlike --CONFIGURE-FILE= this will not reset `memcached_st`.
+
+.. describe:: RESET
+
+ Reset `memcached_st` and continue to process.
+
+.. describe:: END
+
+ End configuration processing.
+
+.. describe:: ERROR
+
+ End configuration processing and throw an error.
+
+ENVIRONMENT
+-----------
+
+.. envvar:: LIBMEMCACHED
+
+RETURN VALUE
+------------
+
+:func:`memcached()` returns a pointer to the memcached_st that was
+created (or initialized). On an allocation failure, it returns NULL.
+
+EXAMPLE
+-------
+
+.. code-block:: c
+
+ const char *config_string=
+ "--SERVER=host10.example.com "
+ "--SERVER=host11.example.com "
+ "--SERVER=host10.example.com";
+ memcached_st *memc= memcached(config_string, strlen(config_string));
+ {
+ // ...
+ }
+ memcached_free(memc);
+
+SEE ALSO
+--------
+
+.. only:: man
+
+ :manpage:`memcached(1)`
+ :manpage:`libmemcached(3)`
+ :manpage:`memcached_strerror(3)`
+
+.. only:: html
+
+ * :manpage:`memcached(1)`
+ * :doc:`../libmemcached`
+ * :doc:`memcached_strerror`
--- /dev/null
+libmemcached Constants and Defaults
+===================================
+
+SYNOPSIS
+--------
+
+#include <libmemcached-1.0/memcached.h>
+ Compile and link with -lmemcached
+
+.. c:macro:: LIBMEMCACHED_VERSION_STRING
+
+ String value of libmemcached version such as "1.23.4"
+
+.. c:macro:: LIBMEMCACHED_VERSION_HEX
+
+ Hex value of the version number. "0x00048000" This can be used for comparing
+ versions based on number.
+
+
+.. c:macro:: MEMCACHED_DEFAULT_PORT
+
+ The default port used by `memcached`.
+
+.. c:macro:: MEMCACHED_DEFAULT_TIMEOUT
+
+ Default timeout of 5000 milliseconds.
+
+.. c:macro:: MEMCACHED_DEFAULT_CONNECT_TIMEOUT
+
+ Default connect timeout of 4000 milliseconds.
+
+
+.. c:macro:: MEMCACHED_MAX_BUFFER
+
+ Default size of read/write buffers (which includes the null pointer).
+
+.. c:macro:: MEMCACHED_MAX_KEY
+
+ Default maximum size of a key (which includes the null pointer). Master keys
+ have no limit, this only applies to keys used for storage.
+
+.. c:macro:: MEMCACHED_MAX_NAMESPACE
+
+ Maximum length allowed for namespacing of a key. Defaults to 128.
+
+
+.. c:macro:: MEMCACHED_MAX_HOST_LENGTH
+
+ Maximum allowed length of the hostname.
+
+.. c:macro:: MEMCACHED_MAX_HOST_SORT_LENGTH
+
+ Length of the host string used for sorting. Used for Ketama.
+
+.. c:macro:: MEMCACHED_MAX_INTEGER_DISPLAY_LENGTH
+
+ Maximum display width of an integer represented as string.
+
+
+
+.. c:macro:: MEMCACHED_CONTINUUM_ADDITION
+
+ How many extra slots we should build for in the continuum, defaults to 10.
+
+.. c:macro:: MEMCACHED_STRIDE
+
+ This is the "stride" used in the consistent hash used between replicas.
+
+
+.. c:macro:: MEMCACHED_SERVER_FAILURE_LIMIT
+
+ Value 5
+
+.. c:macro:: MEMCACHED_SERVER_FAILURE_RETRY_TIMEOUT
+
+ Value 2
+
+.. c:macro:: MEMCACHED_SERVER_FAILURE_DEAD_TIMEOUT
+
+ Value 0
+
+
+.. c:macro:: MEMCACHED_VERSION_STRING_LENGTH
+
+ Value 24
+
+DESCRIPTION
+-----------
+
+These compile time defaults are provided by `libmemcached` for convenience.
+++ /dev/null
-========
-DEFAULTS
-========
-
-
-.. c:macro:: MEMCACHED_DEFAULT_TIMEOUT
-
- Value 5000
-
-.. c:macro:: MEMCACHED_DEFAULT_CONNECT_TIMEOUT
-
- Value 4000
-
-.. c:macro:: MEMCACHED_CONTINUUM_ADDITION
-
- Value 10. How many extra slots we should build for in the continuum.
-
-.. c:macro:: MEMCACHED_SERVER_FAILURE_LIMIT
-
- Value 5
-
-.. c:macro:: MEMCACHED_SERVER_FAILURE_RETRY_TIMEOUT
-
- Value 2
-
-.. c:macro:: MEMCACHED_SERVER_FAILURE_DEAD_TIMEOUT
-
- Value 0
-
-.. c:macro:: `MEMCACHED_PREFIX_KEY_MAX_SIZE`
-
- Value 128
-
-.. c:macro:: MEMCACHED_VERSION_STRING_LENGTH
-
- Value 24
--- /dev/null
+libmemcached Examples
+=====================
+
+Examples for libmemcached
+
+DESCRIPTION
+-----------
+
+For full examples, test cases are found in tests/\*.c in the main
+distribution. These are always up to date, and are used for each test run of
+the library.
+
+Connecting to servers
+---------------------
+
+.. code-block:: c
+
+ const char *config_string =
+ "--SERVER=host10.example.com "
+ "--SERVER=host11.example.com "
+ "--SERVER=host10.example.com";
+ memcached_st *memc= memcached(config_string, strlen(config_string);
+ {
+ // ...
+ }
+ memcached_free(memc);
+
+In the above code you create a :type:`memcached_st` object with three server
+by making use of :func:`memcached_create`.
+
+Creating a pool of servers
+--------------------------
+
+.. code-block:: c
+
+ const char *config_string= "--SERVER=host10.example.com --SERVER=host11.example.com --SERVER=host10.example.com";
+
+ memcached_pool_st* pool= memcached_pool(config_string, strlen(config_string));
+
+ memcached_return_t rc;
+
+ memcached_st *memc= memcached_pool_pop(pool, false, &rc);
+
+ // .... do work
+
+ /*
+ Release the memc_ptr that was pulled from the pool
+ */
+ memcached_pool_push(pool, memc);
+
+ /*
+ Destroy the pool.
+ */
+ memcached_pool_destroy(pool);
+
+In the above code you create a :type:`memcached_pool_st` object with three
+server by making use of :func:`memcached_pool()`.
+
+When :func:`memcached_pool_destroy()` all memory will be released that is associated
+with the pool.
+
+Adding a value to the server
+----------------------------
+
+.. code-block:: c
+
+ char *key= "foo";
+ char *value= "value";
+ time_t expires = 0;
+ uint32_t flags = 0;
+
+ memcached_return_t rc = memcached_set(memc,
+ key, strlen(key),
+ value, value_length,
+ expires, flags);
+
+ if (rc != MEMCACHED_SUCCESS)
+ {
+ // handle failure
+ }
+
+It is best practice to always look at the return value of any operation.
+
+Fetching multiple values
+------------------------
+
+.. code-block:: c
+
+ memcached_return_t rc;
+ char *keys[]= {"fudge", "son", "food"};
+ size_t key_length[]= {5, 3, 4};
+ unsigned int x;
+ uint32_t flags;
+
+ char return_key[MEMCACHED_MAX_KEY];
+ size_t return_key_length;
+ char *return_value;
+ size_t return_value_length;
+
+ rc= memcached_mget(memc, keys, key_length, 3);
+
+ x= 0;
+ while ((return_value= memcached_fetch(memc, return_key, &return_key_length,
+ &return_value_length, &flags, &rc)))
+ {
+ free(return_value);
+ x++;
+ }
+
+Notice that you freed values returned from memcached_fetch(). The define
+`MEMCACHED_MAX_KEY` is provided for usage.
+
+SEE ALSO
+--------
+
+ :manpage:`memcached(1)`
+
--- /dev/null
+libmemcached API
+================
+
+.. toctree::
+ :titlesonly:
+ :caption: Basics
+
+ index_basics
+
+.. toctree::
+ :titlesonly:
+ :caption: Working with Data
+
+ index_data
+
+.. toctree::
+ :titlesonly:
+ :caption: Messages and Errors
+
+ index_errors
+
+.. toctree::
+ :caption: Advanced Topics
+ :titlesonly:
+
+ index_advanced
+
+.. toctree::
+ :titlesonly:
+ :caption: Deprecated Functionality
+
+ index_deprecated
+
+.. toctree:
+ :titlesonlx:
+ :caption: Misc
+
+ index_misc
--- /dev/null
+Advanced Topics
+===============
+
+.. toctree::
+ :titlesonly:
+ :caption: Internal Behavior
+
+ index_advanced_internals
+
+.. toctree::
+ :titlesonly:
+ :caption: Authentication, Encryption & Hashing
+
+ index_advanced_aeh.rst
+
+.. toctree::
+ :titlesonly:
+ :caption: Servers and Server Lists
+
+ index_advanced_servers
+
+.. toctree::
+ :titlesonly:
+ :caption: Affecting the memcached Daemon
+
+ index_advanced_daemon
+
+.. toctree::
+ :titlesonly:
+ :caption: Deriving Statistics from a Server
+
+ index_advanced_stats
--- /dev/null
+Authentication, Encryption & Hashing
+====================================
+
+.. toctree::
+ :titlesonly:
+
+ memcached_set_encoding_key
+ memcached_generate_hash_value
+ memcached_sasl
--- /dev/null
+Affecting the memcached Daemon
+==============================
+
+.. toctree::
+ :titlesonly:
+
+ memcached_dump
+ memcached_flush
+ memcached_verbosity
+ memcached_version
--- /dev/null
+Internal Behavior
+=================
+
+.. toctree::
+ :titlesonly:
+
+ memcached_behavior
+ memcached_callback
+ memcached_memory_allocators
+ memcached_user_data
--- /dev/null
+Servers and Server Lists
+========================
+
+.. toctree::
+ :titlesonly:
+
+ memcached_server_st
+ memcached_servers
--- /dev/null
+Statistics
+==========
+
+.. toctree::
+ :titlesonly:
+
+ memcached_analyze
+ memcached_stats
--- /dev/null
+Basics
+======
+
+.. toctree::
+ :titlesonly:
+
+ memcached_create
+ memcached_get
+ memcached_set
+ memcached_delete
+ memcached_quit
--- /dev/null
+Working with Data
+=================
+
+.. toctree::
+ :titlesonly:
+
+ memcached_auto
+ memcached_exist
+ memcached_touch
+
+ memcached_flush_buffers
+ memcached_result_st
+
+ memcached_append
+ memcached_cas
--- /dev/null
+Deprecated Functionality
+========================
+
+.. toctree::
+ :titlesonly:
+
+ memcached_fetch
+
--- /dev/null
+Messages and Errors
+===================
+
+.. toctree::
+ :titlesonly:
+
+ memcached_return_t
+ memcached_last_error
+ memcached_strerror
--- /dev/null
+Misc
+====
+
+.. toctree::
+ :titlesonly:
+
+ Configuration <configuration>
+ Constants <constants>
+ Examples <examples>
+ Versioning <versioning>
--- /dev/null
+=================
+Analyzing servers
+=================
+
+Analyze server information
+
+--------
+SYNOPSIS
+--------
+
+.. index:: object: memcached_analysis_st
+
+#include <libmemcached/memcached.h>
+ Compile and link with -lmemcached
+
+.. type:: memcached_analysis_st
+
+ typedef struct memcached_analysis_st memcached_analysis_st;
+
+.. function:: memcached_analysis_st *memcached_analyze(memcached_st *ptr, memcached_stat_st *stat, memcached_return_t *error)
+
+-----------
+DESCRIPTION
+-----------
+
+`libmemcached` has the ability to query a memcached server (or
+collection of servers) for their current state. Queries to find state return a
+:type:`memcached_analysis_st` structure. You are responsible for freeing this structure.
+
+:func:`memcached_analyze` analyzes useful information based on the
+provided servers and sets the result to the :type:`memcached_analysis_st`
+structure. The return value must be freed by the calling application.
+
+A command line tool, :program:`memstat` with the option :option:`memstat --analyze`,
+is provided so that you do not have to write an application to use this method.
+
+------
+RETURN
+------
+
+A pointer to the allocated :type:`memcached_analysis_st` structure on
+success and a NULL pointer on failure. You may inspect the error detail by
+checking the :type:`memcached_return_t` value.
+
+Any method returning a :type:`memcached_analysis_st` expects you to free the
+memory allocated for it.
+
+--------
+SEE ALSO
+--------
+
+.. only:: man
+
+ :manpage:`memcached(1)`
+ :manpage:`libmemcached(3)`
+ :manpage:`memcached_strerror(3)`
+
+.. only:: html
+
+ * :manpage:`memcached(1)`
+ * :doc:`../libmemcached`
+ * :doc:`memcached_strerror`
--- /dev/null
+=============================================
+Appending or Prepending to data on the server
+=============================================
+
+.. index:: object: memcached_st
+
+Appending or Prepending to data on the server
+
+
+--------
+SYNOPSIS
+--------
+
+
+#include <libmemcached/memcached.h>
+
+.. function:: memcached_return_t memcached_prepend(memcached_st *ptr, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags)
+
+.. function:: memcached_return_t memcached_append(memcached_st *ptr, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags)
+
+.. function:: memcached_return_t memcached_prepend_by_key(memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags)
+
+.. function:: memcached_return_t memcached_append_by_key(memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags)
+
+Compile and link with -lmemcached
+
+
+-----------
+DESCRIPTION
+-----------
+
+
+:func:`memcached_prepend` and memcached_append are used to
+modify information on a server. All methods take a key, and its length to
+store the object. Keys are currently limited to 250 characters when using
+either a version of memcached which is 1.4 or below, or when using the text
+protocol. You must supply both a value and a length. Optionally you
+may test an expiration time for the object and a 16 byte value (it is
+meant to be used as a bitmap). "flags" is a 4byte space that is stored
+alongside of the main value. Many sub libraries make use of this field,
+so in most cases users should avoid making use of it.
+
+:func:`memcached_prepend` places a segment of data before the last piece
+of data stored. Currently expiration and key are not used in the server.
+
+:func:`memcached_append` places a segment of data at the end of the last
+piece of data stored. Currently expiration and key are not used in the server.
+
+:func:`memcached_prepend_by_key` and
+:func:`memcached_append_by_key` methods both behave in a similar
+method as the non key methods. The difference is that they use their
+group_key parameter to map objects to particular servers.
+
+If you are looking for performance, :func:`memcached_set` with non-blocking
+IO is the fastest way to store data on the server.
+
+All of the above functions are tested with the
+`MEMCACHED_BEHAVIOR_USE_UDP` behavior enabled. However, when using
+these operations with this behavior on, there are limits to the size of the
+payload being sent to the server. The reason for these limits is that the
+Memcached Server does not allow multi-datagram requests
+and the current server implementation sets a datagram size to 1400 bytes. Due
+to protocol overhead, the actual limit of the user supplied data is less than
+1400 bytes and depends on the protocol in use as, well as the operation being
+executed. When running with the binary protocol,
+`MEMCACHED_BEHAVIOR_BINARY_PROTOCOL`, the size of the key,value,
+flags and expiry combined may not exceed 1368 bytes. When running with the
+ASCII protocol, the exact limit fluctuates depending on which function is
+being executed and whether the function is a cas operation or not. For
+non-cas ASCII set operations, there are at least 1335 bytes available
+to split among the key, key_prefix, and value; for cas ASCII operations
+there are at least 1318 bytes available to split among the key, key_prefix
+and value. If the total size of the command, including overhead, exceeds
+1400 bytes, a `MEMCACHED_WRITE_FAILURE` will be returned.
+
+
+------
+RETURN
+------
+
+
+All methods return a value of type :type:`memcached_return_t`.
+On success the value will be `MEMCACHED_SUCCESS`.
+Use :func:`memcached_strerror` to translate this value to a printable
+string.
+
+
+--------
+SEE ALSO
+--------
+
+.. only:: man
+
+ :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` :manpage:`memcached_set(3)` :manpage:`memcached_add(3)` :manpage:`memcached_cas(3)` :manpage:`memcached_replace(3)`
+
--- /dev/null
+====================================
+Incrementing and Decrementing Values
+====================================
+
+.. index:: object: memcached_st
+
+--------
+SYNOPSIS
+--------
+
+#include <libmemcached/memcached.h>
+
+.. function:: memcached_return_t memcached_increment (memcached_st *ptr, const char *key, size_t key_length, uint32_t offset, uint64_t *value)
+
+.. function:: memcached_return_t memcached_decrement (memcached_st *ptr, const char *key, size_t key_length, uint32_t offset, uint64_t *value)
+
+.. function:: memcached_return_t memcached_increment_with_initial (memcached_st *ptr, const char *key, size_t key_length, uint64_t offset, uint64_t initial, time_t expiration, uint64_t *value)
+
+.. function:: memcached_return_t memcached_decrement_with_initial (memcached_st *ptr, const char *key, size_t key_length, uint64_t offset, uint64_t initial, time_t expiration, uint64_t *value)
+
+.. function:: memcached_return_t memcached_increment_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, uint32_t offset, uint64_t *value)
+
+.. function:: memcached_return_t memcached_decrement_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, uint32_t offset, uint64_t *value)
+
+.. function:: memcached_return_t memcached_increment_with_initial_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, uint64_t offset, uint64_t initial, time_t expiration, uint64_t *value)
+
+.. function:: memcached_return_t memcached_decrement_with_initial_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, uint64_t offset, uint64_t initial, time_t expiration, uint64_t *value)
+
+Compile and link with -lmemcached
+
+
+-----------
+DESCRIPTION
+-----------
+
+
+:manpage:`memcached(1)` servers have the ability to increment and decrement keys
+(overflow and underflow are not detected). This gives you the ability to use
+memcached to generate shared sequences of values.
+
+memcached_increment takes a key and key length and increments the value by
+the offset passed to it. The value is then returned via the uint32_t
+value pointer you pass to it.
+
+memcached_decrement takes a key and keylength and decrements the value by
+the offset passed to it. The value is then returned via the uint32_t
+value pointer you pass to it.
+
+memcached_increment_with_initial takes a key and keylength and increments
+the value by the offset passed to it. If the object specified by key does
+not exist, one of two things may happen: If the expiration value is
+MEMCACHED_EXPIRATION_NOT_ADD, the operation will fail. For all other
+expiration values, the operation will succeed by seeding the value for that
+key with a initial value to expire with the provided expiration time. The
+flags will be set to zero.The value is then returned via the uint32_t
+value pointer you pass to it. memcached_increment_with_initial is only available
+when using the binary protocol.
+
+memcached_decrement_with_initial takes a key and keylength and decrements
+the value by the offset passed to it. If the object specified by key does
+not exist, one of two things may happen: If the expiration value is
+MEMCACHED_EXPIRATION_NOT_ADD, the operation will fail. For all other
+expiration values, the operation will succeed by seeding the value for that
+key with a initial value to expire with the provided expiration time. The
+flags will be set to zero.The value is then returned via the uint32_t
+value pointer you pass to it. memcached_decrement_with_initial is only available
+when using the binary protocol.
+
+:func:`memcached_increment_by_key`, :func:`memcached_decrement_by_key`,
+:func:`memcached_increment_with_initial_by_key`, and
+:func:`memcached_decrement_with_initial_by_key` are master key equivalents of the above.
+
+
+------
+RETURN
+------
+
+
+A value of type :type:`memcached_return_t` is returned.
+On success that value will be `MEMCACHED_SUCCESS`.
+Use memcached_strerror to translate this value to a printable string.
+
+
+--------
+SEE ALSO
+--------
+
+.. only:: man
+
+ :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
--- /dev/null
+Behaviors of the library
+========================
+
+Manipulate the behavior of a memcached_st structure.
+
+.. index:: object: memcached_st
+
+SYNOPSIS
+--------
+
+#include <libmemcached/memcached.h>
+ Compile and link with -lmemcached
+
+.. c:type:: typedef enum memcached_behavior_t memcached_behavior_t;
+
+.. function:: uint64_t memcached_behavior_get (memcached_st *ptr, memcached_behavior_t flag)
+
+.. function:: memcached_return_t memcached_behavior_set (memcached_st *ptr, memcached_behavior_t flag, uint64_t data)
+
+ .. versionchanged:: 0.17
+ The `data` argument of :func:`memcached_behavior_set` was changed in
+ from taking a pointer to data value, to taking a uin64_t.
+
+.. c:type:: enum memcached_behavior_t memcached_behavior_t
+
+.. enum:: memcached_behavior_t
+
+ .. enumerator:: MEMCACHED_BEHAVIOR_USE_UDP
+
+ Causes `libmemcached` to use the UDP transport when communicating with a
+ memcached server. Not all I/O operations are tested when this behavior
+ is enabled.
+
+ The following operations will return `MEMCACHED_NOT_SUPPORTED` when
+ executed with `MEMCACHED_BEHAVIOR_USE_UDP` enabled:
+
+ * :func:`memcached_version`,
+ * :func:`memcached_stat`,
+ * :func:`memcached_get`,
+ * :func:`memcached_get_by_key`,
+ * :func:`memcached_mget`,
+ * :func:`memcached_mget_by_key`,
+ * :func:`memcached_fetch`,
+ * :func:`memcached_fetch_result`,
+ * :func:`memcached_fetch_execute`.
+
+ All other operations are tested but are executed in a 'fire-and-forget'
+ mode, in which once the client has executed the operation, no attempt
+ will be made to ensure the operation has been received and acted on by
+ the server.
+
+ `libmemcached` does not allow TCP and UDP servers to be shared within
+ the same `libmemcached` client 'instance'. An attempt to add a TCP
+ server when this behavior is enabled will result in a
+ `MEMCACHED_INVALID_HOST_PROTOCOL`, as will attempting to add a UDP
+ server when this behavior has not been enabled.
+
+ .. enumerator:: MEMCACHED_BEHAVIOR_NO_BLOCK
+
+ Causes `libmemcached` to use asynchronous IO. This is the fastest
+ transport available for storage functions.
+
+ .. enumerator:: MEMCACHED_BEHAVIOR_SND_TIMEOUT
+
+ This sets the microsecond behavior of the socket against the SO_SNDTIMEO
+ flag.
+
+ In cases where you cannot use non-blocking IO this will allow you to
+ still have timeouts on the sending of data.
+
+ .. enumerator:: MEMCACHED_BEHAVIOR_RCV_TIMEOUT
+
+ This sets the microsecond behavior of the socket against the SO_RCVTIMEO
+ flag.
+
+ In cases where you cannot use non-blocking IO this will allow you to
+ still have timeouts on the reading of data.
+
+ .. enumerator:: MEMCACHED_BEHAVIOR_TCP_NODELAY
+
+ Turns on the no-delay feature for connecting sockets (may be faster in
+ some environments).
+
+ .. enumerator:: MEMCACHED_BEHAVIOR_HASH
+
+ Set the hash algorithm used for keys.
+
+ The value can be set to either:
+
+ * `MEMCACHED_HASH_DEFAULT`,
+ * `MEMCACHED_HASH_MD5`,
+ * `MEMCACHED_HASH_CRC`,
+ * `MEMCACHED_HASH_FNV1_64`,
+ * `MEMCACHED_HASH_FNV1A_64`,
+ * `MEMCACHED_HASH_FNV1_32`,
+ * `MEMCACHED_HASH_FNV1A_32`,
+ * `MEMCACHED_HASH_JENKINS`,
+ * `MEMCACHED_HASH_HSIEH`, and
+ * `MEMCACHED_HASH_MURMUR`.
+
+ Each hash has its advantages and its weaknesses. If you don't know or
+ don't care, just go with the default.
+
+ Support for `MEMCACHED_HASH_HSIEH` is a compile time option that is
+ disabled by default. To enable tests for this hashing algorithm,
+ configure and build libmemcached with the Hsieh hash enabled.
+
+ .. enumerator:: MEMCACHED_BEHAVIOR_DISTRIBUTION
+
+ Using this you can enable different means of distributing values to
+ servers.
+
+ The default method is `MEMCACHED_DISTRIBUTION_MODULA`.
+
+ You can enable consistent hashing by setting
+ `MEMCACHED_DISTRIBUTION_CONSISTENT`. Consistent hashing delivers better
+ distribution and allows servers to be added to the cluster with minimal
+ cache losses.
+
+ Currently `MEMCACHED_DISTRIBUTION_CONSISTENT` is an alias for the
+ value type:`MEMCACHED_DISTRIBUTION_CONSISTENT_KETAMA`.
+
+ .. enumerator:: MEMCACHED_BEHAVIOR_CACHE_LOOKUPS
+
+ .. deprecated:: 0.46(?)
+ DNS lookups are now always cached until an error occurs with the
+ server.
+
+ Memcached can cache named lookups so that DNS lookups are made only once.
+
+ .. enumerator:: MEMCACHED_BEHAVIOR_SUPPORT_CAS
+
+ Support CAS operations (this is not enabled by default at this point in
+ the server since it imposes a slight performance penalty).
+
+ .. enumerator:: MEMCACHED_BEHAVIOR_KETAMA
+
+ Sets the default distribution to
+ `MEMCACHED_DISTRIBUTION_CONSISTENT_KETAMA` and the hash to
+ `MEMCACHED_HASH_MD5`.
+
+ .. enumerator:: MEMCACHED_BEHAVIOR_KETAMA_WEIGHTED
+
+ Sets the default distribution to
+ `MEMCACHED_DISTRIBUTION_CONSISTENT_KETAMA` with the weighted tests.
+ Makes the default hashing algorithm for keys use MD5.
+
+ .. enumerator:: MEMCACHED_BEHAVIOR_KETAMA_HASH
+
+ Sets the hashing algorithm for host mapping on continuum.
+
+ The value can be set to either:
+
+ * `MEMCACHED_HASH_DEFAULT`,
+ * `MEMCACHED_HASH_MD5`,
+ * `MEMCACHED_HASH_CRC`,
+ * `MEMCACHED_HASH_FNV1_64`,
+ * `MEMCACHED_HASH_FNV1A_64`,
+ * `MEMCACHED_HASH_FNV1_32`, and
+ * `MEMCACHED_HASH_FNV1A_32`.
+
+ .. enumerator:: MEMCACHED_BEHAVIOR_KETAMA_COMPAT
+
+ Sets the compatibility mode. The value can be set to either
+ `MEMCACHED_KETAMA_COMPAT_LIBMEMCACHED` (this is the default) or
+ `MEMCACHED_KETAMA_COMPAT_SPY` to be compatible with the SPY Memcached
+ client for Java.
+
+ .. enumerator:: MEMCACHED_BEHAVIOR_POLL_TIMEOUT
+
+ Modify the timeout in milliseconds value that is used by poll. The
+ default value is -1. An signed int must be passed to
+ `memcached_behavior_set` to change this value (this requires casting).
+ For `memcached_behavior_get` a 'signed int' value will be cast and
+ returned as 'unsigned long long'.
+
+ .. enumerator:: MEMCACHED_BEHAVIOR_USER_DATA
+
+ .. deprecated:: < 0.30
+
+ .. enumerator:: MEMCACHED_BEHAVIOR_BUFFER_REQUESTS
+
+ Enabling buffered IO causes commands to "buffer" instead of being sent.
+ Any action that gets data causes this buffer to be be sent to the remote
+ connection. Quiting the connection or closing down the connection will
+ also cause the buffered data to be pushed to the remote connection.
+
+ .. enumerator:: MEMCACHED_BEHAVIOR_VERIFY_KEY
+
+ Enabling this will cause `libmemcached` to test all keys to verify that
+ they are valid keys.
+
+ .. enumerator:: MEMCACHED_BEHAVIOR_SORT_HOSTS
+
+ Enabling this will cause hosts that are added to be placed in the host
+ list in sorted order. This will defeat consistent hashing.
+
+ .. enumerator:: MEMCACHED_BEHAVIOR_CONNECT_TIMEOUT
+
+ In non-blocking mode this changes the value of the timeout during socket
+ connection in milliseconds. Specifying -1 means an infinite time‐out.
+
+ .. enumerator:: MEMCACHED_BEHAVIOR_BINARY_PROTOCOL
+
+ Enable the use of the binary protocol. Please note that you cannot
+ toggle this flag on an open connection.
+
+ .. enumerator:: MEMCACHED_BEHAVIOR_IO_MSG_WATERMARK
+
+ Set this value to tune the number of messages that may be sent before
+ `libmemcached` should start to automatically drain the input queue.
+
+ Setting this value to high, may cause `libmemcached` to deadlock (trying
+ to send data, but the send will block because the input buffer in the
+ kernel is full).
+
+ .. enumerator:: MEMCACHED_BEHAVIOR_IO_BYTES_WATERMARK
+
+ Set this value to tune the number of bytes that may be sent before
+ `libmemcached` should start to automatically drain the input queue (need
+ at least 10 IO requests sent without reading the input buffer).
+
+ Setting this value to high, may cause libmemcached to deadlock (trying to
+ send data, but the send will block because the input buffer in the kernel
+ is full).
+
+ .. enumerator:: MEMCACHED_BEHAVIOR_IO_KEY_PREFETCH
+
+ The binary protocol works a bit different than the textual protocol in
+ that a multiget is implemented as a pipe of single get-operations which
+ are sent to the server in a chunk.
+
+ If you are using large multigets from your application, you may improve
+ the latency of the gets by setting this value so you send out the first
+ chunk of requests when you hit the specified limit. It allows the
+ servers to start processing the requests to send the data back while the
+ rest of the requests are created and sent to the server.
+
+ .. enumerator:: MEMCACHED_BEHAVIOR_NOREPLY
+
+ Set this value to specify that you really don't care about the result
+ from your storage commands (set, add, replace, append, prepend).
+
+ .. enumerator:: MEMCACHED_BEHAVIOR_NUMBER_OF_REPLICAS
+
+ Specify the numbers of replicas `libmemcached` should store of each item
+ (on different servers).
+
+ This replication does not dedicate certain memcached servers to store
+ the replicas in, but instead it will store the replicas together with
+ all of the other objects (on the 'n' next servers specified in your
+ server list).
+
+ .. enumerator:: MEMCACHED_BEHAVIOR_RANDOMIZE_REPLICA_READ
+
+ Allows randomizing the replica reads starting point. Normally the read
+ is done from primary server and in case of miss the read is done from
+ primary + 1, then primary + 2 all the way to 'n' replicas.
+
+ If this option is set on the starting point of the replica reads is
+ randomized between the servers. This allows distributing read load to
+ multiple servers with the expense of more write traffic.
+
+ .. enumerator:: MEMCACHED_BEHAVIOR_CORK
+
+ .. deprecated:: ?
+ This open has been deprecated with the behavior now built and used
+ appropriately on selected platforms.
+
+ .. enumerator:: MEMCACHED_BEHAVIOR_KEEPALIVE
+
+ Enable TCP_KEEPALIVE behavior.
+
+ .. enumerator:: MEMCACHED_BEHAVIOR_KEEPALIVE_IDLE
+
+ Specify time, in seconds, to mark a connection as idle. This is only
+ available as an option Linux.
+
+ .. enumerator:: MEMCACHED_BEHAVIOR_SOCKET_SEND_SIZE
+
+ Find the current size of SO_SNDBUF. A value of 0 means either an error
+ occurred or no hosts were available. It is safe to assume system default
+ if this occurs.
+
+ If an error occurs you can check the last cached errno to find the
+ specific error.
+
+ .. enumerator:: MEMCACHED_BEHAVIOR_SOCKET_RECV_SIZE
+
+ Find the current size of SO_RCVBUF. A value of 0 means either an error
+ occurred or no hosts were available. It is safe to assume system default
+ if this occurs.
+
+ If an error occurs you can check the last cached errno to find the
+ specific error.
+
+ .. enumerator:: MEMCACHED_BEHAVIOR_SERVER_FAILURE_LIMIT
+
+ .. deprecated:: 0.48
+ See `MEMCACHED_BEHAVIOR_REMOVE_FAILED_SERVERS`
+
+ Set this value to enable the server be removed after continuous
+ `MEMCACHED_BEHAVIOR_SERVER_FAILURE_LIMIT` times connection failure.
+
+ .. enumerator:: MEMCACHED_BEHAVIOR_AUTO_EJECT_HOSTS
+
+ .. deprecated:: 0.48
+ See `MEMCACHED_BEHAVIOR_REMOVE_FAILED_SERVERS`
+
+ If enabled any hosts which have been flagged as disabled will be removed
+ from the list of servers in the `memcached_st` structure. This must be
+ used in combination with `MEMCACHED_BEHAVIOR_SERVER_FAILURE_LIMIT`.
+
+ .. enumerator:: MEMCACHED_BEHAVIOR_REMOVE_FAILED_SERVERS
+
+ If enabled any hosts which have been flagged as disabled will be removed
+ from the list of servers in the `memcached_st` structure.
+
+ .. enumerator:: MEMCACHED_BEHAVIOR_RETRY_TIMEOUT
+
+ When enabled a host which is problematic will only be checked for usage
+ based on the amount of time set by this behavior. The value is in
+ seconds.
+
+ .. enumerator:: MEMCACHED_BEHAVIOR_HASH_WITH_PREFIX_KEY
+
+ When enabled the prefix key will be added to the key when determining
+ server by hash. See `MEMCACHED_CALLBACK_NAMESPACE` for additional
+ information.
+
+DESCRIPTION
+-----------
+
+`libmemcached` behavior can be modified by using :func:`memcached_behavior_set`.
+Default behavior is the library strives to be quick and accurate. Some behavior,
+while being faster, can also result in not entirely accurate behavior (for
+instance, :func:`memcached_set` will always respond with `MEMCACHED_SUCCESS`).
+
+:func:`memcached_behavior_get` takes a behavior flag and returns whether or not
+that behavior is currently enabled in the client.
+
+:func:`memcached_behavior_set` changes the value of a particular option of the
+client. It takes both a flag (listed below) and a value. For simple on or off
+options you just need to pass in a value of 1. Calls to
+:func:`memcached_behavior_set` will flush and reset all connections.
+
+RETURN VALUE
+------------
+
+:func:`memcached_behavior_get` returns either the current value of the key, or 0
+or 1 on simple flag behaviors (1 being enabled). :func:`memcached_behavior_set`
+returns failure or success.
+
+NOTES
+-----
+
+The `data` argument of :func:`memcached_behavior_set` was changed in version
+0.17 from taking a pointer to data value, to taking a uin64_t.
+
+SEE ALSO
+--------
+
+.. only:: man
+
+ :manpage:`memcached(1)`
+ :manpage:`setsockopt(3)`
+ :manpage:`libmemcached(3)`
+ :manpage:`memcached_strerror(3)`
+
+.. only:: html
+
+ * :manpage:`memcached(1)`
+ * :manpage:`setsockopt(3)`
+ * :doc:`../libmemcached`
+ * :doc:`memcached_strerror`
--- /dev/null
+Setting callbacks
+=================
+
+Get and set a callback
+
+.. index:: object: memcached_st
+
+SYNOPSIS
+--------
+
+#include <libmemcached/memcached.h>
+ Compile and link with -lmemcached
+
+.. function:: memcached_return_t memcached_callback_set(memcached_st *ptr, memcached_callback_t flag, const void *data)
+
+.. function:: void *memcached_callback_get(memcached_st *ptr, memcached_callback_t flag, memcached_return_t *error)
+
+.. c:type:: enum memcached_callback_t memcached_callback_t
+
+.. enum:: memcached_callback_t
+
+ .. enumerator:: MEMCACHED_CALLBACK_CLEANUP_FUNCTION
+
+ When :func:`memcached_delete` is called this function will be executed. At
+ the point of its execution all connections are closed.
+
+
+ .. enumerator:: MEMCACHED_CALLBACK_CLONE_FUNCTION
+
+ When :func:`memcached_delete` is called this function will be executed.
+ At the point of its execution all connections are closed.
+
+ .. enumerator:: MEMCACHED_CALLBACK_PREFIX_KEY
+
+ See `MEMCACHED_CALLBACK_NAMESPACE`
+
+ .. enumerator:: MEMCACHED_CALLBACK_NAMESPACE
+
+ You can set a value which will be used to create a domain for your keys.
+ The value specified here will be prefixed to each of your keys. The value can
+ not be greater then `MEMCACHED_PREFIX_KEY_MAX_SIZE` - 1 and will
+ reduce `MEMCACHED_MAX_KEY` by the value of your key.
+
+ The prefix key is only applied to the primary key, not the master key.
+ `MEMCACHED_FAILURE` will be returned if no key is set. In the case of
+ a key which is too long, `MEMCACHED_BAD_KEY_PROVIDED` will be returned.
+
+ If you set a value with the value being NULL then the prefix key is disabled.
+
+ .. enumerator:: MEMCACHED_CALLBACK_USER_DATA
+
+ This allows you to store a pointer to a specific piece of data. This can be
+ retrieved from inside of :func:`memcached_fetch_execute`. Cloning a
+ :type:`memcached_st` will copy the pointer to the clone.
+
+ .. enumerator:: MEMCACHED_CALLBACK_MALLOC_FUNCTION
+
+ .. deprecated:: <0.32
+ Use :type:`memcached_set_memory_allocators` instead.
+
+ .. enumerator:: MEMCACHED_CALLBACK_REALLOC_FUNCTION
+
+ .. deprecated:: <0.32
+ Use :type:`memcached_set_memory_allocators` instead.
+
+ .. enumerator:: MEMCACHED_CALLBACK_FREE_FUNCTION
+
+ .. deprecated:: <0.32
+ Use :type:`memcached_set_memory_allocators` instead.
+
+ .. enumerator:: MEMCACHED_CALLBACK_GET_FAILURE
+
+ This function implements the read through cache behavior. On failure of retrieval this callback will be called.
+
+ You are responsible for populating the result object provided. This result object will then be stored in the server and returned to the calling process.
+
+ You must clone the :type:`memcached_st` in order to
+ make use of it. The value will be stored only if you return
+ `MEMCACHED_SUCCESS` or `MEMCACHED_BUFFERED`. Returning
+ `MEMCACHED_BUFFERED` will cause the object to be buffered and not sent
+ immediately (if this is the default behavior based on your connection setup
+ this will happen automatically).
+
+ The prototype for this is:
+
+ .. type:: memcached_return_t (*memcached_trigger_key)(memcached_st *ptr, char *key, size_t key_length, memcached_result_st *result)
+
+ .. enumerator:: MEMCACHED_CALLBACK_DELETE_TRIGGER
+
+ This function implements a trigger upon successful deletion of a key. The memcached_st structure will need to be cloned in order to make use of it.
+
+ The prototype for this is:
+
+ .. type:: memcached_return_t (*memcached_trigger_delete_key)(memcached_st *ptr, char *key, size_t key_length)
+
+
+DESCRIPTION
+-----------
+
+`libmemcached` can have callbacks set key execution points. These either
+provide function calls at points in the code, or return pointers to
+structures for particular usages.
+
+:func:`memcached_callback_get` takes a callback flag and returns the
+structure or function set by :func:`memcached_callback_set`.
+
+:func:`memcached_callback_set` changes the function/structure assigned by a
+callback flag. No connections are reset.
+
+You can use `MEMCACHED_CALLBACK_USER_DATA` to provide custom context
+if required for any of the callbacks.
+
+
+
+RETURN VALUE
+------------
+
+:func:`memcached_callback_get` return the function or structure that was
+provided. Upon error, nothing is set, null is returned, and the
+:type:`memcached_return_t` argument is set to `MEMCACHED_FAILURE`.
+
+:func:`memcached_callback_set` returns `MEMCACHED_SUCCESS` upon
+successful setting, otherwise `MEMCACHED_FAILURE` on error.
+
+SEE ALSO
+--------
+
+.. only:: man
+
+ :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
--- /dev/null
+====================================================
+Working with data on the server in an atomic fashion
+====================================================
+
+.. index:: object: memcached_st
+
+
+--------
+SYNOPSIS
+--------
+
+
+#include <libmemcached/memcached.h>
+
+.. function:: memcached_return_t memcached_cas(memcached_st *ptr, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags, uint64_t cas)
+
+.. function:: memcached_return_t memcached_cas_by_key(memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags, uint64_t cas)
+
+Compile and link with -lmemcached
+
+
+-----------
+DESCRIPTION
+-----------
+
+:func:`memcached_cas` overwrites data in the server as long as the "cas"
+value is still the same in the server. You can get the cas value of a result
+by calling :func:`memcached_result_cas` on a memcached_result_st(3)
+structure. At the point that this note was written cas is still buggy in memcached.
+Turning on tests for it in libmemcached(3) is optional. Please see
+:func:`memcached_set` for information on how to do this.
+
+:func:`memcached_cas_by_key` method behaves in a similar method as the non
+key methods. The difference is that it uses the group_key parameter
+to map objects to particular servers.
+
+:func:`memcached_cas` is tested with the `MEMCACHED_BEHAVIOR_USE_UDP` behavior enabled. However, when using these operations with this behavior
+on, there are limits to the size of the payload being sent to the server. The
+reason for these limits is that the Memcached Server does not allow
+multi-datagram requests and the current server implementation sets a datagram
+size to 1400 bytes. Due to protocol overhead, the actual limit of the user
+supplied data is less than 1400 bytes and depends on the protocol in use as,
+well as the operation being executed. When running with the binary protocol,
+`MEMCACHED_BEHAVIOR_BINARY_PROTOCOL`, the size of the key,value,
+flags and expiry combined may not exceed 1368 bytes. When running with the
+ASCII protocol, the exact limit fluctuates depending on which function is
+being executed and whether the function is a cas operation or not. For
+non-cas ASCII set operations, there are at least 1335 bytes available to
+split among the key, key_prefix, and value; for cas ASCII operations there
+are at least 1318 bytes available to split among the key, key_prefix and value. If the total size of the command, including overhead, exceeds 1400 bytes, a `MEMCACHED_WRITE_FAILURE` will be returned.
+
+
+------
+RETURN
+------
+
+
+All methods return a value of type :type:`memcached_return_t`.
+On success the value will be `MEMCACHED_SUCCESS`.
+Use :func:`memcached_strerror` to translate this value to a printable
+string.
+
+
+--------
+SEE ALSO
+--------
+
+.. only:: man
+
+ :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` :manpage:`memcached_set(3)` :manpage:`memcached_append(3)` :manpage:`memcached_add(3)` :manpage:`memcached_prepend(3)` :manpage:`memcached_replace(3)`
+
--- /dev/null
+======================================
+Creating and destroying a memcached_st
+======================================
+
+--------
+SYNOPSIS
+--------
+
+#include <libmemcached/memcached.h>
+
+.. type:: memcached_st
+
+.. function:: memcached_st* memcached_create(memcached_st *ptr)
+
+.. function:: void memcached_free(memcached_st *ptr)
+
+.. function:: memcached_st* memcached_clone(memcached_st *destination, memcached_st *source)
+
+.. function:: void memcached_servers_reset(memcached_st)
+
+Compile and link with -lmemcached
+
+
+-----------
+DESCRIPTION
+-----------
+
+:func:`memcached_create` is used to create a :type:`memcached_st`
+structure that will then be used by other libmemcached(3) functions to
+communicate with the server. You should either pass a statically declared
+:type:`memcached_st` to :func:`memcached_create` or
+a NULL. If a NULL passed in then a structure is allocated for you.
+
+Please note, when you write new application use
+:func:`memcached` over :func:`memcached_create`.
+
+:func:`memcached_clone` is similar to :func:`memcached_create` but
+it copies the defaults and list of servers from the source
+:type:`memcached_st`. If you pass a null as the argument for the source
+to clone, it is the same as a call to :func:`memcached_create`.
+If the destination argument is NULL a :type:`memcached_st` will be allocated
+for you.
+
+:func:`memcached_servers_reset` allows you to zero out the list of
+servers that the :type:`memcached_st` has.
+
+To clean up memory associated with a :type:`memcached_st` structure you
+should pass it to :func:`memcached_free` when you are finished using it.
+:func:`memcached_free` is the only way to make sure all memory is
+deallocated when you finish using the structure.
+
+You may wish to avoid using memcached_create(3) or memcached_clone(3) with a
+stack based allocation. The most common issues related to ABI safety involve
+heap allocated structures.
+
+
+------
+RETURN
+------
+
+
+:func:`memcached_create` returns a pointer to the :type:`memcached_st`
+that was created (or initialized). On an allocation failure, it returns NULL.
+
+:func:`memcached_clone` returns a pointer to the :type:`memcached_st`
+that was created (or initialized). On an allocation failure, it returns NULL.
+
+
+--------
+SEE ALSO
+--------
+
+.. only:: man
+
+ :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
--- /dev/null
+===========================
+Deleting data from a server
+===========================
+
+.. index:: object: memcached_st
+
+--------
+SYNOPSIS
+--------
+
+
+#include <libmemcached/memcached.h>
+
+.. function:: memcached_return_t memcached_delete (memcached_st *ptr, const char *key, size_t key_length, time_t expiration)
+
+.. function:: memcached_return_t memcached_delete_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, time_t expiration)
+
+Compile and link with -lmemcached
+
+-----------
+DESCRIPTION
+-----------
+
+
+:func:`memcached_delete` is used to delete a particular key.
+:func:`memcached_delete_by_key` works the same, but it takes a master key
+to find the given value.
+
+Expiration works by placing the item into a delete queue, which means that
+it won't be possible to retrieve it by the "get" command. The "add" and
+"replace" commands with this key will also fail (the "set" command will
+succeed, however). After the time passes, the item is finally deleted from server memory.
+
+Please note the the memcached server removed tests for expiration in
+the 1.4 version.
+
+
+------
+RETURN
+------
+
+
+A value of type :type:`memcached_return_t` is returned
+On success that value will be `MEMCACHED_SUCCESS`.
+Use :func:`memcached_strerror` to translate this value to a printable
+string.
+
+If you are using the non-blocking mode of the library, success only
+means that the message was queued for delivery.
+
+
+
+--------
+SEE ALSO
+--------
+
+.. only:: man
+
+ :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
--- /dev/null
+==========================
+Dumping data from a server
+==========================
+
+
+Get a list of keys found on memcached servers
+
+.. index:: object: memcached_st
+
+
+--------
+SYNOPSIS
+--------
+
+
+#include <libmemcached/memcached.h>
+
+.. function:: memcached_return_t memcached_dump (memcached_st *ptr, memcached_dump_fn *function, void *context, uint32_t number_of_callbacks)
+
+.. type:: memcached_return_t (*memcached_dump_fn)(memcached_st *ptr, const char *key, size_t key_length, void *context)
+
+Compile and link with -lmemcached
+
+
+
+-----------
+DESCRIPTION
+-----------
+
+
+:func:`memcached_dump` is used to get a list of keys found in memcached(1)
+servers. Because memcached(1) does not guarantee to dump all keys you can not
+assume you have fetched all keys from the server. The function takes an array
+of callbacks that it will use to execute on keys as they are found.
+
+Currently the binary protocol is not tested.
+
+
+------
+RETURN
+------
+
+
+A value of type :type:`memcached_return_t` is returned
+On success that value will be `MEMCACHED_SUCCESS`.
+Use :func:`memcached_strerror` to translate this value to a printable
+string.
+
+
+
+--------
+SEE ALSO
+--------
+
+.. only:: man
+
+ :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
#include <libmemcached/memcached.h>
-.. c:function:: memcached_return_t memcached_exist(memcached_st *ptr, char *key, size_t *key_length)
+.. function:: memcached_return_t memcached_exist(memcached_st *ptr, char *key, size_t *key_length)
-.. c:function:: memcached_return_t memcached_exist_by_key(memcached_st *ptr, char *group_key, size_t *group_key_length, char *key, size_t *key_length)
+.. function:: memcached_return_t memcached_exist_by_key(memcached_st *ptr, char *group_key, size_t *group_key_length, char *key, size_t *key_length)
Compile and link with -lmemcached
DESCRIPTION
-----------
-:c:func:`memcached_exist()` can be used to check if a key exists.
+:func:`memcached_exist()` can be used to check if a key exists.
------
RETURN
------
-:c:type:`MEMCACHED_SUCCESS`
+`MEMCACHED_SUCCESS`
The key exists.
-:c:type:`MEMCACHED_NOTFOUND`
+`MEMCACHED_NOTFOUND`
The key was not found.
--------
#include <libmemcached/memcached.h>
-.. c:function:: char *memcached_fetch(memcached_st *ptr, char *key, size_t *key_length, size_t *value_length, uint32_t *flags, memcached_return_t *error)
+.. function:: char *memcached_fetch(memcached_st *ptr, char *key, size_t *key_length, size_t *value_length, uint32_t *flags, memcached_return_t *error)
.. deprecated:: 0.50
- Use :c:func:`memcached_fetch_result` instead.
+ Use :func:`memcached_fetch_result` instead.
Compile and link with -lmemcached
DESCRIPTION
-----------
-:c:func:`memcached_fetch` is used to fetch an individual value from the server. :c:func:`memcached_mget` must always be called before using this method.
+:func:`memcached_fetch` is used to fetch an individual value from the server. :func:`memcached_mget` must always be called before using this method.
You must pass in a key and its length to fetch the object. You must supply
three pointer variables which will give you the state of the returned
-object. A :c:type:`uint32_t` pointer to contain whatever flags you stored with the value, a :c:type:`size_t` pointer which will be filled with size of of the
-object, and a :c:type:`memcached_return_t` pointer to hold any error. The
-object will be returned upon success and NULL will be returned on failure. :c:type:`MEMCACHED_END` is returned by the \*error value when all objects that have been found are returned. The final value upon :c:type:`MEMCACHED_END` is null.
+object. A :type:`uint32_t` pointer to contain whatever flags you stored with the value, a :type:`size_t` pointer which will be filled with size of of the
+object, and a :type:`memcached_return_t` pointer to hold any error. The
+object will be returned upon success and NULL will be returned on failure. `MEMCACHED_END` is returned by the \*error value when all objects that have been found are returned. The final value upon `MEMCACHED_END` is null.
-Values returned by :c:func:`memcached_fetch` must be freed by the caller.
+Values returned by :func:`memcached_fetch` must be freed by the caller.
All of the above functions are not tested when the
-:c:type:`MEMCACHED_BEHAVIOR_USE_UDP` has been set. Executing any of these
-functions with this behavior on will result in :c:type:`MEMCACHED_NOT_SUPPORTED` being returned, or for those functions which do not return a :c:type:`memcached_return_t`, the error function parameter will be set to :c:type:`MEMCACHED_NOT_SUPPORTED`.
+`MEMCACHED_BEHAVIOR_USE_UDP` has been set. Executing any of these
+functions with this behavior on will result in `MEMCACHED_NOT_SUPPORTED` being returned, or for those functions which do not return a :type:`memcached_return_t`, the error function parameter will be set to `MEMCACHED_NOT_SUPPORTED`.
------
RETURN
------
-:c:func:`memcached_fetch` sets error to
-to :c:type:`MEMCACHED_END` upon successful conclusion.
-:c:type:`MEMCACHED_NOTFOUND` will be return if no keys at all were found.
+:func:`memcached_fetch` sets error to
+to `MEMCACHED_END` upon successful conclusion.
+`MEMCACHED_NOTFOUND` will be return if no keys at all were found.
-:c:type:`MEMCACHED_KEY_TOO_BIG` is set to error whenever :c:func:`memcached_fetch` was used
-and the key was set larger then :c:type:`MEMCACHED_MAX_KEY`, which was the largest
+`MEMCACHED_KEY_TOO_BIG` is set to error whenever :func:`memcached_fetch` was used
+and the key was set larger then `MEMCACHED_MAX_KEY`, which was the largest
key allowed for the original memcached ascii server.
--- /dev/null
+=====================================
+Wiping clean the contents of a server
+=====================================
+
+.. index:: object: memcached_st
+
+Wipe contents of memcached servers
+
+
+--------
+SYNOPSIS
+--------
+
+
+#include <libmemcached/memcached.h>
+
+.. function:: memcached_return_t memcached_flush (memcached_st *ptr, time_t expiration)
+
+Compile and link with -lmemcached
+
+
+-----------
+DESCRIPTION
+-----------
+
+
+:func::`memcached_flush` is used to wipe clean the contents of :program:`memcached` servers.
+It will either do this immediately or expire the content based on the
+expiration time passed to the method (a value of zero causes an immediate
+flush). The operation is not atomic to multiple servers, just atomic to a
+single server. That is, it will flush the servers in the order that they were
+added.
+
+
+------
+RETURN
+------
+
+
+A value of type :type:`memcached_return_t` is returned
+On success that value will be `MEMCACHED_SUCCESS`.
+Use :type:`memcached_strerror` to translate this value to a printable string.
+
+
+--------
+SEE ALSO
+--------
+
+.. only:: man
+
+ :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
--- /dev/null
+=======================
+Flushing client buffers
+=======================
+
+
+.. index:: object: memcached_st
+
+Flush and send buffered commands
+
+--------
+SYNOPSIS
+--------
+
+#include <libmemcached/memcached.h>
+
+.. function:: memcached_return_t memcached_flush_buffers (memcached_st *ptr)
+
+Compile and link with -lmemcached
+
+
+-----------
+DESCRIPTION
+-----------
+
+
+:func:`memcached_flush_buffers` is used in conjunction with
+`MEMCACHED_BEHAVIOR_BUFFER_REQUESTS` (see memcached_behavior(3)) to flush all buffers by sending the buffered commands to the server for processing.
+
+
+------
+RETURN
+------
+
+
+A value of type :type:`memcached_return_t` is returned
+On success that value will be `MEMCACHED_SUCCESS`.
+Use :func:`memcached_strerror` to translate this value to a printable
+string.
+
+
+
+
+--------
+SEE ALSO
+--------
+
+.. only:: man
+
+ :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
--- /dev/null
+===============================
+Generating hash values directly
+===============================
+
+.. index:: object: memcached_st
+
+Hash a key value
+
+
+--------
+SYNOPSIS
+--------
+
+
+#include <libmemcached/memcached.h>
+
+.. type:: memcached_hash_t
+
+.. function:: uint32_t memcached_generate_hash_value (const char *key, size_t key_length, memcached_hash_t hash_algorithm)
+
+.. function:: uint32_t memcached_generate_hash (memcached_st *ptr, const char *key, size_t key_length)
+
+.. type:: MEMCACHED_HASH_DEFAULT
+
+.. type:: MEMCACHED_HASH_MD5
+
+.. type:: MEMCACHED_HASH_CRC
+
+.. type:: MEMCACHED_HASH_FNV1_64
+
+.. type:: MEMCACHED_HASH_FNV1A_64
+
+.. type:: MEMCACHED_HASH_FNV1_32
+
+.. type:: MEMCACHED_HASH_FNV1A_32
+
+.. type:: MEMCACHED_HASH_JENKINS
+
+.. type:: MEMCACHED_HASH_MURMUR
+
+.. type:: MEMCACHED_HASH_HSIEH
+
+.. type:: MEMCACHED_HASH_MURMUR3
+
+
+Compile and link with -lmemcachedutil -lmemcached
+
+
+-----------
+DESCRIPTION
+-----------
+
+
+:func:`memcached_generate_hash_value` allows you to hash a key using one of
+the hash functions defined in the library. This method is provided for
+the convenience of higher-level language bindings and is not necessary
+for normal memcache operations.
+
+The allowed hash algorithm constants are listed in the manpage for
+:func:`memcached_behavior_set`.
+
+:func:`memcached_generate_hash` takes a :type:`memcached_st` structure
+and produces the hash value that would have been generated based on the
+defaults of :type:`memcached_st`.
+
+As of version 0.36 all hash methods have been placed into the library
+libhashkit(3) which is linked with libmemcached(3). For more information please see its documentation.
+
+
+------
+RETURN
+------
+
+
+A 32-bit integer which is the result of hashing the given key.
+For 64-bit hash algorithms, only the least-significant 32 bits are
+returned.
+
+
+
+--------
+SEE ALSO
+--------
+
+.. only:: man
+
+ :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
--- /dev/null
+===============================
+Retrieving data from the server
+===============================
+
+.. index:: object: memcached_st
+
+--------
+SYNOPSIS
+--------
+
+
+#include <libmemcached/memcached.h>
+
+.. function:: memcached_result_st * memcached_fetch_result (memcached_st *ptr, memcached_result_st *result, memcached_return_t *error)
+
+.. function:: char * memcached_get (memcached_st *ptr, const char *key, size_t key_length, size_t *value_length, uint32_t *flags, memcached_return_t *error)
+
+.. function:: memcached_return_t memcached_mget (memcached_st *ptr, const char * const *keys, const size_t *key_length, size_t number_of_keys)
+
+.. function:: char * memcached_get_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, size_t *value_length, uint32_t *flags, memcached_return_t *error)
+
+.. function:: memcached_return_t memcached_mget_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char * const *keys, const size_t *key_length, size_t number_of_keys)
+
+.. function:: memcached_return_t memcached_fetch_execute (memcached_st *ptr, memcached_execute_fn *callback, void *context, uint32_t number_of_callbacks)
+
+.. function:: memcached_return_t memcached_mget_execute (memcached_st *ptr, const char * const *keys, const size_t *key_length, size_t number_of_keys, memcached_execute_fn *callback, void *context, uint32_t number_of_callbacks)
+
+.. function:: memcached_return_t memcached_mget_execute_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char * const *keys, const size_t *key_length, size_t number_of_keys, memcached_execute_fn *callback, void *context, uint32_t number_of_callbacks)
+
+.. type:: memcached_return_t (*memcached_execute_fn)(const memcached_st *ptr, memcached_result_st *result, void *context)
+
+Compile and link with -lmemcached
+
+
+-----------
+DESCRIPTION
+-----------
+
+
+:func:`memcached_get` is used to fetch an individual value from the server.
+You must pass in a key and its length to fetch the object. You must supply
+three pointer variables which will give you the state of the returned
+object. A :type:`uint32_t` pointer to contain whatever flags you stored with the value, a :type:`size_t` pointer which will be filled with size of of
+the object, and a :type:`memcached_return_t` pointer to hold any error. The
+object will be returned upon success and NULL will be returned on failure. Any
+object returned by :func:`memcached_get` must be released by the caller
+application.
+
+:func:`memcached_mget` is used to select multiple keys at once. For
+multiple key operations it is always faster to use this function. This function always works asynchronously.
+
+To retrieve data after a successful execution of :func:`memcached_mget`, you will need to
+call :func:`memcached_fetch_result`. You should continue to call this function until
+it returns a NULL (i.e. no more values). If you need to quit in the middle of a
+:func:`memcached_mget` call, you can execute a :func:`memcached_quit`, those this is not required.
+
+:func:`memcached_fetch_result` is used to fetch an individual value from the server. :func:`memcached_mget` must always be called before using this method.
+You must pass in a key and its length to fetch the object. You must supply
+three pointer variables which will give you the state of the returned
+object. A :type:`uint32_t` pointer to contain whatever flags you stored with the value, a :type:`size_t` pointer which will be filled with size of of the
+object, and a :type:`memcached_return_t` pointer to hold any error. The
+object will be returned upon success and NULL will be returned on failure. `MEMCACHED_END` is returned by the \*error value when all objects that have been found are returned. The final value upon `MEMCACHED_END` is null.
+
+:func:`memcached_fetch_result` is used to return a :type:`memcached_result_st` structure from a memcached server. The result object is forward compatible
+with changes to the server. For more information please refer to the
+:type:`memcached_result_st` help. This function will dynamically allocate a
+result structure for you if you do not pass one to the function.
+
+:func:`memcached_fetch_execute` is a callback function for result sets.
+Instead of returning the results to you for processing, it passes each of the
+result sets to the list of functions you provide. It passes to the function
+a :type:`memcached_st` that can be cloned for use in the called
+function (it can not be used directly). It also passes a result set which does
+not need to be freed. Finally it passes a "context". This is just a pointer to
+a memory reference you supply the calling function. Currently only one value
+is being passed to each function call. In the future there will be an option
+to allow this to be an array.
+
+:func:`memcached_mget_execute` and :func:`memcached_mget_execute_by_key`
+is similar to :func:`memcached_mget`, but it may trigger the supplied
+callbacks with result sets while sending out the queries. If you try to
+perform a really large multiget with :func:`memcached_mget` you may
+encounter a deadlock in the OS kernel (it will fail to write data to the
+socket because the input buffer is full). :func:`memcached_mget_execute`
+solves this problem by processing some of the results before continuing
+sending out requests. Please note that this function is only available in
+the binary protocol.
+
+:func:`memcached_get_by_key` and :func:`memcached_mget_by_key` behave
+in a similar nature as :func:`memcached_get` and :func:`memcached_mget`.
+The difference is that they take a master key that is used for determining
+which server an object was stored if key partitioning was used for storage.
+
+All of the above functions are not tested when the
+`MEMCACHED_BEHAVIOR_USE_UDP` has been set. Executing any of these
+functions with this behavior on will result in `MEMCACHED_NOT_SUPPORTED` being returned, or for those functions which do not return a :type:`memcached_return_t`, the error function parameter will be set to `MEMCACHED_NOT_SUPPORTED`.
+
+
+------
+RETURN
+------
+
+
+All objects retrieved via :func:`memcached_get` or :func:`memcached_get_by_key` must be freed with :manpage:`free(3)`.
+
+:func:`memcached_get` will return NULL on
+error. You must look at the value of error to determine what the actual error
+was.
+
+:func:`memcached_fetch_execute` return `MEMCACHED_SUCCESS` if
+all keys were successful. `MEMCACHED_NOTFOUND` will be return if no
+keys at all were found.
+
+:func:`memcached_fetch_result` sets error
+to `MEMCACHED_END` upon successful conclusion.
+`MEMCACHED_NOTFOUND` will be return if no keys at all were found.
+
+
+--------
+SEE ALSO
+--------
+
+.. only:: man
+
+ :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
--- /dev/null
+Retrieving Error Codes and Messages
+===================================
+
+SYNOPSIS
+--------
+
+#include <libmemcached/memcached.h>
+ Compile and link with -lmemcached
+
+.. function:: memcached_return_t memcached_last_error(const memcached_st *)
+
+.. function:: const char *memcached_last_error_message(const memcached_st *)
+
+.. function:: int memcached_last_error_errno(const memcached_st *)
+
+DESCRIPTION
+-----------
+
+Retrieve error codes and messages.
+
+RETURN VALUE
+------------
+
+`memcached_last_error` returns the last error code.
+
+`memcached_last_error_message` returns the last error message. If this error
+came from a specific server, its hostname and port will be provided in the error
+message. Any error message will be returned as 'const char \*' which does not
+need to be de-allocated. NULL will be returned if no error has occurred.
+
+`memcached_last_error_errno` returns any last local error code obtained from
+:manpage:`errno(3)`.
+
+
+SEE ALSO
+--------
+
+.. only:: man
+
+ :manpage:`memcached(1)`
+ :manpage:`libmemcached(3)`
+ :manpage:`memcached_strerror(3)`
+
+.. only:: html
+
+ * :manpage:`memcached(1)`
+ * :doc:`../libmemcached`
+ * :doc:`memcached_strerror`
+++ /dev/null
-=================
-Retrieving errors
-=================
-
-
---------
-SYNOPSIS
---------
-
-
-#include <libmemcached/memcached.h>
-
-.. c:function:: const char *memcached_last_error_message(memcached_st *)
-
-Compile and link with -lmemcached
-
-
------------
-DESCRIPTION
------------
-
-:c:func:`memcached_last_error_message` is used to return the last error
-message that the server responded too. If this error came from a specific
-server, its hostname and port will be provided in the error message.
-
-------
-RETURN
-------
-
-memcached_last_error_message returns a const char* which does not need to be
-de-allocated. If no error has occurred then it will return NULL.
-
-
---------
-SEE ALSO
---------
-
-.. only:: man
-
- :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
-
-
--- /dev/null
+========================================
+Use custom allocators for embedded usage
+========================================
+
+.. index:: object: memcached_st
+
+Manage memory allocator functions
+
+--------
+SYNOPSIS
+--------
+
+
+#include <libmemcached/memcached.h>
+
+.. function:: memcached_return_t memcached_set_memory_allocators (memcached_st *ptr, memcached_malloc_fn mem_malloc, memcached_free_fn mem_free, memcached_realloc_fn mem_realloc, memcached_calloc_fn mem_calloc, void *context)
+
+.. function:: void memcached_get_memory_allocators (memcached_st *ptr, memcached_malloc_fn *mem_malloc, memcached_free_fn *mem_free, memcached_realloc_fn *mem_realloc, memcached_calloc_fn *mem_calloc)
+
+.. function:: void * memcached_get_memory_allocators_context(const memcached_st *ptr)
+
+.. function:: void * (*memcached_malloc_fn) (memcached_st *ptr, const size_t size, void *context)
+
+.. function:: void * (*memcached_realloc_fn) (memcached_st *ptr, void *mem, const size_t size, void *context)
+
+.. function:: void (*memcached_free_fn) (memcached_st *ptr, void *mem, void *context)
+
+.. function:: void * (*memcached_calloc_fn) (memcached_st *ptr, size_t nelem, const size_t elsize, void *context)
+
+Compile and link with -lmemcached
+
+
+
+-----------
+DESCRIPTION
+-----------
+
+
+libmemcached(3) allows you to specify your own memory allocators, optimized
+for your application. This enables libmemcached to be used inside of applications that have their own malloc implementation.
+
+:func:`memcached_set_memory_allocators` is used to set the memory
+allocators used by the memcached instance specified by ptr. Please note that
+you cannot override only one of the memory allocators, you have to specify a
+complete new set if you want to override one of them. All of the memory
+allocation functions should behave as specified in the C99 standard. Specify
+NULL as all functions to reset them to the default values.
+
+:func:`memcached_get_memory_allocators` is used to get the currently used
+memory allocators by a memcached handle.
+
+:func:`memcached_get_memory_allocators_context` returns the void \* that
+was passed in during the call to :func:`memcached_set_memory_allocators`.
+
+The first argument to the memory allocator functions is a pointer to a
+memcached structure, the is passed as const and you will need to clone
+it in order to make use of any operation which would modify it.
+
+
+-----
+NOTES
+-----
+
+
+In version 0.38 all functions were modified to have a context void pointer
+passed to them. This was so that customer allocators could have their
+own space for memory.
+
+
+------
+RETURN
+------
+
+
+:func:`memcached_set_memory_allocators` return `MEMCACHED_SUCCESS`
+upon success, and `MEMCACHED_FAILURE` if you don't pass a complete set
+of function pointers.
+
+
+--------
+SEE ALSO
+--------
+
+.. only:: man
+
+ :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
--- /dev/null
+====================================
+Disconnecting a client from a server
+====================================
+
+.. index:: object: memcached_st
+
+--------
+SYNOPSIS
+--------
+
+#include <libmemcached/memcached.h>
+
+.. function:: void memcached_quit (memcached_st *ptr)
+
+Compile and link with -lmemcached
+
+-----------
+DESCRIPTION
+-----------
+
+
+:func:`memcached_quit` will disconnect you from all currently connected
+servers. It will also reset the state of the connection (ie, any :func:`memcached_fetch` you are in the middle of will be terminated). This function is
+called automatically when you call :func:`memcached_free` on the :type:`memcached_st` structure.
+
+You do not need to call this on your own. All operations to change server
+hashes and parameters will handle connections to the server for you. This
+function is provided mainly so that you can timeout your connections or
+reset connections during the middle of a :func:`memcached_fetch`.
+
+
+------
+RETURN
+------
+
+
+A value of type :type:`memcached_return_t` is returned On success that value
+will be `MEMCACHED_SUCCESS`. Use :func:`memcached_strerror` to
+translate this value to a printable string.
+
+
+--------
+SEE ALSO
+--------
+
+.. only:: man
+
+ :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
--- /dev/null
+========================
+Working with result sets
+========================
+
+--------
+SYNOPSIS
+--------
+
+#include <libmemcached/memcached_pool.h>
+
+.. type:: memcached_result_st
+
+.. function:: memcached_result_st * memcached_result_create (memcached_st *ptr, memcached_result_st *result)
+
+.. function:: void memcached_result_free (memcached_result_st *result)
+
+.. function:: const char * memcached_result_key_value (memcached_result_st *result)
+
+.. function:: size_t memcached_result_key_length (const memcached_result_st *result)
+
+.. function:: const char *memcached_result_value (memcached_result_st *ptr)
+
+.. function:: char *memcached_result_take_value (memcached_result_st *ptr)
+
+.. function:: size_t memcached_result_length (const memcached_result_st *ptr)
+
+.. function:: uint32_t memcached_result_flags (const memcached_result_st *result)
+
+.. function:: uint64_t memcached_result_cas (const memcached_result_st *result)
+
+.. function:: memcached_return_t memcached_result_set_value (memcached_result_st *ptr, const char *value, size_t length)
+
+.. function:: void memcached_result_set_flags (memcached_result_st *ptr, uint32_t flags)
+
+.. function:: void memcached_result_set_expiration (memcached_result_st *ptr, time_t)
+
+Compile and link with -lmemcachedutil -lmemcached
+
+
+
+-----------
+DESCRIPTION
+-----------
+
+
+libmemcached(3) can optionally return a :type:`memcached_result_st` which
+acts as a result object. The result objects have added benefits over the
+character pointer returns, in that they are forward compatible with new
+return items that future memcached servers may implement (the best current
+example of this is the CAS return item). The structures can also be reused,
+which will save on calls to malloc(3). It is suggested that you use result
+objects over char \* return functions.
+
+The structure of :type:`memcached_result_st` has been encapsulated, you should
+not write code to directly access members of the structure.
+
+:func:`memcached_result_create` will either allocate memory for a
+:type:`memcached_result_st` or will initialize a structure passed to it.
+
+:func:`memcached_result_free` will deallocate any memory attached to the
+structure. If the structure was also allocated, it will deallocate it.
+
+:func:`memcached_result_key_value` returns the key value associated with the
+current result object.
+
+:func:`memcached_result_key_length` returns the key length associated with
+the current result object.
+
+:func:`memcached_result_value` returns the result value associated with the
+current result object.
+
+:func:`memcached_result_take_value` returns and hands over the result value
+associated with the current result object. You must call free() to release this
+value, unless you have made use of a custom allocator. Use of a custom
+allocator requires that you create your own custom free() to release it.
+
+:func:`memcached_result_length` returns the result length associated with
+the current result object.
+
+:func:`memcached_result_flags` returns the flags associated with the
+current result object.
+
+:func:`memcached_result_cas` returns the cas associated with the
+current result object. This value will only be available if the server
+tests it.
+
+:func:`memcached_result_set_value` takes a byte array and a size and sets
+the result to this value. This function is used for trigger responses.
+
+:func:`memcached_result_set_flags` takes a result structure and stores a new
+value for the flags field.
+
+:func:`memcached_result_set_expiration` takes a result structure and stores
+a new value for the expiration field (this is only used by read through
+triggers).
+
+You may wish to avoid using memcached_result_create(3) with a
+stack based allocation. The most common issues related to ABI safety involve
+heap allocated structures.
+
+
+------
+RETURN
+------
+
+
+Varies, see particular functions. All structures must have
+:func:`memcached_result_free` called on them for cleanup purposes. Failure
+to do this will result in leaked memory.
+
+
+
+--------
+SEE ALSO
+--------
+
+.. only:: man
+
+ :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
-================================
-Error Codes (memcached_return_t)
+Error Codes - memcached_return_t
================================
---------
SYNOPSIS
--------
#include <libmemcached/memcached.h>
+ Compile and link with -lmemcached
-.. c:type:: memcached_return_t
+.. function:: bool memcached_success(memcached_return_t)
-.. c:function:: bool memcached_success(memcached_return_t)
+.. function:: bool memcached_continue(memcached_return_t rc)
-.. c:function:: bool memcached_continue(memcached_return_t rc)
+.. function:: bool memcached_failed(memcached_return_t)
-.. c:function:: bool memcached_failed(memcached_return_t)
+.. function:: bool memcached_fatal(memcached_return_t)
-.. c:function:: bool memcached_fatal(memcached_return_t)
+.. c:type:: typedef enum memcached_return_t memcached_return_t
+.. enum:: memcached_return_t
-Libmemcached return types:
-++++++++++++++++++++++++++
+ .. enumerator:: MEMCACHED_AUTH_CONTINUE
+ Authentication has been paused.
-:c:type:`MEMCACHED_SUCCESS`
+ .. enumerator:: MEMCACHED_AUTH_FAILURE
-:c:type:`MEMCACHED_FAILURE`
+ The credentials provided are not valid for this server.
-:c:type:`MEMCACHED_HOST_LOOKUP_FAILURE`
+ .. enumerator:: MEMCACHED_AUTH_PROBLEM
-:c:type:`MEMCACHED_CONNECTION_FAILURE`
+ An unknown issue has occurred during authentication.
-:c:type:`MEMCACHED_CONNECTION_BIND_FAILURE`
+ .. enumerator:: MEMCACHED_BAD_KEY_PROVIDED
-:c:type:`MEMCACHED_WRITE_FAILURE`
+ The key provided is not a valid key.
-:c:type:`MEMCACHED_READ_FAILURE`
+ .. enumerator:: MEMCACHED_BUFFERED
-:c:type:`MEMCACHED_UNKNOWN_READ_FAILURE`
+ The request has been buffered.
-:c:type:`MEMCACHED_PROTOCOL_ERROR`
+ .. enumerator:: MEMCACHED_CLIENT_ERROR
-:c:type:`MEMCACHED_CLIENT_ERROR`
+ An unknown client error has occurred internally.
-:c:type:`MEMCACHED_SERVER_ERROR`
+ .. enumerator:: MEMCACHED_CONNECTION_BIND_FAILURE
-:c:type:`MEMCACHED_CONNECTION_SOCKET_CREATE_FAILURE`
+ .. deprecated:: <0.30
-:c:type:`MEMCACHED_DATA_EXISTS`
+ We were not able to bind() to the socket.
-:c:type:`MEMCACHED_DATA_DOES_NOT_EXIST`
+ .. enumerator:: MEMCACHED_CONNECTION_FAILURE
-:c:type:`MEMCACHED_NOTSTORED`
+ A unknown error has occurred while trying to connect to a server.
-:c:type:`MEMCACHED_STORED`
+ .. enumerator:: MEMCACHED_CONNECTION_SOCKET_CREATE_FAILURE
-:c:type:`MEMCACHED_NOTFOUND`
+ .. deprecated:: <0.30
-:c:type:`MEMCACHED_MEMORY_ALLOCATION_FAILURE`
+ An error has occurred while trying to connect to a server. It is likely that either the number of file descriptors need to be increased or you are out of memory.
-:c:type:`MEMCACHED_PARTIAL_READ`
+ .. enumerator:: MEMCACHED_DATA_DOES_NOT_EXIST
-:c:type:`MEMCACHED_SOME_ERRORS`
+ The data requested with the key given was not found.
-:c:type:`MEMCACHED_NO_SERVERS`
+ .. enumerator:: MEMCACHED_DATA_EXISTS
-:c:type:`MEMCACHED_END`
+ The data requested with the key given was not found.
-:c:type:`MEMCACHED_DELETED`
+ .. enumerator:: MEMCACHED_DELETED
-:c:type:`MEMCACHED_VALUE`
+ The object requested by the key has been deleted.
-:c:type:`MEMCACHED_STAT`
+ .. enumerator:: MEMCACHED_DEPRECATED
-:c:type:`MEMCACHED_ITEM`
+ The method that was requested has been deprecated.
-:c:type:`MEMCACHED_ERRNO`
+ .. enumerator:: MEMCACHED_E2BIG
-:c:type:`MEMCACHED_FAIL_UNIX_SOCKET`
+ Item is too large for the server to store.
-:c:type:`MEMCACHED_NOT_SUPPORTED`
+ .. enumerator:: MEMCACHED_END
-:c:type:`MEMCACHED_NO_KEY_PROVIDED`
+ The server has completed returning all of the objects requested.
-:c:type:`MEMCACHED_FETCH_NOTFINISHED`
+ .. enumerator:: MEMCACHED_ERRNO
-:c:type:`MEMCACHED_TIMEOUT`
+ An error has occurred in the driver which has set errno.
-:c:type:`MEMCACHED_BUFFERED`
+ .. enumerator:: MEMCACHED_FAIL_UNIX_SOCKET
-:c:type:`MEMCACHED_BAD_KEY_PROVIDED`
+ A connection was not established with the server via a unix domain socket.
-:c:type:`MEMCACHED_INVALID_HOST_PROTOCOL`
+ .. enumerator:: MEMCACHED_FAILURE
-:c:type:`MEMCACHED_SERVER_MARKED_DEAD`
+ .. deprecated:: <0.30
-:c:type:`MEMCACHED_UNKNOWN_STAT_KEY`
+ A unknown failure has occurred in the server.
-:c:type:`MEMCACHED_E2BIG`
+ .. enumerator:: MEMCACHED_FETCH_NOTFINISHED
-:c:type:`MEMCACHED_INVALID_ARGUMENTS`
+ A request has been made, but the server has not finished the fetch of the last request.
-:c:type:`MEMCACHED_KEY_TOO_BIG`
+ .. enumerator:: MEMCACHED_HOST_LOOKUP_FAILURE
-:c:type:`MEMCACHED_AUTH_PROBLEM`
+ A DNS failure has occurred.
-:c:type:`MEMCACHED_AUTH_FAILURE`
+ .. enumerator:: MEMCACHED_INVALID_ARGUMENTS
-:c:type:`MEMCACHED_AUTH_CONTINUE`
+ The arguments supplied to the given function were not valid.
-:c:type:`MEMCACHED_PARSE_ERROR`
+ .. enumerator:: MEMCACHED_INVALID_HOST_PROTOCOL
-:c:type:`MEMCACHED_PARSE_USER_ERROR`
+ The server you are connecting too has an invalid protocol. Most likely you are connecting to an older server that does not speak the binary protocol.
-:c:type:`MEMCACHED_DEPRECATED`
+ .. enumerator:: MEMCACHED_ITEM
+
+ An item has been fetched (this is an internal error only).
+
+ .. enumerator:: MEMCACHED_KEY_TOO_BIG
+
+ The key that has been provided is too large for the given server.
+
+ .. enumerator:: MEMCACHED_MAXIMUM_RETURN
+
+ This in an internal only state.
+
+ .. enumerator:: MEMCACHED_MEMORY_ALLOCATION_FAILURE
+
+ An error has occurred while trying to allocate memory.
+
+ .. enumerator:: MEMCACHED_NO_KEY_PROVIDED
+
+ .. deprecated:: <0.30
+ Use `MEMCACHED_BAD_KEY_PROVIDED` instead.
+
+ No key was provided.
+
+ .. enumerator:: MEMCACHED_NO_SERVERS
+
+ No servers have been added to the memcached_st object.
+
+ .. enumerator:: MEMCACHED_NOTFOUND
+
+ The object requested was not found.
+
+ .. enumerator:: MEMCACHED_NOTSTORED
+
+ The request to store an object failed.
+
+ .. enumerator:: MEMCACHED_NOT_SUPPORTED
+
+ The given method is not supported in the server.
+
+ .. enumerator:: MEMCACHED_PARSE_ERROR
+
+ An error has occurred while trying to parse the configuration string. You should use memparse to determine what the error was.
+
+ .. enumerator:: MEMCACHED_PARSE_USER_ERROR
+
+ An error has occurred in parsing the configuration string.
+
+ .. enumerator:: MEMCACHED_PARTIAL_READ
+
+ The read was only partially successful.
+
+ .. enumerator:: MEMCACHED_PROTOCOL_ERROR
+
+ An unknown error has occurred in the protocol.
+
+ .. enumerator:: MEMCACHED_READ_FAILURE
+
+ A read failure has occurred.
+
+ .. enumerator:: MEMCACHED_SERVER_ERROR
+
+ An unknown error has occurred in the server.
+
+ .. enumerator:: MEMCACHED_SERVER_MARKED_DEAD
+
+ The requested server has been marked dead.
+
+ .. enumerator:: MEMCACHED_SOME_ERRORS
+
+ A multi request has been made, and some undetermined number of errors have occurred.
+
+ .. enumerator:: MEMCACHED_STAT
+
+ A "stat" command has been returned in the protocol.
+
+ .. enumerator:: MEMCACHED_STORED
+
+ The requested object has been successfully stored on the server.
+
+ .. enumerator:: MEMCACHED_SUCCESS
+
+ The request was successfully executed.
+
+ .. enumerator:: MEMCACHED_TIMEOUT
+
+ Operation has timed out.
+
+ .. enumerator:: MEMCACHED_UNKNOWN_READ_FAILURE
+
+ An unknown read failure only occurs when either there is a bug in the server, or in rare cases where an ethernet nic is reporting dubious information.
+
+ .. enumerator:: MEMCACHED_UNKNOWN_STAT_KEY
+
+ The server you are communicating with has a stat key which has not be defined in the protocol.
+
+ .. enumerator:: MEMCACHED_VALUE
+
+ A value has been returned from the server (this is an internal condition only).
+
+ .. enumerator:: MEMCACHED_WRITE_FAILURE
+
+ An error has occurred while trying to write to a server.
-:c:type:`MEMCACHED_UNIX_SOCKET_PATH_TOO_BIG`
-
---------
SEE ALSO
--------
.. only:: man
- :manpage:`memcached` :manpage:`libmemcached` :manpage:`memcached_str_error`
+ :manpage:`memcached(1)`
+ :manpage:`libmemcached(3)`
+ :manpage:`memcached_strerror(3)`
+
+.. only:: html
+
+ * :manpage:`memcached(1)`
+ * :doc:`../libmemcached`
+ * :doc:`memcached_strerror`
+
--- /dev/null
+============
+SASL support
+============
+
+.. index:: object: memcached_st
+
+
+--------
+SYNOPSIS
+--------
+
+#include <libmemcached/memcached_pool.h>
+
+.. function:: void memcached_set_sasl_callbacks(memcached_st *ptr, const sasl_callback_t *callbacks)
+
+.. function:: const sasl_callback_t *memcached_get_sasl_callbacks(memcached_st *ptr)
+
+.. function:: memcached_return_t memcached_set_sasl_auth_data(memcached_st *ptr, const char *username, const char *password)
+
+.. function:: memcached_return_t memcached_destroy_sasl_auth_data(memcached_st *ptr)
+
+Compile and link with -lmemcached
+
+
+
+-----------
+DESCRIPTION
+-----------
+
+
+libmemcached(3) allows you to plug in your own callbacks function used by
+libsasl to perform SASL authentication.
+
+Please note that SASL requires the memcached binary protocol, and you have
+to specify the callbacks before you connect to the server.
+
+:func:`memcached_set_sasl_auth_data` is a helper function defining
+the basic functionality for you, but it will store the username and password
+in memory. If you choose to use this method you have to call
+:type:`memcached_destroy_sasl_auth_data` before calling
+:type:`memcached_free` to avoid a memory leak. You should NOT call
+:type:`memcached_destroy_sasl_auth_data` if you specify your own callback
+function with :func:`memcached_set_sasl_callbacks`.
+
+
+------
+RETURN
+------
+
+
+:func:`memcached_get_sasl_callbacks` returns the callbacks currently used by
+this memcached handle. :func:`memcached_set_sasl_auth_data` returns
+`MEMCACHED_SUCCESS` upon success.
+
+
+
+--------
+SEE ALSO
+--------
+
+.. only:: man
+
+ :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
--- /dev/null
+Managing lists of servers
+=========================
+
+SYNOPSIS
+--------
+
+#include <libmemcached/memcached.h>
+ Compile and link with -lmemcached
+
+.. c:type:: struct memcached_instance_st memcached_instance_st
+
+.. c:type:: struct memcached_server_list_st memcached_server_list_st
+
+.. c:type:: struct memcached_server_st memcached_server_st
+
+.. function:: const memcached_instance_st * memcached_server_list (memcached_st *ptr)
+
+.. function:: void memcached_server_list_free (memcached_server_list_st list)
+
+.. function:: memcached_server_list_st memcached_server_list_append (memcached_server_list_st list, const char *hostname, in_port_t port, memcached_return_t *error)
+
+.. function:: uint32_t memcached_server_list_count (memcached_server_list_st list)
+
+.. function:: const char *memcached_server_error (const memcached_instance_st * instance)
+
+.. function:: void memcached_server_error_reset (const memcached_instance_st * list)
+
+ .. deprecated:: 0.39
+
+.. function:: void memcached_servers_parse ()
+
+ .. deprecated:: 0.39
+
+DESCRIPTION
+-----------
+
+libmemcached(3) operates on a list of hosts which are stored in
+:type:`memcached_server_st` structures. You should not modify these structures
+directly. Functions are provided to modify these structures (and more can be
+added, just ask!).
+
+:func:`memcached_server_list` is used to provide an array of all defined hosts. This was incorrectly documented as "requiring free" up till version 0.39.
+
+:func:`memcached_server_list_free` deallocates all memory associated with the array of :type:`memcached_server_st` that you passed to it.
+
+:func:`memcached_server_list_append` adds a server to the end of a
+:type:`memcached_server_st` array. On error null will be returned and the
+:type:`memcached_return_t` pointer you passed into the function will be set with the appropriate error. If the value of port is zero, it is set to the default
+port of a memcached server.
+
+DEPRECATED :func:`memcached_servers_parse`, please see :func:`memcached`
+
+:func:`memcached_server_error` can be used to look at the text of the last error message sent by the server to to the client.
+
+Before version 0.39 theses functions used a memcached_server_st \*. In 0.39
+memcached_server_st \* was aliased to :type:`memcached_server_list_st`. This was done for a style reason to help clean up some concepts in the code.
+
+RETURN
+------
+
+Varies, see particular functions.
+
+SEE ALSO
+--------
+
+.. only:: man
+
+ :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
--- /dev/null
+========================================================
+Manipulate the server information stored in memcached_st
+========================================================
+
+--------
+SYNOPSIS
+--------
+
+#include <libmemcached/memcached.h>
+
+.. type:: memcached_server_fn
+
+.. function:: uint32_t memcached_server_count (memcached_st *ptr)
+
+.. function:: memcached_return_t memcached_server_add (memcached_st *ptr, const char *hostname, in_port_t port)
+
+.. function:: memcached_return_t memcached_server_add_udp (memcached_st *ptr, const char *hostname, in_port_t port)
+
+.. function:: memcached_return_t memcached_server_add_unix_socket (memcached_st *ptr, const char *socket)
+
+.. function:: memcached_return_t memcached_server_push (memcached_st *ptr, const memcached_server_st *list)
+
+.. function:: const memcached_instance_st * memcached_server_by_key (memcached_st *ptr, const char *key, size_t key_length, memcached_return_t *error)
+
+.. function:: const memcached_instance_st * memcached_server_get_last_disconnect (const memcached_st *ptr)
+
+.. function:: memcached_return_t memcached_server_cursor(const memcached_st *ptr, const memcached_server_fn *callback, void *context, uint32_t number_of_callbacks)
+
+compile and link with -lmemcached
+
+
+
+-----------
+DESCRIPTION
+-----------
+
+
+`libmemcached` performs operations on a list of hosts. The order of
+these hosts determine routing to keys. Functions are provided to add keys to
+memcached_st structures. To manipulate lists of servers see
+memcached_server_st(3).
+
+:func:`memcached_server_count` provides you a count of the current number of
+servers being used by a :type:`memcached_st` structure.
+
+:func:`memcached_server_add` pushes a single TCP server into the :type:`memcached_st` structure. This server will be placed at the end. Duplicate servers
+ are allowed, so duplication is not checked. Executing this function with the `MEMCACHED_BEHAVIOR_USE_UDP` behavior set will result in a `MEMCACHED_INVALID_HOST_PROTOCOL`.
+
+:func:`memcached_server_add_udp` pushes a single UDP server into the :type:`memcached_st` structure. This server will be placed at the end. Duplicate
+servers are allowed, so duplication is not checked. Executing this function with out setting the `MEMCACHED_BEHAVIOR_USE_UDP` behavior will result in a
+`MEMCACHED_INVALID_HOST_PROTOCOL`.
+
+:func:`memcached_server_add_unix_socket` pushes a single UNIX socket into the :type:`memcached_st` structure. This UNIX socket will be placed at the end.
+Duplicate servers are allowed, so duplication is not checked. The length
+of the filename must be one character less than `MEMCACHED_MAX_HOST_LENGTH`.
+
+:func:`memcached_server_push` pushes an array of :type:`memcached_server_st` into the :type:`memcached_st` structure. These servers will be placed at
+the end. Duplicate servers are allowed, so duplication is not checked. A
+copy is made of structure so the list provided (and any operations on
+the list) are not saved.
+
+:func:`memcached_server_by_key` allows you to provide a key and retrieve the
+server which would be used for assignment.
+
+:func:`memcached_server_get_last_disconnect` returns a pointer to the last
+server for which there was a connection problem. It does not mean this
+particular server is currently dead but if the library is reporting a server
+is, the returned server is a very good candidate.
+
+:func:`memcached_server_cursor` takes a memcached_st and loops through the
+list of hosts currently in the cursor calling the list of callback
+functions provided. You can optionally pass in a value via
+context which will be provided to each callback function. An error
+return from any callback will terminate the loop. :func:`memcached_server_cursor` is passed the original caller :type:`memcached_st` in its current state.
+
+
+------
+RETURN
+------
+
+
+Varies, see particular functions.
+
+
+--------
+SEE ALSO
+--------
+
+.. only:: man
+
+ :manpage:`memcached(1)`
+ :manpage:`libmemcached(3)`
+ :manpage:`memcached_strerror(3)`
--- /dev/null
+Storing data on the server
+==========================
+
+.. index:: object: memcached_st
+
+--------
+SYNOPSIS
+--------
+
+#include <libmemcached/memcached.h>
+ Compile and link with -lmemcached
+
+.. function:: memcached_return_t memcached_set(memcached_st *ptr, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags)
+
+.. function:: memcached_return_t memcached_add(memcached_st *ptr, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags)
+
+.. function:: memcached_return_t memcached_replace(memcached_st *ptr, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags)
+
+.. function:: memcached_return_t memcached_set_by_key(memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags)
+
+.. function:: memcached_return_t memcached_add_by_key(memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags)
+
+.. function:: memcached_return_t memcached_replace_by_key(memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags)
+
+-----------
+DESCRIPTION
+-----------
+
+:func:`memcached_set`, :func:`memcached_add`, and :func:`memcached_replace` are all used to store information on the server. All methods take a key, and its length to store the object. Keys are currently limited to 250 characters when using either a version of memcached(1) which is 1.4 or below, or when using the text protocol. You must supply both a value and a length. Optionally you
+store the object. Keys are currently limited to 250 characters by the
+memcached(1) server. You must supply both a value and a length. Optionally you
+may test an expiration time for the object and a 16 byte value (it is meant to be used as a bitmap). "flags" is a 4byte space that is stored alongside of the main value. Many sub libraries make use of this field, so in most cases users should avoid making use of it.
+
+:func:`memcached_set` will write an object to the server. If an object
+already exists it will overwrite what is in the server. If the object does not
+exist it will be written. If you are using the non-blocking mode this function
+will always return true unless a network error occurs.
+
+:func:`memcached_replace` replaces an object on the server. If the object is not found on the server an error occurs.
+
+:func:`memcached_add` adds an object to the server. If the object is found on the server an error occurs, otherwise the value is stored.
+
+:func:`memcached_set_by_key`, :func:`memcached_add_by_key`, and :func:`memcached_replace_by_key` methods all behave in a similar method as the non
+key methods. The difference is that they use their group_key parameter to map
+objects to particular servers.
+
+If you are looking for performance, :func:`memcached_set` with non-blocking IO is the fastest way to store data on the server.
+
+All of the above functions are tested with the `MEMCACHED_BEHAVIOR_USE_UDP` behavior enabled. However, when using these operations with this behavior
+on, there are limits to the size of the payload being sent to the server.
+The reason for these limits is that the Memcached Server does not allow
+multi-datagram requests and the current server implementation sets a datagram
+size to 1400 bytes. Due to protocol overhead, the actual limit of the user supplied data is less than 1400 bytes and depends on the protocol in use as, well as the operation being
+executed. When running with the binary protocol, `MEMCACHED_BEHAVIOR_BINARY_PROTOCOL`, the size of the key,value, flags and expiry combined may not
+exceed 1368 bytes. When running with the ASCII protocol, the exact limit fluctuates depending on which function is being executed and whether the function is a cas operation or not. For non-cas ASCII set operations, there are at least
+1335 bytes available to split among the key, key_prefix, and value; for cas
+ASCII operations there are at least 1318 bytes available to split among the key, key_prefix and value. If the total size of the command, including overhead,
+exceeds 1400 bytes, a `MEMCACHED_WRITE_FAILURE` will be returned.
+
+RETURN VALUE
+------------
+
+All methods return a value of type `memcached_return_t`.
+On success the value will be `MEMCACHED_SUCCESS`.
+Use :func:`memcached_strerror` to translate this value to a printable string.
+
+For :func:`memcached_replace` and :func:`memcached_add`, `MEMCACHED_NOTSTORED`
+is a legitimate error in the case of a collision.
+
+SEE ALSO
+--------
+
+.. only:: man
+
+ :manpage:`memcached(1)`
+ :manpage:`libmemcached(3)`
+ :manpage:`memcached_strerror(3)`
+ :manpage:`memcached_prepend(3)`
+ :manpage:`memcached_append(3)`
+ :manpage:`memcached_cas(3)`
+
--- /dev/null
+==================
+Set encryption key
+==================
+
+.. index:: object: memcached_st
+
+--------
+SYNOPSIS
+--------
+
+#include <libmemcached/memcached.h>
+
+.. function:: void memcached_set_encoding_key (memcached_st *ptr, const char *string, const size_t string_length)
+
+Compile and link with -lmemcached
+
+-----------
+DESCRIPTION
+-----------
+
+
+:func:`memcached_set_encoding_key` sets the key that will be used to encrypt and decrypt data as it is sent and received from the server.
+
+Currently only AES is is supported.
+
+
+------
+RETURN
+------
+
+
+A value of type :type:`memcached_return_t` is returned On success that value
+will be `MEMCACHED_SUCCESS`. Use :func:`memcached_strerror` to
+translate this value to a printable string.
+
+
+
+--------
+SEE ALSO
+--------
+
+.. only:: man
+
+ :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
--- /dev/null
+==================================================
+Working with statistical information from a server
+==================================================
+
+
+Get memcached statistics
+
+.. index:: object: memcached_st
+
+
+--------
+SYNOPSIS
+--------
+
+#include <libmemcached/memcached.h>
+
+.. type:: memcached_stat_st
+
+.. type:: memcached_return_t (*memcached_stat_fn)(const memcached_instance_st * server, const char *key, size_t key_length, const char *value, size_t value_length, void *context)
+
+.. function:: memcached_stat_st *memcached_stat (memcached_st *ptr, char *args, memcached_return_t *error)
+
+.. function:: memcached_return_t memcached_stat_servername (memcached_stat_st *stat, char *args, const char *hostname, in_port_t port)
+
+.. function:: char * memcached_stat_get_value (memcached_st *ptr, memcached_stat_st *stat, const char *key, memcached_return_t *error)
+
+.. function:: char ** memcached_stat_get_keys (memcached_st *ptr, memcached_stat_st *stat, memcached_return_t *error)
+
+.. function:: memcached_return_t memcached_stat_execute (memcached_st *memc, const char *args, memcached_stat_fn func, void *context)
+
+Compile and link with -lmemcached
+
+-----------
+DESCRIPTION
+-----------
+
+
+libmemcached(3) has the ability to query a memcached server (or collection
+of servers) for their current state. Queries to find state return a
+:type:`memcached_stat_st` structure. You are responsible for freeing this structure. While it is possible to access the structure directly it is not advisable. :func:`memcached_stat_get_value` has been provided to query the structure.
+
+:func:`memcached_stat_execute` uses the servers found in :type:`memcached_stat_st` and executes a "stat" command on each server. args is an optional argument that can be passed in to modify the behavior of "stats". You will need to supply a callback function that will be supplied each pair of values returned by
+the memcached server.
+
+:func:`memcached_stat` fetches an array of :type:`memcached_stat_st` structures containing the state of all available memcached servers. The return value must be freed by the calling application. If called with the `MEMCACHED_BEHAVIOR_USE_UDP` behavior set, a NULL value is returned and the error parameter is set to `MEMCACHED_NOT_SUPPORTED`.
+
+:func:`memcached_stat_servername` can be used standalone without a :type:`memcached_st` to obtain the state of a particular server. "args" is used to define a particular state object (a list of these are not provided for by either
+the :func:`memcached_stat_get_keys` call nor are they defined in the memcached protocol). You must specify the hostname and port of the server you want to
+obtain information on.
+
+:func:`memcached_stat_get_value` returns the value of a particular state key. You specify the key you wish to obtain. The key must be null terminated.
+
+:func:`memcached_stat_get_keys` returns a list of keys that the server has state objects on. You are responsible for freeing this list.
+
+A command line tool, memstat(1), is provided so that you do not have to write
+an application to do this.
+
+
+------
+RETURN
+------
+
+
+Varies, see particular functions.
+
+Any method returning a :type:`memcached_stat_st` expects you to free the
+memory allocated for it.
+
+
+
+--------
+SEE ALSO
+--------
+
+.. only:: man
+
+ :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
+
--- /dev/null
+Converting Error Codes to Messages
+==================================
+
+SYNOPSIS
+--------
+
+#include <libmemcached/memcached.h>
+ Compile and link with -lmemcached
+
+.. function:: const char *memcached_strerror(memcached_st *ptr, memcached_return_t rc)
+
+DESCRIPTION
+-----------
+
+`memcached_strerror` takes a `memcached_return_t` value and returns a string
+describing the error.
+
+This string must not be modified by the application.
+
+`memcached_return_t` values are returned from nearly all libmemcached(3)
+functions.
+
+`memcached_return_t` values are of an enum type so that you can set up responses
+with switch/case and know that you are capturing all possible return values.
+
+RETURN
+------
+
+`memcached_strerror` returns a string describing a `memcached_return_t` value.
+
+SEE ALSO
+--------
+
+.. only:: man
+
+ :manpage:`memcached(1)`
+ :manpage:`libmemcached(3)`
+
+.. only:: html
+
+ * :manpage:`memcached(1)`
+ * :doc:`../libmemcached`
+
--- /dev/null
+===========================================
+memcached_touch, memcached_touch_by_key
+===========================================
+
+.. index:: object: memcached_st
+
+--------
+SYNOPSIS
+--------
+
+
+#include <libmemcached/memcached.h>
+
+.. function:: memcached_return_t memcached_touch (memcached_st *ptr, const char *key, size_t key_length, time_t expiration)
+
+.. function:: memcached_return_t memcached_touch_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, time_t expiration)
+
+Compile and link with -lmemcached
+
+-----------
+DESCRIPTION
+-----------
+
+
+:func:`memcached_touch` is used to update the expiration time on an existing key.
+:func:`memcached_touch_by_key` works the same, but it takes a master key
+to find the given value.
+
+
+------
+RETURN
+------
+
+
+A value of type :type:`memcached_return_t` is returned
+On success that value will be `MEMCACHED_SUCCESS`.
+Use :func:`memcached_strerror` to translate this value to a printable
+string.
+
+
+
+--------
+SEE ALSO
+--------
+
+.. only:: man
+
+ :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
+
--- /dev/null
+==============================================
+Storing custom user information in the client.
+==============================================
+
+.. index:: object: memcached_st
+
+Manage user specific data
+
+
+-------
+LIBRARY
+-------
+
+
+C Client Library for memcached (libmemcached, -lmemcached)
+
+
+--------
+SYNOPSIS
+--------
+
+
+#include <libmemcached/memcached.h>
+
+.. function:: void *memcached_get_user_data (memcached_st *ptr)
+
+.. function:: void *memcached_set_user_data (memcached_st *ptr, void *data)
+
+Compile and link with -lmemcached
+
+
+
+-----------
+DESCRIPTION
+-----------
+
+
+libmemcached(3) allows you to store a pointer to a user specific data inside
+the memcached_st structure.
+
+:func:`memcached_set_user_data` is used to set the user specific data in the
+:type:`memcached_st` structure.
+
+:func:`memcached_get_user_data` is used to retrieve the user specific data in the :type:`memcached_st` structure.
+
+
+------
+RETURN
+------
+
+
+:func:`memcached_set_user_data` returns the previous value of the user specific data.
+
+:func:`memcached_get_user_data` returns the current value uf the user specific data.
+
+
+
+--------
+SEE ALSO
+--------
+
+.. only:: man
+
+ :manpage:`memcached(1)` :manpage:`libmemcached(3)`
+
--- /dev/null
+=================================
+Setting the verbosity of a server
+=================================
+
+.. index:: object: memcached_st
+
+Modify verbosity of servers
+
+--------
+SYNOPSIS
+--------
+
+#include <libmemcached/memcached.h>
+
+.. function:: memcached_return_t memcached_verbosity (memcached_st *ptr, uint32_t verbosity)
+
+Compile and link with -lmemcached
+
+
+-----------
+DESCRIPTION
+-----------
+
+
+:func:`memcached_verbosity` modifies the "verbosity" of the
+memcached(1) servers referenced in the :type:`memcached_st` parameter.
+
+
+------
+RETURN
+------
+
+
+A value of type :type:`memcached_return_t` is returned.
+
+On success that value will be `MEMCACHED_SUCCESS`.
+
+Use :func:`memcached_strerror` to translate this value to a printable string.
+
+
+--------
+SEE ALSO
+--------
+
+.. only:: man
+
+ :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
+
--- /dev/null
+=======================================================
+Getting version information about the client and server
+=======================================================
+
+
+--------
+SYNOPSIS
+--------
+
+#include <libmemcached/memcached.h>
+
+.. function:: const char * memcached_lib_version (void)
+
+.. function:: memcached_return_t memcached_version (memcached_st *ptr)
+
+
+Compile and link with -lmemcached
+
+
+
+-----------
+DESCRIPTION
+-----------
+
+
+:func:`memcached_lib_version` is used to return a simple version string representing the libmemcached version (client library version, not server version)
+
+:func:`memcached_version` is used to set the major, minor, and micro versions of each memcached server being used by the memcached_st connection structure. It returns the memcached server return code.
+
+
+------
+RETURN
+------
+
+
+:func:`memcached_lib_version` returns a string with the version of the libmemcached driver.
+
+A value of :type:`memcached_return_t` is returned from :func:'memcached_version'
+
+On success that value will be `MEMCACHED_SUCCESS`.
+
+If called with the `MEMCACHED_BEHAVIOR_USE_UDP` behavior set, the value
+`MEMCACHED_NOT_SUPPORTED` will be returned.
+
+Use :func:`memcached_strerror` to translate this value to
+a printable string.
+
+
+
+--------
+SEE ALSO
+--------
+
+.. only:: man
+
+ :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
+
--- /dev/null
+libmemcached Versioning
+=======================
+
+Libmemcached is laid out by interface version. The 1.0 version would be found
+in: ``libmemcached-1.0/memcached.h``
+
+The historic ``libmemcached/memcached.h`` includes
+``libmemcached-1.0/memcached.h``. For best practice you should include the
+version of libmemcached that you used during development.
+
+++ /dev/null
-========================
-Configuring Libmemcached
-========================
-
-.. highlightlang:: c
-
---------
-SYNOPSIS
---------
-
-#include <libmemcached-1.0/memcached.h>
- Compile and link with -lmemcached
-
-.. c:function:: memcached_st *memcached(const char *string, size_t string_length)
-
-.. c:function:: memcached_return_t libmemcached_check_configuration(const char *option_string, size_t length, char *error_buffer, size_t error_buffer_size)
-
-
------------
-DESCRIPTION
------------
-
-Libmemcached implements a custom language for configuring and modifying
-servers. By passing in an option string you can generate a ``memcached_st`` object
-that you can use in your application directly.
-
-General Options:
-****************
-
-.. option:: --SERVER=<servername>:<optional_port>/?<optional_weight>
-
-Provide a servername to be used by the client.
-
-Providing a weight will cause weighting to occur with all hosts with each server getting a default weight of 1.
-
-.. option:: --SOCKET=\"<filepath>/?<optional_weight>\"
-
-Provide a filepath to a UNIX socket file. Providing a weight will cause weighting to occur with all hosts with each server getting a default weight of 1.
-
-.. option:: --VERIFY-KEY
-
-Verify that keys that are being used fit within the design of the protocol being used.
-
-.. option:: --REMOVE_FAILED_SERVERS
-
-Enable the behavior :c:type:`MEMCACHED_BEHAVIOR_REMOVE_FAILED_SERVERS`.
-
-.. option:: --BINARY-PROTOCOL
-
-Force all connections to use the binary protocol.
-
-.. option:: --BUFFER-REQUESTS
-
-Please see :c:type:`MEMCACHED_BEHAVIOR_BUFFER_REQUESTS`.
-
-.. option:: --CONFIGURE-FILE=
-
-Provide a configuration file to be used to load requests. Beware that by using a configuration file libmemcached will reset memcached_st based on information only contained in the file.
-
-.. option:: --CONNECT-TIMEOUT=
-
-Please see :c:type:`MEMCACHED_BEHAVIOR_CONNECT_TIMEOUT`.
-
-.. option:: --DISTRIBUTION=
-
-Set the distribution model used by the client. See :c:func:`memcached_behavior_set` for more details.
-
-.. option:: --HASH=
-
-Set the hashing algorithm used for placing keys on servers.
-
-.. option:: --HASH-WITH-NAMESPACE
-
-When enabled the prefix key will be added to the key when determining which
-server to store the data in.
-
-.. option:: --NOREPLY
-
-Enable "no reply" for all calls that support this. It is highly recommended
-that you use this option with the binary protocol only.
-
-.. option:: --NUMBER-OF-REPLICAS=
-
-Set the number of servers that keys will be replicated to.
-
-.. option:: --RANDOMIZE-REPLICA-READ
-
-Select randomly the server within the replication pool to read from.
-
-.. option:: --SORT-HOSTS
-
-When adding new servers always calculate their distribution based on sorted naming order.
-
-.. option:: --SUPPORT-CAS
-
-See :manpage:`memcached_behavior_set(3)` for :c:type:`MEMCACHED_BEHAVIOR_SUPPORT_CAS`
-
-.. option:: --USE-UDP
-
-See :manpage:`memcached_behavior_set(3)` for :c:type:`MEMCACHED_BEHAVIOR_USE_UDP`
-
-.. option:: --NAMESPACE=
-
-A namespace is a container that provides context for keys, only other
-requests that know the namespace can access these values. This is
-accomplished by prepending the namespace value to all keys.
-
-
-***********************
-Memcached Pool Options:
-***********************
-
-.. option:: --POOL-MIN
-
-Initial size of pool.
-
-.. option:: --POOL-MAX
-
-Maximize size of the pool.
-
-************
-I/O Options:
-************
-
-.. option:: --TCP-NODELAY
-
-See :manpage:`memcached_behavior_set(3)` for MEMCACHED_BEHAVIOR_TCP_NODELAY
-
-.. option:: --TCP-KEEPALIVE
-
-See :manpage:`memcached_behavior_set(3)` for MEMCACHED_BEHAVIOR_TCP_KEEPALIVE
-
-.. option:: --RETRY-TIMEOUT=
-
-See :manpage:`memcached_behavior_set(3)` for MEMCACHED_BEHAVIOR_RETRY_TIMEOUT
-
-.. option:: --SERVER-FAILURE-LIMIT=
-
-See :manpage:`memcached_behavior_set(3)` for MEMCACHED_BEHAVIOR_SERVER_FAILURE_LIMIT
-
-.. option:: --SND-TIMEOUT=
-
-See :manpage:`memcached_behavior_set(3)` for MEMCACHED_BEHAVIOR_SND_TIMEOUT
-
-.. option:: --SOCKET-RECV-SIZE=
-
-See :manpage:`memcached_behavior_set(3)` for MEMCACHED_BEHAVIOR_SOCKET_RECV_SIZE
-
-.. option:: --SOCKET-SEND-SIZE=
-
-See :manpage:`memcached_behavior_set(3)` for MEMCACHED_BEHAVIOR_SOCKET_SEND_SIZE
-
-.. option:: --POLL-TIMEOUT=
-
-That sets the value of the timeout used by :manpage: `poll()`.
-
-.. option:: --IO-BYTES-WATERMARK=
-
-.. option:: --IO-KEY-PREFETCH=
-
-.. option:: --IO-MSG-WATERMARK=
-
-.. option:: --TCP-KEEPIDLE
-
-.. option:: --RCV-TIMEOUT=
-
-
-
-Other Options:
-**************
-
-
-.. option:: INCLUDE
-
-Include a file in configuration. Unlike --CONFIGURE-FILE= this will not reset memcached_st
-
-.. option:: RESET
-
-Reset memcached_st and continue to process.
-
-.. option:: END
-
-End configuration processing.
-
-.. option:: ERROR
-
-End configuration processing and throw an error.
-
-
------------
-ENVIRONMENT
------------
-
-.. envvar:: LIBMEMCACHED
-
-
-------
-RETURN
-------
-
-
-:c:func:`memcached()` returns a pointer to the memcached_st that was
-created (or initialized). On an allocation failure, it returns NULL.
-
-
-
--------
-EXAMPLE
--------
-
-
-.. code-block:: c
-
- const char *config_string=
- "--SERVER=host10.example.com "
- "--SERVER=host11.example.com "
- "--SERVER=host10.example.com";
- memcached_st *memc= memcached(config_string, strlen(config_string));
- {
- // ...
- }
- memcached_free(memc);
-
-
-
---------
-SEE ALSO
---------
-
-.. only:: man
-
- :manpage:`memcached(1)`
- :manpage:`libmemcached(3)`
- :manpage:`memcached_strerror(3)`
-
-.. only:: html
-
- * :manpage:`memcached(1)`
- * :doc:`libmemcached`
- * :doc:`memcached_strerror`
+++ /dev/null
-========
-Examples
-========
-
-Examples for libmemcached
-
------------
-DESCRIPTION
------------
-
-
-For full examples, test cases are found in tests/\*.c in the main
-distribution. These are always up to date, and are used for each test run of
-the library.
-
-
----------------------
-Connecting to servers
----------------------
-
-
-.. code-block:: c
-
- const char *config_string= "--SERVER=host10.example.com --SERVER=host11.example.com --SERVER=host10.example.com"
- memcached_st *memc= memcached(config_string, strlen(config_string);
- {
- ...
- }
- memcached_free(memc);
-
-
-In the above code you create a :c:type:`memcached_st` object with three server
-by making use of :c:func:`memcached_create`.
-
-
---------------------------
-Creating a pool of servers
---------------------------
-
-
-.. code-block:: c
-
- const char *config_string= "--SERVER=host10.example.com --SERVER=host11.example.com --SERVER=host10.example.com";
-
- memcached_pool_st* pool= memcached_pool(config_string, strlen(config_string));
-
- memcached_return_t rc;
-
- memcached_st *memc= memcached_pool_pop(pool, false, &rc);
-
- .... do work
-
- /*
- Release the memc_ptr that was pulled from the pool
- */
- memcached_pool_push(pool, memc);
-
- /*
- Destroy the pool.
- */
- memcached_pool_destroy(pool);
-
-
-
-In the above code you create a :c:type:`memcached_pool_st` object with three
-server by making use of :c:func:`memcached_pool()`.
-
-When :c:func:`memcached_pool_destroy()` all memory will be released that is associated
-with the pool.
-
-
-----------------------------
-Adding a value to the server
-----------------------------
-
-
-
-.. code-block:: c
-
- char *key= "foo";
- char *value= "value";
-
- memcached_return_t rc= memcached_set(memc, key, strlen(key), value, value_length, (time_t)0, (uint32_t)0);
-
- if (rc != MEMCACHED_SUCCESS)
- {
- ... // handle failure
- }
-
-
-It is best practice to always look at the return value of any operation.
-
-
-------------------------
-Fetching multiple values
-------------------------
-
-
-
-.. code-block:: c
-
- memcached_return_t rc;
- char *keys[]= {"fudge", "son", "food"};
- size_t key_length[]= {5, 3, 4};
- unsigned int x;
- uint32_t flags;
-
- char return_key[MEMCACHED_MAX_KEY];
- size_t return_key_length;
- char *return_value;
- size_t return_value_length;
-
- rc= memcached_mget(memc, keys, key_length, 3);
-
- x= 0;
- while ((return_value= memcached_fetch(memc, return_key, &return_key_length,
- &return_value_length, &flags, &rc)))
- {
- free(return_value);
- x++;
- }
-
-
-Notice that you freed values returned from memcached_fetch(). The define
-:c:type:`MEMCACHED_MAX_KEY` is provided for usage.
-
-
-
---------
-SEE ALSO
---------
-
-:manpage:`memcached(1)`
-
-============================
-Introducing libmemcachedutil
-============================
+libmemcachedutil - C/C++ utilities extending libmemcached
+=========================================================
Utility library for libmemcached
-
---------
SYNOPSIS
--------
-#include <libmemcached/memcached_util.h>
+#include <libmemcachedutil-|libmemcached_version|/util.h>
Compile and link with -lmemcachedutil
-
------------
DESCRIPTION
-----------
-
`libmemcachedutil` is a small and thread-safe client library that
provides extra functionality built on top of `libmemcached`.
-
--------
THREADS
-------
-Do not try to access an instance of :c:type:`memcached_st` from multiple threads
+Do not try to access an instance of :type:`memcached_st` from multiple threads
at the same time. If you want to access memcached from multiple threads
-you should either clone the :c:type:`memcached_st`, or use the memcached pool
-implementation. See :c:func:`memcached_pool_create`.
+you should either clone the :type:`memcached_st`, or use the memcached pool
+implementation. See :func:`memcached_pool_create`.
---------
SEE ALSO
--------
.. only:: html
- * :doc:`libmemcached`
- * :doc:`memcached_pool`
+ * :doc:`../libmemcached`
+ * :doc:`libmemcachedutil/memcached_pool`
--- /dev/null
+libmemcachedutil API
+====================
+
+.. toctree::
+ :titlesonly:
+ :caption: Additional Utilities
+
+ memcached_pool
--- /dev/null
+============================
+Working with memcached pools
+============================
+
+--------
+SYNOPSIS
+--------
+
+#include <libmemcached/memcached_pool.h>
+ Compile and link with -lmemcachedutil -lmemcached
+
+.. type:: struct memcached_pool_st memcached_pool_st
+
+.. function:: memcached_pool_st* memcached_pool(const char *option_string, size_t option_string_length)
+
+.. function:: memcached_st* memcached_pool_destroy(memcached_pool_st* pool)
+
+.. function:: memcached_st* memcached_pool_fetch(memcached_pool_st*, struct timespec* relative_time, memcached_return_t* rc)
+.. versionadded:: 0.53
+ Synonym for memcached_pool_pop
+
+.. function:: memcached_return_t memcached_pool_release(memcached_pool_st* pool, memcached_st* mmc)
+.. versionadded:: 0.53
+ Synonym for memcached_pool_push.
+
+.. function:: memcached_return_t memcached_pool_behavior_set(memcached_pool_st *pool, memcached_behavior_t flag, uint64_t data)
+
+.. function:: memcached_return_t memcached_pool_behavior_get(memcached_pool_st *pool, memcached_behavior_t flag, uint64_t *value)
+
+
+.. function:: memcached_pool_st* memcached_pool_create(memcached_st* mmc, int initial, int max)
+.. deprecated:: 0.46
+ Use :func:`memcached_pool`
+
+.. function:: memcached_st* memcached_pool_pop(memcached_pool_st* pool, bool block, memcached_return_t *rc)
+.. deprecated:: 0.53
+ Use :func:`memcached_pool_fetch`
+
+.. function:: memcached_return_t memcached_pool_push(memcached_pool_st* pool, memcached_st *mmc)
+.. deprecated:: 0.53
+ Use :func:`memcached_pool_release`
+
+
+-----------
+DESCRIPTION
+-----------
+
+
+:func:`memcached_pool` is used to create a connection pool of objects you
+may use to remove the overhead of using memcached_clone for short lived
+:type:`memcached_st` objects. Please see :doc:`../libmemcached/configuration`
+for details on the format of the configuration string.
+
+:func:`memcached_pool_destroy` is used to destroy the connection pool
+created with :func:`memcached_pool_create` and release all allocated
+resources. It will return the pointer to the :type:`memcached_st` structure
+passed as an argument to :func:`memcached_pool_create`, and returns the
+ownership of the pointer to the caller when created with
+:func:`memcached_pool_create`, otherwise NULL is returned..
+
+:func:`memcached_pool_fetch` is used to fetch a connection structure from the
+connection pool. The relative_time argument specifies if the function should
+block and wait for a connection structure to be available if we try
+to exceed the maximum size. You need to specify time in relative time.
+
+:func:`memcached_pool_release` is used to return a connection structure back
+to the pool.
+
+:func:`memcached_pool_behavior_get` and :func:`memcached_pool_behavior_set`
+is used to get/set behavior flags on all connections in the pool.
+
+Both :func:`memcached_pool_release` and :func:`memcached_pool_fetch` are
+thread safe.
+
+------
+RETURN
+------
+
+:func:`memcached_pool_destroy` returns the pointer (and ownership) to the
+:type:`memcached_st` structure used to create the pool. If connections are in
+use it returns NULL.
+
+:func:`memcached_pool_pop` returns a pointer to a :type:`memcached_st`
+structure from the pool (or NULL if an allocation cannot be satisfied).
+
+:func:`memcached_pool_release` returns `MEMCACHED_SUCCESS` upon success.
+
+:func:`memcached_pool_behavior_get` and :func:`memcached_pool_behavior_get`
+returns `MEMCACHED_SUCCESS` upon success.
+
+If any methods returns MEMCACHED_IN_PROGRESS then a lock on the pool could not
+be obtained. If any of the parameters passed to any of these functions is
+invalid, MEMCACHED_INVALID_ARGUMENTS will be returned.
+
+memcached_pool_fetch may return MEMCACHED_TIMEOUT if a timeout occurs while
+waiting for a free memcached_st. MEMCACHED_NOTFOUND if no memcached_st was
+available.
+
+
+
+--------
+SEE ALSO
+--------
+
+.. only:: man
+
+ :manpage:`memcached(1)`
+ :manpage:`libmemcached(3)`
+ :manpage:`libmemcached_configuration(3)`
+ :manpage:`memcached_strerror(3)`
+
+.. only:: html
+
+ * :manpage:`memcached(1)`
+ * :doc:`../libmemcached`
+ * :doc:`../libmemcached/configuration`
+ * :doc:`../libmemcached/memcached_strerror`
+++ /dev/null
-=================
-Analyzing servers
-=================
-
-
-Analyze server information
-
-
---------
-SYNOPSIS
---------
-
-.. index:: object: memcached_analysis_st
-
-
-#include <libmemcached/memcached.h>
-
-.. c:type:: memcached_analysis_st
-
-.. c:function:: memcached_analysis_st * memcached_analyze (memcached_st *ptr, memcached_stat_st *stat, memcached_return_t *error)
-
-Compile and link with -lmemcached
-
------------
-DESCRIPTION
------------
-
-
-:program:`libmemcached` has the ability to query a memcached server (or
-collection of servers) for their current state. Queries to find state return a
-:c:type:`memcached_analysis_st` structure. You are responsible for freeing this structure.
-
-:c:func:`memcached_analyze` analyzes useful information based on the
-provided servers and sets the result to the :c:type:`memcached_analysis_st`
-structure. The return value must be freed by the calling application.
-
-A command line tool, :program:`memstat` with the option :option:`memstat --analyze`,
-is provided so that you do not have to write an application to use this method.
-
-
-------
-RETURN
-------
-
-
-A pointer to the allocated :c:type:`memcached_analysis_st` structure on
-success and a NULL pointer on failure. You may inspect the error detail by
-checking the :c:type:`memcached_return_t` value.
-
-Any method returning a :c:type:`memcached_analysis_st` expects you to free the
-memory allocated for it.
-
-
-
---------
-SEE ALSO
---------
-
-.. only:: man
-
- :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
-
+++ /dev/null
-=============================================
-Appending or Prepending to data on the server
-=============================================
-
-.. index:: object: memcached_st
-
-Appending or Prepending to data on the server
-
-
---------
-SYNOPSIS
---------
-
-
-#include <libmemcached/memcached.h>
-
-.. c:function:: memcached_return_t memcached_prepend(memcached_st *ptr, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags)
-
-.. c:function:: memcached_return_t memcached_append(memcached_st *ptr, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags)
-
-.. c:function:: memcached_return_t memcached_prepend_by_key(memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags)
-
-.. c:function:: memcached_return_t memcached_append_by_key(memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags)
-
-Compile and link with -lmemcached
-
-
------------
-DESCRIPTION
------------
-
-
-:c:func:`memcached_prepend` and memcached_append are used to
-modify information on a server. All methods take a key, and its length to
-store the object. Keys are currently limited to 250 characters when using
-either a version of memcached which is 1.4 or below, or when using the text
-protocol. You must supply both a value and a length. Optionally you
-may test an expiration time for the object and a 16 byte value (it is
-meant to be used as a bitmap). "flags" is a 4byte space that is stored
-alongside of the main value. Many sub libraries make use of this field,
-so in most cases users should avoid making use of it.
-
-:c:func:`memcached_prepend` places a segment of data before the last piece
-of data stored. Currently expiration and key are not used in the server.
-
-:c:func:`memcached_append` places a segment of data at the end of the last
-piece of data stored. Currently expiration and key are not used in the server.
-
-:c:func:`memcached_prepend_by_key` and
-:c:func:`memcached_append_by_key` methods both behave in a similar
-method as the non key methods. The difference is that they use their
-group_key parameter to map objects to particular servers.
-
-If you are looking for performance, :c:func:`memcached_set` with non-blocking
-IO is the fastest way to store data on the server.
-
-All of the above functions are tested with the
-:c:type:`MEMCACHED_BEHAVIOR_USE_UDP` behavior enabled. However, when using
-these operations with this behavior on, there are limits to the size of the
-payload being sent to the server. The reason for these limits is that the
-Memcached Server does not allow multi-datagram requests
-and the current server implementation sets a datagram size to 1400 bytes. Due
-to protocol overhead, the actual limit of the user supplied data is less than
-1400 bytes and depends on the protocol in use as, well as the operation being
-executed. When running with the binary protocol,
-:c:type:`MEMCACHED_BEHAVIOR_BINARY_PROTOCOL`, the size of the key,value,
-flags and expiry combined may not exceed 1368 bytes. When running with the
-ASCII protocol, the exact limit fluctuates depending on which function is
-being executed and whether the function is a cas operation or not. For
-non-cas ASCII set operations, there are at least 1335 bytes available
-to split among the key, key_prefix, and value; for cas ASCII operations
-there are at least 1318 bytes available to split among the key, key_prefix
-and value. If the total size of the command, including overhead, exceeds
-1400 bytes, a :c:type:`MEMCACHED_WRITE_FAILURE` will be returned.
-
-
-------
-RETURN
-------
-
-
-All methods return a value of type :c:type:`memcached_return_t`.
-On success the value will be :c:type:`MEMCACHED_SUCCESS`.
-Use :c:func:`memcached_strerror` to translate this value to a printable
-string.
-
-
---------
-SEE ALSO
---------
-
-.. only:: man
-
- :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` :manpage:`memcached_set(3)` :manpage:`memcached_add(3)` :manpage:`memcached_cas(3)` :manpage:`memcached_replace(3)`
-
+++ /dev/null
-====================================
-Incrementing and Decrementing Values
-====================================
-
-.. index:: object: memcached_st
-
---------
-SYNOPSIS
---------
-
-#include <libmemcached/memcached.h>
-
-.. c:function:: memcached_return_t memcached_increment (memcached_st *ptr, const char *key, size_t key_length, uint32_t offset, uint64_t *value)
-
-.. c:function:: memcached_return_t memcached_decrement (memcached_st *ptr, const char *key, size_t key_length, uint32_t offset, uint64_t *value)
-
-.. c:function:: memcached_return_t memcached_increment_with_initial (memcached_st *ptr, const char *key, size_t key_length, uint64_t offset, uint64_t initial, time_t expiration, uint64_t *value)
-
-.. c:function:: memcached_return_t memcached_decrement_with_initial (memcached_st *ptr, const char *key, size_t key_length, uint64_t offset, uint64_t initial, time_t expiration, uint64_t *value)
-
-.. c:function:: memcached_return_t memcached_increment_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, uint32_t offset, uint64_t *value)
-
-.. c:function:: memcached_return_t memcached_decrement_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, uint32_t offset, uint64_t *value)
-
-.. c:function:: memcached_return_t memcached_increment_with_initial_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, uint64_t offset, uint64_t initial, time_t expiration, uint64_t *value)
-
-.. c:function:: memcached_return_t memcached_decrement_with_initial_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, uint64_t offset, uint64_t initial, time_t expiration, uint64_t *value)
-
-Compile and link with -lmemcached
-
-
------------
-DESCRIPTION
------------
-
-
-:manpage:`memcached(1)` servers have the ability to increment and decrement keys
-(overflow and underflow are not detected). This gives you the ability to use
-memcached to generate shared sequences of values.
-
-memcached_increment takes a key and key length and increments the value by
-the offset passed to it. The value is then returned via the uint32_t
-value pointer you pass to it.
-
-memcached_decrement takes a key and keylength and decrements the value by
-the offset passed to it. The value is then returned via the uint32_t
-value pointer you pass to it.
-
-memcached_increment_with_initial takes a key and keylength and increments
-the value by the offset passed to it. If the object specified by key does
-not exist, one of two things may happen: If the expiration value is
-MEMCACHED_EXPIRATION_NOT_ADD, the operation will fail. For all other
-expiration values, the operation will succeed by seeding the value for that
-key with a initial value to expire with the provided expiration time. The
-flags will be set to zero.The value is then returned via the uint32_t
-value pointer you pass to it. memcached_increment_with_initial is only available
-when using the binary protocol.
-
-memcached_decrement_with_initial takes a key and keylength and decrements
-the value by the offset passed to it. If the object specified by key does
-not exist, one of two things may happen: If the expiration value is
-MEMCACHED_EXPIRATION_NOT_ADD, the operation will fail. For all other
-expiration values, the operation will succeed by seeding the value for that
-key with a initial value to expire with the provided expiration time. The
-flags will be set to zero.The value is then returned via the uint32_t
-value pointer you pass to it. memcached_decrement_with_initial is only available
-when using the binary protocol.
-
-:c:func:`memcached_increment_by_key`, :c:func:`memcached_decrement_by_key`,
-:c:func:`memcached_increment_with_initial_by_key`, and
-:c:func:`memcached_decrement_with_initial_by_key` are master key equivalents of the above.
-
-
-------
-RETURN
-------
-
-
-A value of type :c:type:`memcached_return_t` is returned.
-On success that value will be :c:type:`MEMCACHED_SUCCESS`.
-Use memcached_strerror to translate this value to a printable string.
-
-
---------
-SEE ALSO
---------
-
-.. only:: man
-
- :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
+++ /dev/null
-================================
-Modifying how the driver behaves
-================================
-
-
-Manipulate the behavior of a memcached_st structure.
-
-.. index:: object: memcached_st
-
-
---------
-SYNOPSIS
---------
-
-
-#include <libmemcached/memcached.h>
-
-.. c:type:: memcached_behavior_t
-
-.. c:function:: uint64_t memcached_behavior_get (memcached_st *ptr, memcached_behavior_t flag)
-
-.. c:function:: memcached_return_t memcached_behavior_set (memcached_st *ptr, memcached_behavior_t flag, uint64_t data)
-
-Compile and link with -lmemcached
-
-
------------
-DESCRIPTION
------------
-
-:manpage:`libmemcached(3)` behavior can be modified by using
-:c:func:`memcached_behavior_set`. Default behavior is the library strives to be quick and
-accurate. Some behavior, while being faster, can also result in not entirely
-accurate behavior (for instance, :c:func:`memcached_set` will always respond
-with :c:type:`MEMCACHED_SUCCESS`).
-
-:c:func:`memcached_behavior_get` takes a behavior flag and returns whether or not that behavior is currently enabled in the client.
-
-:c:func:`memcached_behavior_set` changes the value of a particular option
-of the client. It takes both a flag (listed below) and a value. For simple
-on or off options you just need to pass in a value of 1. Calls to
-:c:func:`memcached_behavior_set` will flush and reset all connections.
-
-
-.. c:type:: MEMCACHED_BEHAVIOR_USE_UDP
-
-Causes :manpage:`libmemcached(3)` to use the UDP transport when communicating
-with a memcached server. Not all I/O operations are tested
-when this behavior is enabled.
-
-The following operations will return
-:c:type:`MEMCACHED_NOT_SUPPORTED` when executed with the
-:c:type:`MEMCACHED_BEHAVIOR_USE_UDP` enabled:
- * :c:func:`memcached_version`,
- * :c:func:`memcached_stat`,
- * :c:func:`memcached_get`,
- * :c:func:`memcached_get_by_key`,
- * :c:func:`memcached_mget`,
- * :c:func:`memcached_mget_by_key`,
- * :c:func:`memcached_fetch`,
- * :c:func:`memcached_fetch_result`,
- * :c:func:`memcached_fetch_execute`.
-
-All other operations are tested but are executed in a 'fire-and-forget'
-mode, in which once the client has executed the operation, no attempt
-will be made to ensure the operation has been received and acted on by the
-server.
-
-:manpage:`libmemcached(3)` does not allow TCP and UDP servers to be shared
-within the same libmemcached(3) client 'instance'. An attempt to add a TCP
-server when this behavior is enabled will result in a
-:c:type:`MEMCACHED_INVALID_HOST_PROTOCOL`, as will attempting to add a UDP
-server when this behavior has not been enabled.
-
-
-
-.. c:type:: MEMCACHED_BEHAVIOR_NO_BLOCK
-
-Causes :manpage:`libmemcached(3)` to use asynchronous IO. This is the fastest
-transport available for storage functions.
-
-
-.. c:type:: MEMCACHED_BEHAVIOR_SND_TIMEOUT
-
-This sets the microsecond behavior of the socket against the SO_SNDTIMEO flag.
-
-In cases where you cannot use non-blocking IO this will allow you to still have timeouts on the sending of data.
-
-
-.. c:type:: MEMCACHED_BEHAVIOR_RCV_TIMEOUT
-
-This sets the microsecond behavior of the socket against the SO_RCVTIMEO flag.
-
-In cases where you cannot use non-blocking IO this will allow you to still have timeouts on the reading of data.
-
-
-
-.. c:type:: MEMCACHED_BEHAVIOR_TCP_NODELAY
-
-Turns on the no-delay feature for connecting sockets (may be faster in some
-environments).
-
-
-
-.. c:type:: MEMCACHED_BEHAVIOR_HASH
-
-Makes the default hashing algorithm for keys use MD5.
-The value can be set to either:
- * :c:type:`MEMCACHED_HASH_DEFAULT`,
- * :c:type:`MEMCACHED_HASH_MD5`,
- * :c:type:`MEMCACHED_HASH_CRC`,
- * :c:type:`MEMCACHED_HASH_FNV1_64`,
- * :c:type:`MEMCACHED_HASH_FNV1A_64`,
- * :c:type:`MEMCACHED_HASH_FNV1_32`,
- * :c:type:`MEMCACHED_HASH_FNV1A_32`,
- * :c:type:`MEMCACHED_HASH_JENKINS`,
- * :c:type:`MEMCACHED_HASH_HSIEH`, and
- * :c:type:`MEMCACHED_HASH_MURMUR`.
-
-Each hash has its advantages and its weaknesses. If you don't know or don't
-care, just go with the default.
-
-Support for :c:type:`MEMCACHED_HASH_HSIEH` is a compile time option that is
-disabled by default. To enable tests for this hashing algorithm, configure and
-build libmemcached with the Hsieh hash enabled.
-
-
-
-.. c:type:: MEMCACHED_BEHAVIOR_DISTRIBUTION
-
-Using this you can enable different means of distributing values to servers.
-
-The default method is :c:type:`MEMCACHED_DISTRIBUTION_MODULA`.
-
-You can enable consistent hashing by setting :c:type:`MEMCACHED_DISTRIBUTION_CONSISTENT`.
-Consistent hashing delivers better distribution and allows servers to be added
-to the cluster with minimal cache losses.
-
-Currently :c:type:`MEMCACHED_DISTRIBUTION_CONSISTENT` is an alias for the value
-c:type:`MEMCACHED_DISTRIBUTION_CONSISTENT_KETAMA`.
-
-.. c:type:: MEMCACHED_BEHAVIOR_CACHE_LOOKUPS
-.. deprecated:: 0.46(?)
- DNS lookups are now always cached until an error occurs with the server.
-
- Memcached can cache named lookups so that DNS lookups are made only once.
-
-.. c:type:: MEMCACHED_BEHAVIOR_SUPPORT_CAS
-
-Support CAS operations (this is not enabled by default at this point in the server since it imposes a slight performance penalty).
-
-
-.. c:type:: MEMCACHED_BEHAVIOR_KETAMA
-
-Sets the default distribution to MEMCACHED_DISTRIBUTION_CONSISTENT_KETAMA and
-the hash to :c:type:`MEMCACHED_HASH_MD5`.
-
-
-.. c:type:: MEMCACHED_BEHAVIOR_KETAMA_WEIGHTED
-
- Sets the default distribution to MEMCACHED_DISTRIBUTION_CONSISTENT_KETAMA with the weighted tests. and the hash to MEMCACHED_HASH_MD5.
-
-.. c:type:: MEMCACHED_BEHAVIOR_KETAMA_HASH
-
-Sets the hashing algorithm for host mapping on continuum. The value can be set
-to either :c:type:`MEMCACHED_HASH_DEFAULT`, :c:type:`MEMCACHED_HASH_MD5`,
-:c:type:`MEMCACHED_HASH_CRC`, :c:type:`MEMCACHED_HASH_FNV1_64`,
-:c:type:`MEMCACHED_HASH_FNV1A_64`, :c:type:`MEMCACHED_HASH_FNV1_32`, and
-:c:type:`MEMCACHED_HASH_FNV1A_32`.
-
-.. c:type:: MEMCACHED_BEHAVIOR_KETAMA_COMPAT
-
-Sets the compatibility mode. The value can be set to either MEMCACHED_KETAMA_COMPAT_LIBMEMCACHED (this is the default) or MEMCACHED_KETAMA_COMPAT_SPY to be compatible with the SPY Memcached client for Java.
-
-.. c:type:: MEMCACHED_BEHAVIOR_POLL_TIMEOUT
-
-Modify the timeout in milliseconds value that is used by poll. The default value is -1. An signed int must be passed to memcached_behavior_set to change this value (this requires casting). For memcached_behavior_get a signed int value will be cast and returned as the unsigned long long.
-
-.. c:type:: MEMCACHED_BEHAVIOR_USER_DATA
-.. deprecated:: < 0.30
-
-.. c:type:: MEMCACHED_BEHAVIOR_BUFFER_REQUESTS
-
-Enabling buffered IO causes commands to "buffer" instead of being sent. Any action that gets data causes this buffer to be be sent to the remote connection. Quiting the connection or closing down the connection will also cause the buffered data to be pushed to the remote connection.
-
-
-.. c:type:: MEMCACHED_BEHAVIOR_VERIFY_KEY
-
-Enabling this will cause :manpage:`libmemcached(3)` to test all keys to verify that they are valid keys.
-
-
-
-.. c:type:: MEMCACHED_BEHAVIOR_SORT_HOSTS
-
-Enabling this will cause hosts that are added to be placed in the host list in sorted order. This will defeat consistent hashing.
-
-
-.. c:type:: MEMCACHED_BEHAVIOR_CONNECT_TIMEOUT
-
-In non-blocking mode this changes the value of the timeout during socket connection in milliseconds. Specifying -1 means an infinite time‐out.
-
-
-.. c:type:: MEMCACHED_BEHAVIOR_BINARY_PROTOCOL
-
-Enable the use of the binary protocol. Please note that you cannot toggle this flag on an open connection.
-
-
-
-.. c:type:: MEMCACHED_BEHAVIOR_SERVER_FAILURE_LIMIT
-
-Set this value to enable the server be removed after continuous MEMCACHED_BEHAVIOR_SERVER_FAILURE_LIMIT times connection failure.
-
-
-
-.. c:type:: MEMCACHED_BEHAVIOR_IO_MSG_WATERMARK
-
-Set this value to tune the number of messages that may be sent before libmemcached should start to automatically drain the input queue. Setting this value to high, may cause libmemcached to deadlock (trying to send data, but the send will block because the input buffer in the kernel is full).
-
-
-
-.. c:type:: MEMCACHED_BEHAVIOR_IO_BYTES_WATERMARK
-
-Set this value to tune the number of bytes that may be sent before libmemcached should start to automatically drain the input queue (need at least 10 IO requests sent without reading the input buffer). Setting this value to high, may cause libmemcached to deadlock (trying to send data, but the send will block because the input buffer in the kernel is full).
-
-
-
-.. c:type:: MEMCACHED_BEHAVIOR_IO_KEY_PREFETCH
-
-The binary protocol works a bit different than the textual protocol in that a multiget is implemented as a pipe of single get-operations which are sent to the server in a chunk. If you are using large multigets from your application, you may improve the latency of the gets by setting this value so you send out the first chunk of requests when you hit the specified limit. It allows the servers to start processing the requests to send the data back while the rest of the requests are created and sent to the server.
-
-
-
-.. c:type:: MEMCACHED_BEHAVIOR_NOREPLY
-
-Set this value to specify that you really don't care about the result from your storage commands (set, add, replace, append, prepend).
-
-
-
-.. c:type:: MEMCACHED_BEHAVIOR_NUMBER_OF_REPLICAS
-
-If you just want "a poor mans HA", you may specify the numbers of replicas libmemcached should store of each item (on different servers). This replication does not dedicate certain memcached servers to store the replicas in, but instead it will store the replicas together with all of the other objects (on the 'n' next servers specified in your server list).
-
-
-
-.. c:type:: MEMCACHED_BEHAVIOR_RANDOMIZE_REPLICA_READ
-
-Allows randomizing the replica reads starting point. Normally the read is done from primary server and in case of miss the read is done from primary + 1, then primary + 2 all the way to 'n' replicas. If this option is set on the starting point of the replica reads is randomized between the servers. This allows distributing read load to multiple servers with the expense of more write traffic.
-
-
-
-.. c:type:: MEMCACHED_BEHAVIOR_CORK
-
-This open has been deprecated with the behavior now built and used appropriately on selected platforms.
-
-
-.. c:type:: MEMCACHED_BEHAVIOR_KEEPALIVE
-
-Enable TCP_KEEPALIVE behavior.
-
-
-
-.. c:type:: MEMCACHED_BEHAVIOR_KEEPALIVE_IDLE
-
-Specify time, in seconds, to mark a connection as idle. This is only available as an option Linux.
-
-
-.. c:type:: MEMCACHED_BEHAVIOR_SOCKET_SEND_SIZE
-
-Find the current size of SO_SNDBUF. A value of 0 means either an error occurred or no hosts were available. It is safe to assume system default if this occurs. If an error occurs you can checked the last cached errno statement to find the specific error.
-
-
-.. c:type:: MEMCACHED_BEHAVIOR_SOCKET_RECV_SIZE
-
-Find the current size of SO_RCVBUF. A value of 0 means either an error occurred or no hosts were available. It is safe to assume system default if this occurs. If an error occurs you can checked the last cached errno statement to find the specific error.
-
-
-.. c:type:: MEMCACHED_BEHAVIOR_SERVER_FAILURE_LIMIT
-.. deprecated:: 0.48
- See :c:type:`MEMCACHED_BEHAVIOR_REMOVE_FAILED_SERVERS`
-
- This number of times a host can have an error before it is disabled.
-
-
-.. c:type:: MEMCACHED_BEHAVIOR_AUTO_EJECT_HOSTS
-.. deprecated:: 0.48
- See :c:type:`MEMCACHED_BEHAVIOR_REMOVE_FAILED_SERVERS`
-
- If enabled any hosts which have been flagged as disabled will be removed from the list of servers in the memcached_st structure. This must be used in combination with MEMCACHED_BEHAVIOR_SERVER_FAILURE_LIMIT.
-
-.. c:type:: MEMCACHED_BEHAVIOR_REMOVE_FAILED_SERVERS
-
- If enabled any hosts which have been flagged as disabled will be removed from the list of servers in the memcached_st structure.
-
-.. c:type:: MEMCACHED_BEHAVIOR_RETRY_TIMEOUT
-
-When enabled a host which is problematic will only be checked for usage based on the amount of time set by this behavior. The value is in seconds.
-
-
-.. c:type:: MEMCACHED_BEHAVIOR_HASH_WITH_PREFIX_KEY
-
-When enabled the prefix key will be added to the key when determining server
-by hash. See :c:type:`MEMCACHED_CALLBACK_NAMESPACE` for additional
-information.
-
-
-
-
-------
-RETURN
-------
-
-
-memcached_behavior_get returns either the current value of the get, or 0
-or 1 on simple flag behaviors (1 being enabled). memcached_behavior_set
-returns failure or success.
-
-
------
-NOTES
------
-
-
-memcached_behavior_set in version .17 was changed from taking a pointer
-to data value, to taking a uin64_t.
-
-
-
---------
-SEE ALSO
---------
-
-.. only:: man
-
- :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
+++ /dev/null
-=================
-Setting callbacks
-=================
-
-
-Get and set a callback
-
-.. index:: object: memcached_st
-
-
---------
-SYNOPSIS
---------
-
-#include <libmemcached/memcached.h>
-
-.. c:type:: memcached_callback_t
-
-.. c:function:: memcached_return_t memcached_callback_set (memcached_st *ptr, memcached_callback_t flag, const void *data)
-
-.. c:function:: void * memcached_callback_get (memcached_st *ptr, memcached_callback_t flag, memcached_return_t *error)
-
-Compile and link with -lmemcached
-
-
------------
-DESCRIPTION
------------
-
-
-libmemcached(3) can have callbacks set key execution points. These either
-provide function calls at points in the code, or return pointers to
-structures for particular usages.
-
-:c:func:`memcached_callback_get` takes a callback flag and returns the
-structure or function set by :c:func:`memcached_callback_set`.
-
-:c:func:`memcached_callback_set` changes the function/structure assigned by a
-callback flag. No connections are reset.
-
-You can use :c:type:`MEMCACHED_CALLBACK_USER_DATA` to provide custom context
-if required for any of the callbacks.
-
-
-.. c:type:: MEMCACHED_CALLBACK_CLEANUP_FUNCTION
-
-When :c:func:`memcached_delete` is called this function will be executed. At
-the point of its execution all connections are closed.
-
-
-
-.. c:type:: MEMCACHED_CALLBACK_CLONE_FUNCTION
-
-When :c:func:`memcached_delete` is called this function will be executed.
-At the point of its execution all connections are closed.
-
-.. c:type:: MEMCACHED_CALLBACK_PREFIX_KEY
-
- See :c:type:`MEMCACHED_CALLBACK_NAMESPACE`
-
-.. c:type:: MEMCACHED_CALLBACK_NAMESPACE
-
-You can set a value which will be used to create a domain for your keys.
-The value specified here will be prefixed to each of your keys. The value can
-not be greater then :c:macro:`MEMCACHED_PREFIX_KEY_MAX_SIZE` - 1 and will
-reduce :c:macro:`MEMCACHED_MAX_KEY` by the value of your key.
-
-The prefix key is only applied to the primary key, not the master key.
-:c:type:`MEMCACHED_FAILURE` will be returned if no key is set. In the case of
-a key which is too long, :c:type:`MEMCACHED_BAD_KEY_PROVIDED` will be returned.
-
-If you set a value with the value being NULL then the prefix key is disabled.
-
-.. c:type:: MEMCACHED_CALLBACK_USER_DATA
-
-This allows you to store a pointer to a specific piece of data. This can be
-retrieved from inside of :c:func:`memcached_fetch_execute`. Cloning a
-:c:type:`memcached_st` will copy the pointer to the clone.
-
-.. c:type:: MEMCACHED_CALLBACK_MALLOC_FUNCTION
-.. deprecated:: <0.32
- Use :c:type:`memcached_set_memory_allocators` instead.
-
-.. c:type:: MEMCACHED_CALLBACK_REALLOC_FUNCTION
-.. deprecated:: <0.32
- Use :c:type:`memcached_set_memory_allocators` instead.
-
-.. c:type:: MEMCACHED_CALLBACK_FREE_FUNCTION
-.. deprecated:: <0.32
- Use :c:type:`memcached_set_memory_allocators` instead.
-
-.. c:type:: MEMCACHED_CALLBACK_GET_FAILURE
-
-This function implements the read through cache behavior. On failure of retrieval this callback will be called.
-
-You are responsible for populating the result object provided. This result object will then be stored in the server and returned to the calling process.
-
-You must clone the :c:type:`memcached_st` in order to
-make use of it. The value will be stored only if you return
-:c:type:`MEMCACHED_SUCCESS` or :c:type:`MEMCACHED_BUFFERED`. Returning
-:c:type:`MEMCACHED_BUFFERED` will cause the object to be buffered and not sent
-immediately (if this is the default behavior based on your connection setup
-this will happen automatically).
-
-The prototype for this is:
-
-.. c:function:: memcached_return_t (\*memcached_trigger_key)(memcached_st \*ptr, char \*key, size_t key_length, memcached_result_st \*result);
-
-
-
-.. c:type:: MEMCACHED_CALLBACK_DELETE_TRIGGER
-
-This function implements a trigger upon successful deletion of a key. The memcached_st structure will need to be cloned in order to make use of it.
-
-The prototype for this is:
-
-.. c:function:: typedef memcached_return_t (\*memcached_trigger_delete_key)(memcached_st \*ptr, char \*key, size_t key_length);
-
-
-
-
-------
-RETURN
-------
-
-
-:c:func:`memcached_callback_get` return the function or structure that was
-provided. Upon error, nothing is set, null is returned, and the
-:c:type:`memcached_return_t` argument is set to :c:type:`MEMCACHED_FAILURE`.
-
-:c:func:`memcached_callback_set` returns :c:type:`MEMCACHED_SUCCESS` upon
-successful setting, otherwise :c:type:`MEMCACHED_FAILURE` on error.
-
-
-
---------
-SEE ALSO
---------
-
-.. only:: man
-
- :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
+++ /dev/null
-====================================================
-Working with data on the server in an atomic fashion
-====================================================
-
-.. index:: object: memcached_st
-
-
---------
-SYNOPSIS
---------
-
-
-#include <libmemcached/memcached.h>
-
-.. c:function:: memcached_return_t memcached_cas(memcached_st *ptr, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags, uint64_t cas)
-
-.. c:function:: memcached_return_t memcached_cas_by_key(memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags, uint64_t cas)
-
-Compile and link with -lmemcached
-
-
------------
-DESCRIPTION
------------
-
-:c:func:`memcached_cas` overwrites data in the server as long as the "cas"
-value is still the same in the server. You can get the cas value of a result
-by calling :c:func:`memcached_result_cas` on a memcached_result_st(3)
-structure. At the point that this note was written cas is still buggy in memcached.
-Turning on tests for it in libmemcached(3) is optional. Please see
-:c:func:`memcached_set` for information on how to do this.
-
-:c:func:`memcached_cas_by_key` method behaves in a similar method as the non
-key methods. The difference is that it uses the group_key parameter
-to map objects to particular servers.
-
-:c:func:`memcached_cas` is tested with the :c:type:`MEMCACHED_BEHAVIOR_USE_UDP` behavior enabled. However, when using these operations with this behavior
-on, there are limits to the size of the payload being sent to the server. The
-reason for these limits is that the Memcached Server does not allow
-multi-datagram requests and the current server implementation sets a datagram
-size to 1400 bytes. Due to protocol overhead, the actual limit of the user
-supplied data is less than 1400 bytes and depends on the protocol in use as,
-well as the operation being executed. When running with the binary protocol,
-:c:type:`MEMCACHED_BEHAVIOR_BINARY_PROTOCOL`, the size of the key,value,
-flags and expiry combined may not exceed 1368 bytes. When running with the
-ASCII protocol, the exact limit fluctuates depending on which function is
-being executed and whether the function is a cas operation or not. For
-non-cas ASCII set operations, there are at least 1335 bytes available to
-split among the key, key_prefix, and value; for cas ASCII operations there
-are at least 1318 bytes available to split among the key, key_prefix and value. If the total size of the command, including overhead, exceeds 1400 bytes, a :c:type:`MEMCACHED_WRITE_FAILURE` will be returned.
-
-
-------
-RETURN
-------
-
-
-All methods return a value of type :c:type:`memcached_return_t`.
-On success the value will be :c:type:`MEMCACHED_SUCCESS`.
-Use :c:func:`memcached_strerror` to translate this value to a printable
-string.
-
-
---------
-SEE ALSO
---------
-
-.. only:: man
-
- :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` :manpage:`memcached_set(3)` :manpage:`memcached_append(3)` :manpage:`memcached_add(3)` :manpage:`memcached_prepend(3)` :manpage:`memcached_replace(3)`
-
+++ /dev/null
-======================================
-Creating and destroying a memcached_st
-======================================
-
---------
-SYNOPSIS
---------
-
-#include <libmemcached/memcached.h>
-
-.. c:type:: memcached_st
-
-.. c:function:: memcached_st* memcached_create(memcached_st *ptr)
-
-.. c:function:: void memcached_free(memcached_st *ptr)
-
-.. c:function:: memcached_st* memcached_clone(memcached_st *destination, memcached_st *source)
-
-.. c:function:: void memcached_servers_reset(memcached_st)
-
-Compile and link with -lmemcached
-
-
------------
-DESCRIPTION
------------
-
-:c:func:`memcached_create` is used to create a :c:type:`memcached_st`
-structure that will then be used by other libmemcached(3) functions to
-communicate with the server. You should either pass a statically declared
-:c:type:`memcached_st` to :c:func:`memcached_create` or
-a NULL. If a NULL passed in then a structure is allocated for you.
-
-Please note, when you write new application use
-:c:func:`memcached` over :c:func:`memcached_create`.
-
-:c:func:`memcached_clone` is similar to :c:func:`memcached_create` but
-it copies the defaults and list of servers from the source
-:c:type:`memcached_st`. If you pass a null as the argument for the source
-to clone, it is the same as a call to :c:func:`memcached_create`.
-If the destination argument is NULL a :c:type:`memcached_st` will be allocated
-for you.
-
-:c:func:`memcached_servers_reset` allows you to zero out the list of
-servers that the :c:type:`memcached_st` has.
-
-To clean up memory associated with a :c:type:`memcached_st` structure you
-should pass it to :c:func:`memcached_free` when you are finished using it.
-:c:func:`memcached_free` is the only way to make sure all memory is
-deallocated when you finish using the structure.
-
-You may wish to avoid using memcached_create(3) or memcached_clone(3) with a
-stack based allocation. The most common issues related to ABI safety involve
-heap allocated structures.
-
-
-------
-RETURN
-------
-
-
-:c:func:`memcached_create` returns a pointer to the :c:type:`memcached_st`
-that was created (or initialized). On an allocation failure, it returns NULL.
-
-:c:func:`memcached_clone` returns a pointer to the :c:type:`memcached_st`
-that was created (or initialized). On an allocation failure, it returns NULL.
-
-
---------
-SEE ALSO
---------
-
-.. only:: man
-
- :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
+++ /dev/null
-===========================
-Deleting data from a server
-===========================
-
-.. index:: object: memcached_st
-
---------
-SYNOPSIS
---------
-
-
-#include <libmemcached/memcached.h>
-
-.. c:function:: memcached_return_t memcached_delete (memcached_st *ptr, const char *key, size_t key_length, time_t expiration)
-
-.. c:function:: memcached_return_t memcached_delete_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, time_t expiration)
-
-Compile and link with -lmemcached
-
------------
-DESCRIPTION
------------
-
-
-:c:func:`memcached_delete` is used to delete a particular key.
-:c:func:`memcached_delete_by_key` works the same, but it takes a master key
-to find the given value.
-
-Expiration works by placing the item into a delete queue, which means that
-it won't be possible to retrieve it by the "get" command. The "add" and
-"replace" commands with this key will also fail (the "set" command will
-succeed, however). After the time passes, the item is finally deleted from server memory.
-
-Please note the the memcached server removed tests for expiration in
-the 1.4 version.
-
-
-------
-RETURN
-------
-
-
-A value of type :c:type:`memcached_return_t` is returned
-On success that value will be :c:type:`MEMCACHED_SUCCESS`.
-Use :c:func:`memcached_strerror` to translate this value to a printable
-string.
-
-If you are using the non-blocking mode of the library, success only
-means that the message was queued for delivery.
-
-
-
---------
-SEE ALSO
---------
-
-.. only:: man
-
- :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
+++ /dev/null
-==========================
-Dumping data from a server
-==========================
-
-
-Get a list of keys found on memcached servers
-
-.. index:: object: memcached_st
-
-
---------
-SYNOPSIS
---------
-
-
-#include <libmemcached/memcached.h>
-
-.. c:function:: memcached_return_t memcached_dump (memcached_st *ptr, memcached_dump_fn *function, void *context, uint32_t number_of_callbacks)
-
-.. c:type:: memcached_return_t (*memcached_dump_fn)(memcached_st *ptr, const char *key, size_t key_length, void *context)
-
-Compile and link with -lmemcached
-
-
-
------------
-DESCRIPTION
------------
-
-
-:c:func:`memcached_dump` is used to get a list of keys found in memcached(1)
-servers. Because memcached(1) does not guarantee to dump all keys you can not
-assume you have fetched all keys from the server. The function takes an array
-of callbacks that it will use to execute on keys as they are found.
-
-Currently the binary protocol is not tested.
-
-
-------
-RETURN
-------
-
-
-A value of type :c:type:`memcached_return_t` is returned
-On success that value will be :c:type:`MEMCACHED_SUCCESS`.
-Use :c:func:`memcached_strerror` to translate this value to a printable
-string.
-
-
-
---------
-SEE ALSO
---------
-
-.. only:: man
-
- :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
+++ /dev/null
-=====================================
-Wiping clean the contents of a server
-=====================================
-
-.. index:: object: memcached_st
-
-Wipe contents of memcached servers
-
-
---------
-SYNOPSIS
---------
-
-
-#include <libmemcached/memcached.h>
-
-.. c:function:: memcached_return_t memcached_flush (memcached_st *ptr, time_t expiration)
-
-Compile and link with -lmemcached
-
-
------------
-DESCRIPTION
------------
-
-
-:c:func::`memcached_flush` is used to wipe clean the contents of :program:`memcached` servers.
-It will either do this immediately or expire the content based on the
-expiration time passed to the method (a value of zero causes an immediate
-flush). The operation is not atomic to multiple servers, just atomic to a
-single server. That is, it will flush the servers in the order that they were
-added.
-
-
-------
-RETURN
-------
-
-
-A value of type :c:type:`memcached_return_t` is returned
-On success that value will be :c:type:`MEMCACHED_SUCCESS`.
-Use :c:type:`memcached_strerror` to translate this value to a printable string.
-
-
---------
-SEE ALSO
---------
-
-.. only:: man
-
- :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
+++ /dev/null
-=======================
-Flushing client buffers
-=======================
-
-
-.. index:: object: memcached_st
-
-Flush and send buffered commands
-
---------
-SYNOPSIS
---------
-
-#include <libmemcached/memcached.h>
-
-.. c:function:: memcached_return_t memcached_flush_buffers (memcached_st *ptr)
-
-Compile and link with -lmemcached
-
-
------------
-DESCRIPTION
------------
-
-
-:c:func:`memcached_flush_buffers` is used in conjunction with
-:c:type:`MEMCACHED_BEHAVIOR_BUFFER_REQUESTS` (see memcached_behavior(3)) to flush all buffers by sending the buffered commands to the server for processing.
-
-
-------
-RETURN
-------
-
-
-A value of type :c:type:`memcached_return_t` is returned
-On success that value will be :c:type:`MEMCACHED_SUCCESS`.
-Use :c:func:`memcached_strerror` to translate this value to a printable
-string.
-
-
-
-
---------
-SEE ALSO
---------
-
-.. only:: man
-
- :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
+++ /dev/null
-===============================
-Generating hash values directly
-===============================
-
-.. index:: object: memcached_st
-
-Hash a key value
-
-
---------
-SYNOPSIS
---------
-
-
-#include <libmemcached/memcached.h>
-
-.. c:type:: memcached_hash_t
-
-.. c:function:: uint32_t memcached_generate_hash_value (const char *key, size_t key_length, memcached_hash_t hash_algorithm)
-
-.. c:function:: uint32_t memcached_generate_hash (memcached_st *ptr, const char *key, size_t key_length)
-
-.. c:type:: MEMCACHED_HASH_DEFAULT
-
-.. c:type:: MEMCACHED_HASH_MD5
-
-.. c:type:: MEMCACHED_HASH_CRC
-
-.. c:type:: MEMCACHED_HASH_FNV1_64
-
-.. c:type:: MEMCACHED_HASH_FNV1A_64
-
-.. c:type:: MEMCACHED_HASH_FNV1_32
-
-.. c:type:: MEMCACHED_HASH_FNV1A_32
-
-.. c:type:: MEMCACHED_HASH_JENKINS
-
-.. c:type:: MEMCACHED_HASH_MURMUR
-
-.. c:type:: MEMCACHED_HASH_HSIEH
-
-.. c:type:: MEMCACHED_HASH_MURMUR3
-
-
-Compile and link with -lmemcachedutil -lmemcached
-
-
------------
-DESCRIPTION
------------
-
-
-:c:func:`memcached_generate_hash_value` allows you to hash a key using one of
-the hash functions defined in the library. This method is provided for
-the convenience of higher-level language bindings and is not necessary
-for normal memcache operations.
-
-The allowed hash algorithm constants are listed in the manpage for
-:c:func:`memcached_behavior_set`.
-
-:c:func:`memcached_generate_hash` takes a :c:type:`memcached_st` structure
-and produces the hash value that would have been generated based on the
-defaults of :c:type:`memcached_st`.
-
-As of version 0.36 all hash methods have been placed into the library
-libhashkit(3) which is linked with libmemcached(3). For more information please see its documentation.
-
-
-------
-RETURN
-------
-
-
-A 32-bit integer which is the result of hashing the given key.
-For 64-bit hash algorithms, only the least-significant 32 bits are
-returned.
-
-
-
---------
-SEE ALSO
---------
-
-.. only:: man
-
- :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
+++ /dev/null
-===============================
-Retrieving data from the server
-===============================
-
-.. index:: object: memcached_st
-
---------
-SYNOPSIS
---------
-
-
-#include <libmemcached/memcached.h>
-
-.. c:function:: memcached_result_st * memcached_fetch_result (memcached_st *ptr, memcached_result_st *result, memcached_return_t *error)
-
-.. c:function:: char * memcached_get (memcached_st *ptr, const char *key, size_t key_length, size_t *value_length, uint32_t *flags, memcached_return_t *error)
-
-.. c:function:: memcached_return_t memcached_mget (memcached_st *ptr, const char * const *keys, const size_t *key_length, size_t number_of_keys)
-
-.. c:function:: char * memcached_get_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, size_t *value_length, uint32_t *flags, memcached_return_t *error)
-
-.. c:function:: memcached_return_t memcached_mget_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char * const *keys, const size_t *key_length, size_t number_of_keys)
-
-.. c:function:: memcached_return_t memcached_fetch_execute (memcached_st *ptr, memcached_execute_fn *callback, void *context, uint32_t number_of_callbacks)
-
-.. c:function:: memcached_return_t memcached_mget_execute (memcached_st *ptr, const char * const *keys, const size_t *key_length, size_t number_of_keys, memcached_execute_fn *callback, void *context, uint32_t number_of_callbacks)
-
-.. c:function:: memcached_return_t memcached_mget_execute_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char * const *keys, const size_t *key_length, size_t number_of_keys, memcached_execute_fn *callback, void *context, uint32_t number_of_callbacks)
-
-.. c:type:: memcached_return_t (*memcached_execute_fn)(const memcached_st *ptr, memcached_result_st *result, void *context)
-
-Compile and link with -lmemcached
-
-
------------
-DESCRIPTION
------------
-
-
-:c:func:`memcached_get` is used to fetch an individual value from the server.
-You must pass in a key and its length to fetch the object. You must supply
-three pointer variables which will give you the state of the returned
-object. A :c:type:`uint32_t` pointer to contain whatever flags you stored with the value, a :c:type:`size_t` pointer which will be filled with size of of
-the object, and a :c:type:`memcached_return_t` pointer to hold any error. The
-object will be returned upon success and NULL will be returned on failure. Any
-object returned by :c:func:`memcached_get` must be released by the caller
-application.
-
-:c:func:`memcached_mget` is used to select multiple keys at once. For
-multiple key operations it is always faster to use this function. This function always works asynchronously.
-
-To retrieve data after a successful execution of :c:func:`memcached_mget`, you will need to
-call :c:func:`memcached_fetch_result`. You should continue to call this function until
-it returns a NULL (i.e. no more values). If you need to quit in the middle of a
-:c:func:`memcached_mget` call, you can execute a :c:func:`memcached_quit`, those this is not required.
-
-:c:func:`memcached_fetch_result` is used to fetch an individual value from the server. :c:func:`memcached_mget` must always be called before using this method.
-You must pass in a key and its length to fetch the object. You must supply
-three pointer variables which will give you the state of the returned
-object. A :c:type:`uint32_t` pointer to contain whatever flags you stored with the value, a :c:type:`size_t` pointer which will be filled with size of of the
-object, and a :c:type:`memcached_return_t` pointer to hold any error. The
-object will be returned upon success and NULL will be returned on failure. :c:type:`MEMCACHED_END` is returned by the \*error value when all objects that have been found are returned. The final value upon :c:type:`MEMCACHED_END` is null.
-
-:c:func:`memcached_fetch_result` is used to return a :c:type:`memcached_result_st` structure from a memcached server. The result object is forward compatible
-with changes to the server. For more information please refer to the
-:c:type:`memcached_result_st` help. This function will dynamically allocate a
-result structure for you if you do not pass one to the function.
-
-:c:func:`memcached_fetch_execute` is a callback function for result sets.
-Instead of returning the results to you for processing, it passes each of the
-result sets to the list of functions you provide. It passes to the function
-a :c:type:`memcached_st` that can be cloned for use in the called
-function (it can not be used directly). It also passes a result set which does
-not need to be freed. Finally it passes a "context". This is just a pointer to
-a memory reference you supply the calling function. Currently only one value
-is being passed to each function call. In the future there will be an option
-to allow this to be an array.
-
-:c:func:`memcached_mget_execute` and :c:func:`memcached_mget_execute_by_key`
-is similar to :c:func:`memcached_mget`, but it may trigger the supplied
-callbacks with result sets while sending out the queries. If you try to
-perform a really large multiget with :c:func:`memcached_mget` you may
-encounter a deadlock in the OS kernel (it will fail to write data to the
-socket because the input buffer is full). :c:func:`memcached_mget_execute`
-solves this problem by processing some of the results before continuing
-sending out requests. Please note that this function is only available in
-the binary protocol.
-
-:c:func:`memcached_get_by_key` and :c:func:`memcached_mget_by_key` behave
-in a similar nature as :c:func:`memcached_get` and :c:func:`memcached_mget`.
-The difference is that they take a master key that is used for determining
-which server an object was stored if key partitioning was used for storage.
-
-All of the above functions are not tested when the
-:c:type:`MEMCACHED_BEHAVIOR_USE_UDP` has been set. Executing any of these
-functions with this behavior on will result in :c:type:`MEMCACHED_NOT_SUPPORTED` being returned, or for those functions which do not return a :c:type:`memcached_return_t`, the error function parameter will be set to :c:type:`MEMCACHED_NOT_SUPPORTED`.
-
-
-------
-RETURN
-------
-
-
-All objects retrieved via :c:func:`memcached_get` or :c:func:`memcached_get_by_key` must be freed with :manpage:`free(3)`.
-
-:c:func:`memcached_get` will return NULL on
-error. You must look at the value of error to determine what the actual error
-was.
-
-:c:func:`memcached_fetch_execute` return :c:type:`MEMCACHED_SUCCESS` if
-all keys were successful. :c:type:`MEMCACHED_NOTFOUND` will be return if no
-keys at all were found.
-
-:c:func:`memcached_fetch_result` sets error
-to :c:type:`MEMCACHED_END` upon successful conclusion.
-:c:type:`MEMCACHED_NOTFOUND` will be return if no keys at all were found.
-
-
---------
-SEE ALSO
---------
-
-.. only:: man
-
- :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
+++ /dev/null
-========================================
-Use custom allocators for embedded usage
-========================================
-
-.. index:: object: memcached_st
-
-Manage memory allocator functions
-
---------
-SYNOPSIS
---------
-
-
-#include <libmemcached/memcached.h>
-
-.. c:function:: memcached_return_t memcached_set_memory_allocators (memcached_st *ptr, memcached_malloc_fn mem_malloc, memcached_free_fn mem_free, memcached_realloc_fn mem_realloc, memcached_calloc_fn mem_calloc, void *context)
-
-.. c:function:: void memcached_get_memory_allocators (memcached_st *ptr, memcached_malloc_fn *mem_malloc, memcached_free_fn *mem_free, memcached_realloc_fn *mem_realloc, memcached_calloc_fn *mem_calloc)
-
-.. c:function:: void * memcached_get_memory_allocators_context(const memcached_st *ptr)
-
-.. c:function:: void * (*memcached_malloc_fn) (memcached_st *ptr, const size_t size, void *context)
-
-.. c:function:: void * (*memcached_realloc_fn) (memcached_st *ptr, void *mem, const size_t size, void *context)
-
-.. c:function:: void (*memcached_free_fn) (memcached_st *ptr, void *mem, void *context)
-
-.. c:function:: void * (*memcached_calloc_fn) (memcached_st *ptr, size_t nelem, const size_t elsize, void *context)
-
-Compile and link with -lmemcached
-
-
-
------------
-DESCRIPTION
------------
-
-
-libmemcached(3) allows you to specify your own memory allocators, optimized
-for your application. This enables libmemcached to be used inside of applications that have their own malloc implementation.
-
-:c:func:`memcached_set_memory_allocators` is used to set the memory
-allocators used by the memcached instance specified by ptr. Please note that
-you cannot override only one of the memory allocators, you have to specify a
-complete new set if you want to override one of them. All of the memory
-allocation functions should behave as specified in the C99 standard. Specify
-NULL as all functions to reset them to the default values.
-
-:c:func:`memcached_get_memory_allocators` is used to get the currently used
-memory allocators by a memcached handle.
-
-:c:func:`memcached_get_memory_allocators_context` returns the void \* that
-was passed in during the call to :c:func:`memcached_set_memory_allocators`.
-
-The first argument to the memory allocator functions is a pointer to a
-memcached structure, the is passed as const and you will need to clone
-it in order to make use of any operation which would modify it.
-
-
------
-NOTES
------
-
-
-In version 0.38 all functions were modified to have a context void pointer
-passed to them. This was so that customer allocators could have their
-own space for memory.
-
-
-------
-RETURN
-------
-
-
-:c:func:`memcached_set_memory_allocators` return :c:type:`MEMCACHED_SUCCESS`
-upon success, and :c:type:`MEMCACHED_FAILURE` if you don't pass a complete set
-of function pointers.
-
-
---------
-SEE ALSO
---------
-
-.. only:: man
-
- :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
+++ /dev/null
-============================
-Working with memcached pools
-============================
-
---------
-SYNOPSIS
---------
-
-#include <libmemcached/memcached_pool.h>
- Compile and link with -lmemcachedutil -lmemcached
-
-.. c:type:: struct memcached_pool_st
-
- typedef struct memcached_pool_st memcached_pool_st;
-
-.. c:function:: memcached_pool_st* memcached_pool(const char *option_string, size_t option_string_length)
-
-.. c:function:: memcached_st* memcached_pool_destroy(memcached_pool_st* pool)
-
-.. c:function:: memcached_st* memcached_pool_fetch(memcached_pool_st*, struct timespec* relative_time, memcached_return_t* rc)
-.. versionadded:: 0.53
- Synonym for memcached_pool_pop
-
-.. c:function:: memcached_return_t memcached_pool_release(memcached_pool_st* pool, memcached_st* mmc)
-.. versionadded:: 0.53
- Synonym for memcached_pool_push.
-
-.. c:function:: memcached_return_t memcached_pool_behavior_set(memcached_pool_st *pool, memcached_behavior_t flag, uint64_t data)
-
-.. c:function:: memcached_return_t memcached_pool_behavior_get(memcached_pool_st *pool, memcached_behavior_t flag, uint64_t *value)
-
-
-.. c:function:: memcached_pool_st* memcached_pool_create(memcached_st* mmc, int initial, int max)
-.. deprecated:: 0.46
- Use :c:func:`memcached_pool`
-
-.. c:function:: memcached_st* memcached_pool_pop(memcached_pool_st* pool, bool block, memcached_return_t *rc)
-.. deprecated:: 0.53
- Use :c:func:`memcached_pool_fetch`
-
-.. c:function:: memcached_return_t memcached_pool_push(memcached_pool_st* pool, memcached_st *mmc)
-.. deprecated:: 0.53
- Use :c:func:`memcached_pool_release`
-
-
------------
-DESCRIPTION
------------
-
-
-:c:func:`memcached_pool` is used to create a connection pool of objects you
-may use to remove the overhead of using memcached_clone for short lived
-:c:type:`memcached_st` objects. Please see :doc:`libmemcached_configuration`
-for details on the format of the configuration string.
-
-:c:func:`memcached_pool_destroy` is used to destroy the connection pool
-created with :c:func:`memcached_pool_create` and release all allocated
-resources. It will return the pointer to the :c:type:`memcached_st` structure
-passed as an argument to :c:func:`memcached_pool_create`, and returns the
-ownership of the pointer to the caller when created with
-:c:func:`memcached_pool_create`, otherwise NULL is returned..
-
-:c:func:`memcached_pool_fetch` is used to fetch a connection structure from the
-connection pool. The relative_time argument specifies if the function should
-block and wait for a connection structure to be available if we try
-to exceed the maximum size. You need to specify time in relative time.
-
-:c:func:`memcached_pool_release` is used to return a connection structure back
-to the pool.
-
-:c:func:`memcached_pool_behavior_get` and :c:func:`memcached_pool_behavior_set`
-is used to get/set behavior flags on all connections in the pool.
-
-Both :c:func:`memcached_pool_release` and :c:func:`memcached_pool_fetch` are
-thread safe.
-
-------
-RETURN
-------
-
-:c:func:`memcached_pool_destroy` returns the pointer (and ownership) to the
-:c:type:`memcached_st` structure used to create the pool. If connections are in
-use it returns NULL.
-
-:c:func:`memcached_pool_pop` returns a pointer to a :c:type:`memcached_st`
-structure from the pool (or NULL if an allocation cannot be satisfied).
-
-:c:func:`memcached_pool_release` returns :c:type:`MEMCACHED_SUCCESS` upon success.
-
-:c:func:`memcached_pool_behavior_get` and :c:func:`memcached_pool_behavior_get`
-returns :c:type:`MEMCACHED_SUCCESS` upon success.
-
-If any methods returns MEMCACHED_IN_PROGRESS then a lock on the pool could not
-be obtained. If any of the parameters passed to any of these functions is
-invalid, MEMCACHED_INVALID_ARGUMENTS will be returned.
-
-memcached_pool_fetch may return MEMCACHED_TIMEOUT if a timeout occurs while
-waiting for a free memcached_st. MEMCACHED_NOTFOUND if no memcached_st was
-available.
-
-
-
---------
-SEE ALSO
---------
-
-.. only:: man
-
- :manpage:`memcached(1)`
- :manpage:`libmemcached(3)`
- :manpage:`libmemcached_configuration(3)`
- :manpage:`memcached_strerror(3)`
-
-.. only:: html
-
- * :manpage:`memcached(1)`
- * :doc:`libmemcached`
- * :doc:`libmemcached_configuration`
- * :doc:`memcached_strerror`
+++ /dev/null
-====================================
-Disconnecting a client from a server
-====================================
-
-.. index:: object: memcached_st
-
---------
-SYNOPSIS
---------
-
-#include <libmemcached/memcached.h>
-
-.. c:function:: void memcached_quit (memcached_st *ptr)
-
-Compile and link with -lmemcached
-
------------
-DESCRIPTION
------------
-
-
-:c:func:`memcached_quit` will disconnect you from all currently connected
-servers. It will also reset the state of the connection (ie, any :c:func:`memcached_fetch` you are in the middle of will be terminated). This function is
-called automatically when you call :c:func:`memcached_free` on the :c:type:`memcached_st` structure.
-
-You do not need to call this on your own. All operations to change server
-hashes and parameters will handle connections to the server for you. This
-function is provided mainly so that you can timeout your connections or
-reset connections during the middle of a :c:func:`memcached_fetch`.
-
-
-------
-RETURN
-------
-
-
-A value of type :c:type:`memcached_return_t` is returned On success that value
-will be :c:type:`MEMCACHED_SUCCESS`. Use :c:func:`memcached_strerror` to
-translate this value to a printable string.
-
-
---------
-SEE ALSO
---------
-
-.. only:: man
-
- :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
+++ /dev/null
-========================
-Working with result sets
-========================
-
---------
-SYNOPSIS
---------
-
-#include <libmemcached/memcached_pool.h>
-
-.. c:type:: memcached_result_st
-
-.. c:function:: memcached_result_st * memcached_result_create (memcached_st *ptr, memcached_result_st *result)
-
-.. c:function:: void memcached_result_free (memcached_result_st *result)
-
-.. c:function:: const char * memcached_result_key_value (memcached_result_st *result)
-
-.. c:function:: size_t memcached_result_key_length (const memcached_result_st *result)
-
-.. c:function:: const char *memcached_result_value (memcached_result_st *ptr)
-
-.. c:function:: char *memcached_result_take_value (memcached_result_st *ptr)
-
-.. c:function:: size_t memcached_result_length (const memcached_result_st *ptr)
-
-.. c:function:: uint32_t memcached_result_flags (const memcached_result_st *result)
-
-.. c:function:: uint64_t memcached_result_cas (const memcached_result_st *result)
-
-.. c:function:: memcached_return_t memcached_result_set_value (memcached_result_st *ptr, const char *value, size_t length)
-
-.. c:function:: void memcached_result_set_flags (memcached_result_st *ptr, uint32_t flags)
-
-.. c:function:: void memcached_result_set_expiration (memcached_result_st *ptr, time_t)
-
-Compile and link with -lmemcachedutil -lmemcached
-
-
-
------------
-DESCRIPTION
------------
-
-
-libmemcached(3) can optionally return a :c:type:`memcached_result_st` which
-acts as a result object. The result objects have added benefits over the
-character pointer returns, in that they are forward compatible with new
-return items that future memcached servers may implement (the best current
-example of this is the CAS return item). The structures can also be reused,
-which will save on calls to malloc(3). It is suggested that you use result
-objects over char \* return functions.
-
-The structure of :c:type:`memcached_result_st` has been encapsulated, you should
-not write code to directly access members of the structure.
-
-:c:func:`memcached_result_create` will either allocate memory for a
-:c:type:`memcached_result_st` or will initialize a structure passed to it.
-
-:c:func:`memcached_result_free` will deallocate any memory attached to the
-structure. If the structure was also allocated, it will deallocate it.
-
-:c:func:`memcached_result_key_value` returns the key value associated with the
-current result object.
-
-:c:func:`memcached_result_key_length` returns the key length associated with
-the current result object.
-
-:c:func:`memcached_result_value` returns the result value associated with the
-current result object.
-
-:c:func:`memcached_result_take_value` returns and hands over the result value
-associated with the current result object. You must call free() to release this
-value, unless you have made use of a custom allocator. Use of a custom
-allocator requires that you create your own custom free() to release it.
-
-:c:func:`memcached_result_length` returns the result length associated with
-the current result object.
-
-:c:func:`memcached_result_flags` returns the flags associated with the
-current result object.
-
-:c:func:`memcached_result_cas` returns the cas associated with the
-current result object. This value will only be available if the server
-tests it.
-
-:c:func:`memcached_result_set_value` takes a byte array and a size and sets
-the result to this value. This function is used for trigger responses.
-
-:c:func:`memcached_result_set_flags` takes a result structure and stores a new
-value for the flags field.
-
-:c:func:`memcached_result_set_expiration` takes a result structure and stores
-a new value for the expiration field (this is only used by read through
-triggers).
-
-You may wish to avoid using memcached_result_create(3) with a
-stack based allocation. The most common issues related to ABI safety involve
-heap allocated structures.
-
-
-------
-RETURN
-------
-
-
-Varies, see particular functions. All structures must have
-:c:func:`memcached_result_free` called on them for cleanup purposes. Failure
-to do this will result in leaked memory.
-
-
-
---------
-SEE ALSO
---------
-
-.. only:: man
-
- :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
+++ /dev/null
-============
-SASL support
-============
-
-.. index:: object: memcached_st
-
-
---------
-SYNOPSIS
---------
-
-#include <libmemcached/memcached_pool.h>
-
-.. c:function:: void memcached_set_sasl_callbacks(memcached_st *ptr, const sasl_callback_t *callbacks)
-
-.. c:function:: const sasl_callback_t *memcached_get_sasl_callbacks(memcached_st *ptr)
-
-.. c:function:: memcached_return_t memcached_set_sasl_auth_data(memcached_st *ptr, const char *username, const char *password)
-
-.. c:function:: memcached_return_t memcached_destroy_sasl_auth_data(memcached_st *ptr)
-
-Compile and link with -lmemcached
-
-
-
------------
-DESCRIPTION
------------
-
-
-libmemcached(3) allows you to plug in your own callbacks function used by
-libsasl to perform SASL authentication.
-
-Please note that SASL requires the memcached binary protocol, and you have
-to specify the callbacks before you connect to the server.
-
-:c:func:`memcached_set_sasl_auth_data` is a helper function defining
-the basic functionality for you, but it will store the username and password
-in memory. If you choose to use this method you have to call
-:c:type:`memcached_destroy_sasl_auth_data` before calling
-:c:type:`memcached_free` to avoid a memory leak. You should NOT call
-:c:type:`memcached_destroy_sasl_auth_data` if you specify your own callback
-function with :c:func:`memcached_set_sasl_callbacks`.
-
-
-------
-RETURN
-------
-
-
-:c:func:`memcached_get_sasl_callbacks` returns the callbacks currently used by
-this memcached handle. :c:func:`memcached_set_sasl_auth_data` returns
-:c:type:`MEMCACHED_SUCCESS` upon success.
-
-
-
---------
-SEE ALSO
---------
-
-.. only:: man
-
- :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
+++ /dev/null
-=========================
-Managing lists of servers
-=========================
-
-
---------
-SYNOPSIS
---------
-
-
-
-#include <libmemcached/memcached.h>
-
-.. c:type:: const memcached_instance_st *
-
-.. c:type:: memcached_server_list_st
-
-.. c:type:: memcached_server_st
-
-.. c:function:: const const memcached_instance_st * memcached_server_list (memcached_st *ptr)
-
-.. c:function:: void memcached_server_list_free (memcached_server_list_st list)
-
-.. c:function:: memcached_server_list_st memcached_server_list_append (memcached_server_list_st list, const char *hostname, in_port_t port, memcached_return_t *error)
-
-.. c:function:: uint32_t memcached_server_list_count (memcached_server_list_st list)
-
-.. c:function:: const char *memcached_server_error (const memcached_instance_st * instance)
-
-.. c:function:: void memcached_server_error_reset (const memcached_instance_st * list)
-.. deprecated:: 0.39
-
-.. c:function:: void memcached_servers_parse ()
-.. deprecated:: 0.39
-
-Compile and link with -lmemcached
-
-
------------
-DESCRIPTION
------------
-
-
-libmemcached(3) operates on a list of hosts which are stored in
-:c:type:`memcached_server_st` structures. You should not modify these structures
-directly. Functions are provided to modify these structures (and more can be
-added, just ask!).
-
-:c:func:`memcached_server_list` is used to provide an array of all defined hosts. This was incorrectly documented as "requiring free" up till version 0.39.
-
-:c:func:`memcached_server_list_free` deallocates all memory associated with the array of :c:type:`memcached_server_st` that you passed to it.
-
-:c:func:`memcached_server_list_append` adds a server to the end of a
-:c:type:`memcached_server_st` array. On error null will be returned and the
-:c:type:`memcached_return_t` pointer you passed into the function will be set with the appropriate error. If the value of port is zero, it is set to the default
-port of a memcached server.
-
-DEPRECATED :c:func:`memcached_servers_parse`, please see :c:func:`memcached`
-
-:c:func:`memcached_server_error` can be used to look at the text of the last error message sent by the server to to the client.
-
-Before version 0.39 theses functions used a memcached_server_st \*. In 0.39
-memcached_server_st \* was aliased to :c:type:`memcached_server_list_st`. This was done for a style reason to help clean up some concepts in the code.
-
-
-------
-RETURN
-------
-
-
-Varies, see particular functions.
-
-
-
---------
-SEE ALSO
---------
-
-.. only:: man
-
- :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
+++ /dev/null
-========================================================
-Manipulate the server information stored in memcached_st
-========================================================
-
---------
-SYNOPSIS
---------
-
-#include <libmemcached/memcached.h>
-
-.. c:type:: memcached_server_fn
-
-.. c:function:: uint32_t memcached_server_count (memcached_st *ptr)
-
-.. c:function:: memcached_return_t memcached_server_add (memcached_st *ptr, const char *hostname, in_port_t port)
-
-.. c:function:: memcached_return_t memcached_server_add_udp (memcached_st *ptr, const char *hostname, in_port_t port)
-
-.. c:function:: memcached_return_t memcached_server_add_unix_socket (memcached_st *ptr, const char *socket)
-
-.. c:function:: memcached_return_t memcached_server_push (memcached_st *ptr, const memcached_server_st *list)
-
-.. c:function:: const memcached_instance_st * memcached_server_by_key (memcached_st *ptr, const char *key, size_t key_length, memcached_return_t *error)
-
-.. c:function:: const memcached_instance_st * memcached_server_get_last_disconnect (const memcached_st *ptr)
-
-.. c:function:: memcached_return_t memcached_server_cursor(const memcached_st *ptr, const memcached_server_fn *callback, void *context, uint32_t number_of_callbacks)
-
-compile and link with -lmemcached
-
-
-
------------
-DESCRIPTION
------------
-
-
-:doc:`libmemcached` performs operations on a list of hosts. The order of
-these hosts determine routing to keys. Functions are provided to add keys to
-memcached_st structures. To manipulate lists of servers see
-memcached_server_st(3).
-
-:c:func:`memcached_server_count` provides you a count of the current number of
-servers being used by a :c:type:`memcached_st` structure.
-
-:c:func:`memcached_server_add` pushes a single TCP server into the :c:type:`memcached_st` structure. This server will be placed at the end. Duplicate servers
- are allowed, so duplication is not checked. Executing this function with the :c:type:`MEMCACHED_BEHAVIOR_USE_UDP` behavior set will result in a :c:type:`MEMCACHED_INVALID_HOST_PROTOCOL`.
-
-:c:func:`memcached_server_add_udp` pushes a single UDP server into the :c:type:`memcached_st` structure. This server will be placed at the end. Duplicate
-servers are allowed, so duplication is not checked. Executing this function with out setting the :c:type:`MEMCACHED_BEHAVIOR_USE_UDP` behavior will result in a
-:c:type:`MEMCACHED_INVALID_HOST_PROTOCOL`.
-
-:c:func:`memcached_server_add_unix_socket` pushes a single UNIX socket into the :c:type:`memcached_st` structure. This UNIX socket will be placed at the end.
-Duplicate servers are allowed, so duplication is not checked. The length
-of the filename must be one character less than :c:type:`MEMCACHED_MAX_HOST_LENGTH`.
-
-:c:func:`memcached_server_push` pushes an array of :c:type:`memcached_server_st` into the :c:type:`memcached_st` structure. These servers will be placed at
-the end. Duplicate servers are allowed, so duplication is not checked. A
-copy is made of structure so the list provided (and any operations on
-the list) are not saved.
-
-:c:func:`memcached_server_by_key` allows you to provide a key and retrieve the
-server which would be used for assignment.
-
-:c:func:`memcached_server_get_last_disconnect` returns a pointer to the last
-server for which there was a connection problem. It does not mean this
-particular server is currently dead but if the library is reporting a server
-is, the returned server is a very good candidate.
-
-:c:func:`memcached_server_cursor` takes a memcached_st and loops through the
-list of hosts currently in the cursor calling the list of callback
-functions provided. You can optionally pass in a value via
-context which will be provided to each callback function. An error
-return from any callback will terminate the loop. :c:func:`memcached_server_cursor` is passed the original caller :c:type:`memcached_st` in its current state.
-
-
-------
-RETURN
-------
-
-
-Varies, see particular functions.
-
-
---------
-SEE ALSO
---------
-
-.. only:: man
-
- :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
+++ /dev/null
-=========================================================
-Store, replace, add, or atomically add data to the server
-=========================================================
-
-.. index:: object: memcached_st
-
-
---------
-SYNOPSIS
---------
-
-
-#include <libmemcached/memcached.h>
-
-.. c:function:: memcached_return_t memcached_set (memcached_st *ptr, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags)
-
-.. c:function:: memcached_return_t memcached_add (memcached_st *ptr, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags)
-
-.. c:function:: memcached_return_t memcached_replace (memcached_st *ptr, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags)
-
-.. c:function:: memcached_return_t memcached_set_by_key(memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags)
-
-.. c:function:: memcached_return_t memcached_add_by_key(memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags)
-
-.. c:function:: memcached_return_t memcached_replace_by_key(memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags)
-
-Compile and link with -lmemcached
-
-
------------
-DESCRIPTION
------------
-
-
-:c:func:`memcached_set`, :c:func:`memcached_add`, and :c:func:`memcached_replace` are all used to store information on the server. All methods take a key, and its length to store the object. Keys are currently limited to 250 characters when using either a version of memcached(1) which is 1.4 or below, or when using the text protocol. You must supply both a value and a length. Optionally you
-store the object. Keys are currently limited to 250 characters by the
-memcached(1) server. You must supply both a value and a length. Optionally you
-may test an expiration time for the object and a 16 byte value (it is meant to be used as a bitmap). "flags" is a 4byte space that is stored alongside of the main value. Many sub libraries make use of this field, so in most cases users should avoid making use of it.
-
-:c:func:`memcached_set` will write an object to the server. If an object
-already exists it will overwrite what is in the server. If the object does not
-exist it will be written. If you are using the non-blocking mode this function
-will always return true unless a network error occurs.
-
-:c:func:`memcached_replace` replaces an object on the server. If the object is not found on the server an error occurs.
-
-:c:func:`memcached_add` adds an object to the server. If the object is found on the server an error occurs, otherwise the value is stored.
-
-:c:func:`memcached_cas` overwrites data in the server as long as the "cas"
-value is still the same in the server. You can get the cas value of a result by
-calling :c:func:`memcached_result_cas` on a memcached_result_st(3) structure. At the point
-that this note was written cas is still buggy in memcached. Turning on tests
-for it in libmemcached(3) is optional. Please see memcached_set for
-information on how to do this.
-
-:c:func:`memcached_set_by_key`, :c:func:`memcached_add_by_key`, and :c:func:`memcached_replace_by_key` methods all behave in a similar method as the non
-key methods. The difference is that they use their group_key parameter to map
-objects to particular servers.
-
-If you are looking for performance, :c:func:`memcached_set` with non-blocking IO is the fastest way to store data on the server.
-
-All of the above functions are tested with the :c:type:`MEMCACHED_BEHAVIOR_USE_UDP` behavior enabled. However, when using these operations with this behavior
-on, there are limits to the size of the payload being sent to the server.
-The reason for these limits is that the Memcached Server does not allow
-multi-datagram requests and the current server implementation sets a datagram
-size to 1400 bytes. Due to protocol overhead, the actual limit of the user supplied data is less than 1400 bytes and depends on the protocol in use as, well as the operation being
-executed. When running with the binary protocol, :c:type:`MEMCACHED_BEHAVIOR_BINARY_PROTOCOL`, the size of the key,value, flags and expiry combined may not
-exceed 1368 bytes. When running with the ASCII protocol, the exact limit fluctuates depending on which function is being executed and whether the function is a cas operation or not. For non-cas ASCII set operations, there are at least
-1335 bytes available to split among the key, key_prefix, and value; for cas
-ASCII operations there are at least 1318 bytes available to split among the key, key_prefix and value. If the total size of the command, including overhead,
-exceeds 1400 bytes, a :c:type:`MEMCACHED_WRITE_FAILURE` will be returned.
-
-
-------
-RETURN
-------
-
-
-All methods return a value of type :c:type:`memcached_return_t`.
-On success the value will be :c:type:`MEMCACHED_SUCCESS`.
-Use :c:func:`memcached_strerror` to translate this value to a printable string.
-
-For :c:func:`memcached_replace` and :c:func:`memcached_add`, :c:type:`MEMCACHED_NOTSTORED` is a legitimate error in the case of a collision.
-
-
-
---------
-SEE ALSO
---------
-
-.. only:: man
-
- :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` :manpage:`memcached_prepend(3)` :manpage:`memcached_cas(3)` :manpage:`memcached_append(3)`
-
+++ /dev/null
-==================================================
-Working with statistical information from a server
-==================================================
-
-
-Get memcached statistics
-
-.. index:: object: memcached_st
-
-
---------
-SYNOPSIS
---------
-
-#include <libmemcached/memcached.h>
-
-.. c:type:: memcached_stat_st
-
-.. c:type:: memcached_return_t (*memcached_stat_fn)(const memcached_instance_st * server, const char *key, size_t key_length, const char *value, size_t value_length, void *context)
-
-.. c:function:: memcached_stat_st *memcached_stat (memcached_st *ptr, char *args, memcached_return_t *error)
-
-.. c:function:: memcached_return_t memcached_stat_servername (memcached_stat_st *stat, char *args, const char *hostname, in_port_t port)
-
-.. c:function:: char * memcached_stat_get_value (memcached_st *ptr, memcached_stat_st *stat, const char *key, memcached_return_t *error)
-
-.. c:function:: char ** memcached_stat_get_keys (memcached_st *ptr, memcached_stat_st *stat, memcached_return_t *error)
-
-.. c:function:: memcached_return_t memcached_stat_execute (memcached_st *memc, const char *args, memcached_stat_fn func, void *context)
-
-Compile and link with -lmemcached
-
------------
-DESCRIPTION
------------
-
-
-libmemcached(3) has the ability to query a memcached server (or collection
-of servers) for their current state. Queries to find state return a
-:c:type:`memcached_stat_st` structure. You are responsible for freeing this structure. While it is possible to access the structure directly it is not advisable. :c:func:`memcached_stat_get_value` has been provided to query the structure.
-
-:c:func:`memcached_stat_execute` uses the servers found in :c:type:`memcached_stat_st` and executes a "stat" command on each server. args is an optional argument that can be passed in to modify the behavior of "stats". You will need to supply a callback function that will be supplied each pair of values returned by
-the memcached server.
-
-:c:func:`memcached_stat` fetches an array of :c:type:`memcached_stat_st` structures containing the state of all available memcached servers. The return value must be freed by the calling application. If called with the :c:type:`MEMCACHED_BEHAVIOR_USE_UDP` behavior set, a NULL value is returned and the error parameter is set to :c:type:`MEMCACHED_NOT_SUPPORTED`.
-
-:c:func:`memcached_stat_servername` can be used standalone without a :c:type:`memcached_st` to obtain the state of a particular server. "args" is used to define a particular state object (a list of these are not provided for by either
-the :c:func:`memcached_stat_get_keys` call nor are they defined in the memcached protocol). You must specify the hostname and port of the server you want to
-obtain information on.
-
-:c:func:`memcached_stat_get_value` returns the value of a particular state key. You specify the key you wish to obtain. The key must be null terminated.
-
-:c:func:`memcached_stat_get_keys` returns a list of keys that the server has state objects on. You are responsible for freeing this list.
-
-A command line tool, memstat(1), is provided so that you do not have to write
-an application to do this.
-
-
-------
-RETURN
-------
-
-
-Varies, see particular functions.
-
-Any method returning a :c:type:`memcached_stat_st` expects you to free the
-memory allocated for it.
-
-
-
---------
-SEE ALSO
---------
-
-.. only:: man
-
- :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
-
+++ /dev/null
-=================================================
-Converting Errors, memcached_return_t, to strings
-=================================================
-
-
-.. index:: object: memcached_st
-
---------
-SYNOPSIS
---------
-
-.. describe:: #include <libmemcached/memcached.h>
-
-.. c:function:: const char * memcached_strerror (memcached_st *ptr, memcached_return_t rc)
-
-Compile and link with -lmemcached
-
-
------------
-DESCRIPTION
------------
-
-
-:c:func:`memcached_strerror` takes a :c:type:`memcached_return_t` value and returns a string describing the error.
-
-This string must not be modified by the application.
-
-:c:type:`memcached_return_t` values are returned from nearly all libmemcached(3) functions.
-
-:c:type:`memcached_return_t` values are of an enum type so that you can set up responses with switch/case and know that you are capturing all possible return values.
-
-
-------
-RETURN
-------
-
-
-:c:func:`memcached_strerror` returns a string describing a :c:type:`memcached_return_t` value.
-
-
---------
-SEE ALSO
---------
-
-.. only:: man
-
- :manpage:`memcached(1)` :manpage:`libmemcached(3)`
-
+++ /dev/null
-==============================================
-Storing custom user information in the client.
-==============================================
-
-.. index:: object: memcached_st
-
-Manage user specific data
-
-
--------
-LIBRARY
--------
-
-
-C Client Library for memcached (libmemcached, -lmemcached)
-
-
---------
-SYNOPSIS
---------
-
-
-#include <libmemcached/memcached.h>
-
-.. c:function:: void *memcached_get_user_data (memcached_st *ptr)
-
-.. c:function:: void *memcached_set_user_data (memcached_st *ptr, void *data)
-
-Compile and link with -lmemcached
-
-
-
------------
-DESCRIPTION
------------
-
-
-libmemcached(3) allows you to store a pointer to a user specific data inside
-the memcached_st structure.
-
-:c:func:`memcached_set_user_data` is used to set the user specific data in the
-:c:type:`memcached_st` structure.
-
-:c:func:`memcached_get_user_data` is used to retrieve the user specific data in the :c:type:`memcached_st` structure.
-
-
-------
-RETURN
-------
-
-
-:c:func:`memcached_set_user_data` returns the previous value of the user specific data.
-
-:c:func:`memcached_get_user_data` returns the current value uf the user specific data.
-
-
-
---------
-SEE ALSO
---------
-
-.. only:: man
-
- :manpage:`memcached(1)` :manpage:`libmemcached(3)`
-
+++ /dev/null
-=================================
-Setting the verbosity of a server
-=================================
-
-.. index:: object: memcached_st
-
-Modify verbosity of servers
-
---------
-SYNOPSIS
---------
-
-#include <libmemcached/memcached.h>
-
-.. c:function:: memcached_return_t memcached_verbosity (memcached_st *ptr, uint32_t verbosity)
-
-Compile and link with -lmemcached
-
-
------------
-DESCRIPTION
------------
-
-
-:c:func:`memcached_verbosity` modifies the "verbosity" of the
-memcached(1) servers referenced in the :c:type:`memcached_st` parameter.
-
-
-------
-RETURN
-------
-
-
-A value of type :c:type:`memcached_return_t` is returned.
-
-On success that value will be :c:type:`MEMCACHED_SUCCESS`.
-
-Use :c:func:`memcached_strerror` to translate this value to a printable string.
-
-
---------
-SEE ALSO
---------
-
-.. only:: man
-
- :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
-
+++ /dev/null
-=======================================================
-Getting version information about the client and server
-=======================================================
-
-
---------
-SYNOPSIS
---------
-
-#include <libmemcached/memcached.h>
-
-.. c:function:: const char * memcached_lib_version (void)
-
-.. c:function:: memcached_return_t memcached_version (memcached_st *ptr)
-
-
-Compile and link with -lmemcached
-
-
-
------------
-DESCRIPTION
------------
-
-
-:c:func:`memcached_lib_version` is used to return a simple version string representing the libmemcached version (client library version, not server version)
-
-:c:func:`memcached_version` is used to set the major, minor, and micro versions of each memcached server being used by the memcached_st connection structure. It returns the memcached server return code.
-
-
-------
-RETURN
-------
-
-
-:c:func:`memcached_lib_version` returns a string with the version of the libmemcached driver.
-
-A value of :c:type:`memcached_return_t` is returned from :c:func:'memcached_version'
-
-On success that value will be :c:type:`MEMCACHED_SUCCESS`.
-
-If called with the :c:func:`MEMCACHED_BEHAVIOR_USE_UDP` behavior set, the value :c:type:`MEMCACHED_NOT_SUPPORTED` will be returned.
-
-Use :c:func:`memcached_strerror` to translate this value to
-a printable string.
-
-
-
---------
-SEE ALSO
---------
-
-.. only:: man
-
- :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
-
+++ /dev/null
-=================
-Systemtap support
-=================
-
-By default on Linux libmemcached is compiled to support Systemtap. This enabled/disabled during compiles via the dtrace configure flag.
-
-Please see :manpage:`stapex` for more information about Systemtap.
+++ /dev/null
-================
-Required C types
-================
-
-.. highlightlang:: c
-
-Types
------
-
-C Types Used
-------------
-
-.. c:type:: bool
-
-.. c:type:: uint32_t
-
-.. c:type:: uint64_t
-
-.. c:type:: in_port_t
-
-.. c:type:: size_t
-
-.. c:type:: time_t
-
-.. c:type:: struct timespec
-
-.. c:type:: sasl_callback_t
+++ /dev/null
-==========
-Versioning
-==========
-
-Libmemcached is laid out by interface version. The 1.0 version would be found in: ``libmemcached-1.0/memcached.h``
-
-The historic ``libmemcached/memcached.h`` includes ``libmemcached-1.0/memcached.h``.
-For best practice you should include the version of libmemcached that you used during development.
-
#pragma once
-#define MEMCACHED_MAXIMUM_INTEGER_DISPLAY_LENGTH 20
#define MEMCACHED_MAX_BUFFER 8196
-#define MEMCACHED_MAX_HOST_SORT_LENGTH 86 /* Used for Ketama */
#define MEMCACHED_MAX_KEY 251 /* We add one to have it null terminated */
-#define MEMCACHED_PREFIX_KEY_MAX_SIZE 128
+#define MEMCACHED_MAX_NAMESPACE 128
+
+#define MEMCACHED_MAX_HOST_SORT_LENGTH 86 /* Used for Ketama */
+#define MEMCACHED_MAX_INTEGER_DISPLAY_LENGTH 20
#define MEMCACHED_VERSION_STRING_LENGTH 24
+
+/* legacy */
+#define MEMCACHED_MAXIMUM_INTEGER_DISPLAY_LENGTH MEMCACHED_MAX_INTEGER_DISPLAY_LENGTH
+#define MEMCACHED_PREFIX_KEY_MAX_SIZE MEMCACHED_MAX_NAMESPACE
}
memc.flags.verify_key= orig;
- if ((key_length > MEMCACHED_PREFIX_KEY_MAX_SIZE -1))
+ if ((key_length > MEMCACHED_MAX_NAMESPACE -1))
{
return memcached_set_error(memc, MEMCACHED_KEY_TOO_BIG, MEMCACHED_AT);
}
projects / awesomized / libmemcached / commitdiff
