X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fmemcached_servers.rst;h=5156b2a2c69e7c83e02b0f67a57c3f06045db21d;hb=1056271e7a25406f0a118faeebeb67decf1c243b;hp=d7aa521dfcee33ad058580756f3ca38266c7d01d;hpb=f285e1b3821f56a8983b5ce9fb1a0070e7bb0a1c;p=m6w6%2Flibmemcached diff --git a/docs/memcached_servers.rst b/docs/memcached_servers.rst index d7aa521d..5156b2a2 100644 --- a/docs/memcached_servers.rst +++ b/docs/memcached_servers.rst @@ -1,71 +1,38 @@ -.. highlight:: perl +======================================================== +Manipulate the server information stored in memcached_st +======================================================== +.. index:: object: memcached_st -memcached_server_count, memcached_server_list, memcached_server_add, memcached_server_push, memcached_server_get_last_disconnect, memcached_server_cursor -********************************************************************************************************************************************************* +-------- +SYNOPSIS +-------- +#include + +.. c:function:: uint32_t memcached_server_count (memcached_st *ptr); -Manage server list +.. 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); -******* -LIBRARY -******* +.. 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 Client Library for memcached (libmemcached, -lmemcached) +.. 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); +.. c:function:: memcached_server_instance_st memcached_server_get_last_disconnect (const memcached_st *ptr) -******** -SYNOPSIS -******** +.. 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 -.. code-block:: perl - #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); - - 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); - - - -*********** +----------- DESCRIPTION -*********** +----------- libmemcached(3) performs operations on a list of hosts. The order of these @@ -118,35 +85,26 @@ 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: -`https://launchpad.net/libmemcached `_ - +`http://libmemcached.org/ `_ -****** -AUTHOR -****** - -Brian Aker, - - -******** +-------- SEE ALSO -******** - +-------- -memcached(1) libmemcached(3) memcached_strerror(3) +:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`