X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fmemcached_servers.rst;h=5156b2a2c69e7c83e02b0f67a57c3f06045db21d;hb=a6c3e3a3d04f379b1480c8c88a8eae17e54b1449;hp=6c03ea0309f9a039aa3cca51abb7c9f8b4060fe9;hpb=86be0943416087ba738c28ddbde8cdcbd62ad777;p=awesomized%2Flibmemcached diff --git a/docs/memcached_servers.rst b/docs/memcached_servers.rst index 6c03ea03..5156b2a2 100644 --- a/docs/memcached_servers.rst +++ b/docs/memcached_servers.rst @@ -2,43 +2,31 @@ Manipulate the server information stored in memcached_st ======================================================== +.. index:: object: memcached_st -Manage server list - - -******* -LIBRARY -******* +-------- +SYNOPSIS +-------- +#include + +.. c:function:: uint32_t memcached_server_count (memcached_st *ptr); -C Client Library for memcached (libmemcached, -lmemcached) +.. 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); --------- -SYNOPSIS --------- +.. 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:: memcached_server_instance_st memcached_server_by_key (const memcached_st *ptr, const char *key, size_t key_length, memcached_return_t *error); -.. code-block:: perl +.. c:function:: memcached_server_instance_st memcached_server_get_last_disconnect (const memcached_st *ptr) - #include - - uint32_t memcached_server_count (memcached_st *ptr); - - memcached_return_t memcached_server_add (memcached_st *ptr, const char *hostname, in_port_t port); - - memcached_return_t memcached_server_add_udp (memcached_st *ptr, const char *hostname, in_port_t port); - - memcached_return_t memcached_server_add_unix_socket (memcached_st *ptr, const char *socket); - - memcached_return_t memcached_server_push (memcached_st *ptr, const memcached_server_st *list); +.. c:function:: memcached_return_t memcached_server_cursor(const memcached_st *ptr, const memcached_server_fn *callback, void *context, uint32_t number_of_callbacks); - memcached_server_instance_st memcached_server_by_key (const memcached_st *ptr, const char *key, size_t key_length, memcached_return_t *error); - - memcached_server_instance_st memcached_server_get_last_disconnect (const memcached_st *ptr) - - 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 @@ -97,17 +85,17 @@ return from any callback will terminate the loop. memcached_server_cursor() is passed the original caller memcached_st in its current state. -****** +------ RETURN -****** +------ Varies, see particular functions. -**** +---- HOME -**** +---- To find out more information please check: