Merge in docs.
[awesomized/libmemcached] / docs / memcached_servers.rst
index e280071d56467e0e93775e16beb4db16e19481dc..72da276496b5db9be99e7b3500d11066e27c4c95 100644 (file)
@@ -38,52 +38,43 @@ DESCRIPTION
 :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
-:c:type:`memcached_server_st()`.
-
-:c:func:`memcached_server_count()` provides you a count of the current
-number of 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`.
-
-: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 :c:type:`MEMCACHED_INVALID_HOST_PROTOCOL`.
-
-:c:func:`memcached_server_add_unix_socket()` pushes a single UNIX socket
-into the :c:type:`memcached_st`  structure. This UNIX socket will be placed
-at the end.  Duplicate servers are allowed, so duplication is not checked.
-The length of the filename must be one character less then
-:c:macro:`MEMCACHED_MAX_HOST_LENGTH`.
-
-:c:func:`memcached_server_push()` pushes an array of
-:c:type:`memcached_server_st` into the :c:type:`memcached_st` structure.
-These servers will be placed at the end.  Duplicate servers are allowed, so
-duplication is not checked. A 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
+memcached_server_st(3).
+
+:c:func:`memcached_server_count()` provides you a count of the current number of
+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`.
+
+: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
+:c:type:`MEMCACHED_INVALID_HOST_PROTOCOL`.
+
+:c:func:`memcached_server_add_unix_socket()` pushes a single UNIX socket into the :c:type:`memcached_st` structure. This UNIX socket will be placed at the end.
+Duplicate servers are allowed, so duplication is not checked. The length
+of the filename must be one character less than :c:type:`MEMCACHED_MAX_HOST_LENGTH`.
+
+:c:func:`memcached_server_push()` pushes an array of :c:type:`memcached_server_st` into the :c:type:`memcached_st` structure. These servers will be placed at 
+the end. Duplicate servers are allowed, so duplication is not checked. A
+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()`.
 
-: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
-particular server is currently dead but if the library is reporting a server
+: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 
+particular server is currently dead but if the library is reporting a server 
 is, the returned server is a very good candidate.
 
-:c:func:`memcached_server_cursor()` takes a memcached_st and loops through
-the list of hosts currently in the cursor calling the list of callback
-functions provided. You can optionally pass in a value via context which
-will be provided to each callback function. An error return from any
-callback will terminate the loop. :c:func:`memcached_server_cursor()` is
-passed the original caller memcached_st in its current state.
+:c:func:`memcached_server_cursor()` takes a memcached_st and loops through the 
+list of hosts currently in the cursor calling the list of callback 
+functions provided. You can optionally pass in a value via 
+context which will be provided to each callback function. An error
+return from any callback will terminate the loop. :c:func:`memcached_server_cursor()` is passed the original caller :c:type:`memcached_st` in its current state.
 
 
 ------