KBDocs2
[m6w6/libmemcached] / docs / memcached_servers.rst
index 2575a78c9be477a0aa28b56a4b681e0f33d2e6bc..5156b2a2c69e7c83e02b0f67a57c3f06045db21d 100644 (file)
@@ -2,43 +2,31 @@
 Manipulate the server information stored in memcached_st
 ========================================================
 
+.. index:: object: memcached_st
 
-Manage server list
-
-
-*******
-LIBRARY
-*******
+--------
+SYNOPSIS
+--------
 
+#include <libmemcached/memcached.h>
+.. c:function:: uint32_t memcached_server_count (memcached_st *ptr);
 
-C Client Library for memcached (libmemcached, -lmemcached)
+.. 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);
 
---------
-SYNOPSIS
---------
+.. 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:function:: memcached_server_instance_st memcached_server_by_key (const memcached_st *ptr, const char *key, size_t key_length, memcached_return_t *error);
 
-.. code-block:: perl
+.. c:function:: memcached_server_instance_st memcached_server_get_last_disconnect (const memcached_st *ptr)
 
-   #include <libmemcached/memcached.h>
-   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); 
+.. c:function:: memcached_return_t memcached_server_cursor(const memcached_st *ptr, const memcached_server_fn *callback, void *context, uint32_t number_of_callbacks);
 
-   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);
+compile and link with -lmemcached
 
 
 
@@ -97,21 +85,21 @@ 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 <https://launchpad.net/libmemcached>`_
+`http://libmemcached.org/ <http://libmemcached.org/>`_
 
 
 --------