projects / awesomized / libmemcached / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree | github
raw | inline | side by side
Remove exposed C++ namespace.
[awesomized/libmemcached] / docs / memcached_server_st.rst
diff --git a/docs/memcached_server_st.rst b/docs/memcached_server_st.rst
index c45abbb2b818c16de70dbefbd3ef480b8c52d072..6300879576f77ff8eb52d66760b7a72065e7775a 100644 (file)
--- a/docs/memcached_server_st.rst
+++ b/docs/memcached_server_st.rst
@@ -1,117 +1,89 @@
-.. highlight:: perl
+=========================
+Managing lists of servers
+=========================
 
 
 
 
-memcached_server_list_free, memcached_server_list_append, memcached_server_list_count, memcached_servers_parse
-**************************************************************************************************************
-
-
-Manage server list
-
-
-*******
-LIBRARY
-*******
+--------
+SYNOPSIS
+--------
 
 
 
 
-C Client Library for memcached (libmemcached, -lmemcached)
 
 
+#include <libmemcached/memcached.h>
 
 
-********
-SYNOPSIS
-********
+.. c:type:: const memcached_instance_st *
 
 
+.. c:type:: memcached_server_list_st
 
 
+.. c:type:: memcached_server_st
 
 
-.. code-block:: perl
+.. c:function:: const const memcached_instance_st * memcached_server_list (memcached_st *ptr)
 
 
-   #include <memcached.h>
- 
-   const memcached_server_instance_st
-     memcached_server_list (memcached_st *ptr);
+.. c:function:: void memcached_server_list_free (memcached_server_list_st list)
  
  
-   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)
  
  
-   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:: uint32_t memcached_server_list_count (memcached_server_list_st list)
  
  
-   uint32_t memcached_server_list_count (memcached_server_list_st list);
+.. c:function:: const char *memcached_server_error (const memcached_instance_st * instance)
  
  
-   memcached_server_list_st memcached_servers_parse (const char *server_strings);
- 
-   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 (const memcached_instance_st * list)
+.. deprecated:: 0.39
+   
+.. c:function:: void memcached_servers_parse ()
+.. deprecated:: 0.39
 
 
+Compile and link with -lmemcached
 
 
 
 
-***********
+-----------
 DESCRIPTION
 DESCRIPTION
-***********
+-----------
 
 
 libmemcached(3) operates on a list of hosts which are stored in
 
 
 libmemcached(3) operates on a list of hosts which are stored in
-memcached_server_st structures. You should not modify these structures
+: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!).
 
 directly. Functions are provided to modify these structures (and more can be
 added, just ask!).
 
-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` is used to provide an array of all defined hosts. This was incorrectly documented as "requiring free" up till version 0.39.
 
 
-memcached_server_list_free() deallocates all memory associated with the array
-of memcached_server_st that you passed to it.
+:c:func:`memcached_server_list_free` deallocates all memory associated with the array of :c:type:`memcached_server_st` that you passed to it.
 
 
-memcached_server_list_append() adds a server to the end of a
-memcached_server_st array. On error null will be returned and the
-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
+: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.
 
 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 :c:func:`memcached_servers_parse`, please see :c:func:`memcached`
 
 
-memcached_server_error() can be used to look at the text of the last error 
-message sent by the server to to the client.
+: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 memcache_server_st \*. In 0.39
 
 Before version 0.39 theses functions used a memcache_server_st \*. In 0.39
-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.
+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
 RETURN
-******
+------
 
 
 Varies, see particular functions.
 
 
 
 
 Varies, see particular functions.
 
 
-****
+----
 HOME
 HOME
-****
+----
 
 
 To find out more information please check:
 
 
 To find out more information please check:
-`https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
-
+`http://libmemcached.org/ <http://libmemcached.org/>`_
 
 
-******
-AUTHOR
-******
 
 
 
 
-Brian Aker, <brian@tangent.org>
-
-
-********
+--------
 SEE ALSO
 SEE ALSO
-********
-
+--------
 
 
-memcached(1) libmemcached(3) memcached_strerror(3)
 
 
+:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
Resurrection of libmemcached