X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fmemcached_servers.rst;h=6ec518148cd300ac8e41cb2b6ea1481ffb98962a;hb=9f133ef77f22b1d525e5160c094454b04ee906ad;hp=7331dbdddb21cf796b13a5c66780f17246b5552d;hpb=16ba6539e831e2abcef9dcf56fa26e3a0d5c7f91;p=m6w6%2Flibmemcached diff --git a/docs/memcached_servers.rst b/docs/memcached_servers.rst index 7331dbdd..6ec51814 100644 --- a/docs/memcached_servers.rst +++ b/docs/memcached_servers.rst @@ -2,29 +2,29 @@ Manipulate the server information stored in memcached_st ======================================================== -.. index:: object: memcached_st - --------- -SYNOPSIS +-------- +SYNOPSIS -------- #include -.. c:function:: uint32_t memcached_server_count (memcached_st *ptr); +.. c:type:: memcached_server_fn -.. c:function:: memcached_return_t memcached_server_add (memcached_st *ptr, const char *hostname, in_port_t port); +.. c:function:: uint32_t memcached_server_count (memcached_st *ptr) -.. 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 (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_add_udp (memcached_st *ptr, const char *hostname, in_port_t port) -.. c:function:: memcached_return_t memcached_server_push (memcached_st *ptr, const memcached_server_st *list); +.. c:function:: memcached_return_t memcached_server_add_unix_socket (memcached_st *ptr, const char *socket) -.. 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_return_t memcached_server_push (memcached_st *ptr, const memcached_server_st *list) + +.. c:function:: memcached_server_instance_st memcached_server_by_key (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) -.. c:function:: memcached_return_t memcached_server_cursor(const memcached_st *ptr, const memcached_server_fn *callback, void *context, uint32_t number_of_callbacks); +.. 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 @@ -35,8 +35,8 @@ DESCRIPTION ----------- -libmemcached(3) performs operations on a list of hosts. The order of these -hosts determine routing to keys. Functions are provided to add keys to +: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). @@ -44,9 +44,7 @@ memcached_server_st(3). 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`. + 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 @@ -62,10 +60,7 @@ 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. This structure is cloned -from its original structure and must be freed. If NULL is returned you -should consult \*error. The returning structure should be freed with -:c:func:`memcached_server_free()`. +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