X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fmemcached_server_st.rst;h=700ca51bca6067975e4af970b9cb0776625be221;hb=088eed04d829b8cf6591201564118c356d3cf935;hp=b1c5450150905dbc2804a4f2f607f9fa457f4017;hpb=c4dbc7e56b01545e25bc95ba122c79d4a2631a99;p=awesomized%2Flibmemcached diff --git a/docs/memcached_server_st.rst b/docs/memcached_server_st.rst index b1c54501..700ca51b 100644 --- a/docs/memcached_server_st.rst +++ b/docs/memcached_server_st.rst @@ -1,58 +1,36 @@ -.. highlight:: perl +========================= +Managing lists of servers +========================= -**** -NAME -**** - -memcached_server_list_free, memcached_server_list_append, -memcached_server_list_count, memcached_servers_parse - Manage server list - - -******* -LIBRARY -******* - - -C Client Library for memcached (libmemcached, -lmemcached) - - -******** +-------- SYNOPSIS -******** - +-------- -.. code-block:: perl - #include +#include - const memcached_server_instance_st - memcached_server_list (memcached_st *ptr); - - void memcached_server_list_free (memcached_server_list_st list); - - memcached_server_list_st - memcached_server_list_append (memcached_server_list_st list, - const char *hostname, - unsigned int port, - memcached_return_t *error); +.. c:function:: const memcached_server_instance_st memcached_server_list (memcached_st *ptr); + +.. c:function:: void memcached_server_list_free (memcached_server_list_st list); - uint32_t memcached_server_list_count (memcached_server_list_st list); +.. c:function:: memcached_server_list_st memcached_server_list_append (memcached_server_list_st list, const char *hostname, unsigned int port, memcached_return_t *error); - memcached_server_list_st memcached_servers_parse (const char *server_strings); +.. c:function:: uint32_t memcached_server_list_count (memcached_server_list_st list); - const char *memcached_server_error (memcached_server_instance_st instance); +.. c:function:: const char *memcached_server_error (memcached_server_instance_st instance); - DEPRECATED - void memcached_server_error_reset (memcached_server_instance_st list); +.. c:function:: void memcached_server_error_reset (memcached_server_instance_st list); DEPRECATED + +Compile and link with -lmemcached -*********** +----------- DESCRIPTION -*********** +----------- libmemcached(3) operates on a list of hosts which are stored in @@ -72,10 +50,7 @@ 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. -memcached_servers_parse() takes a string, the type that is used for the -command line applications, and parse it to an array of memcached_server_st. -The example is "localhost, foo:555, foo, bar". All hosts except foo:555 will -be set to the default port, while that host will have a port of 555. +DEPRECATED memcached_servers_parse(), please see :manpage:`memcached(3)` memcached_server_error() can be used to look at the text of the last error message sent by the server to to the client. @@ -85,35 +60,27 @@ memcached_server_st \* was aliased to 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. -**** +---- 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)`