X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fmemcached_servers.pod;h=6ffd8e225aa90aed1c32e8a01bd97d705ac2b2d0;hb=e7561db4b56f2e78948710a0f360f65f5703a8e6;hp=a4495382683a7c32e89311e28e6fbe1f7746c320;hpb=07999ea4e52b8a80ea66376ec22768c32add7f29;p=m6w6%2Flibmemcached

diff --git a/docs/memcached_servers.pod b/docs/memcached_servers.pod
index a4495382..6ffd8e22 100644
--- a/docs/memcached_servers.pod
+++ b/docs/memcached_servers.pod
@@ -1,6 +1,6 @@
 =head1 NAME
 
-memcached_server_count, memcached_server_list, memcached_server_add, memcached_server_push, memcached_server_get_last_disconnect - Manage server list
+memcached_server_count, memcached_server_list, memcached_server_add, memcached_server_push, memcached_server_get_last_disconnect, memcached_server_cursor - Manage server list
 
 =head1 LIBRARY
 
@@ -10,36 +10,43 @@ C Client Library for memcached (libmemcached, -lmemcached)
 
   #include <memcached.h>
 
-  unsigned int memcached_server_count (memcached_st *ptr);
+  uint32_t memcached_server_count (memcached_st *ptr);
 
   memcached_server_st *
     memcached_server_list (memcached_st *ptr);
 
-  memcached_return
+  memcached_return_t
     memcached_server_add (memcached_st *ptr,
                           const char *hostname,
-                          unsigned int port);
+                          in_port_t port);
 
-  memcached_return
+  memcached_return_t
     memcached_server_add_udp (memcached_st *ptr,
                           const char *hostname,
-                          unsigned int port);
+                          in_port_t port);
 
-  memcached_return
+  memcached_return_t
     memcached_server_add_unix_socket (memcached_st *ptr,
                                       const char *socket);
 
-  memcached_return
+  memcached_return_t
     memcached_server_push (memcached_st *ptr,
                            memcached_server_st *list);
 
   memcached_server_st *
-    memcached_server_by_key (memcached_st *ptr,  
-                             const char *key, size_t key_length, 
-                             memcached_return *error);
-  memcached_server_st *                          
+    memcached_server_by_key (memcached_st *ptr,
+                             const char *key, size_t key_length,
+                             memcached_return_t *error);
+
+  memcached_server_st *
     memcached_server_get_last_disconnect (memcached_st *ptr)
-    
+
+  memcached_return_t
+    memcached_server_cursor(memcached_st *ptr,
+                           memcached_server_fn *callback,
+                           void *context,
+                           uint32_t number_of_callbacks);
+
 
 =head1 DESCRIPTION
 
@@ -58,17 +65,17 @@ currently used structure).
 memcached_server_add() pushes a single TCP server into the C<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<MEMCACHED_BEHAVIOR_USE_UDP> behavior set will result in a 
+C<MEMCACHED_BEHAVIOR_USE_UDP> behavior set will result in a
 C<MEMCACHED_INVALID_HOST_PROTOCOL>.
 
 memcached_server_add_udp() pushes a single UDP server into the C<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<MEMCACHED_BEHAVIOR_USE_UDP> behavior will result in a 
+setting the C<MEMCACHED_BEHAVIOR_USE_UDP> behavior will result in a
 C<MEMCACHED_INVALID_HOST_PROTOCOL>.
 
-memcached_server_add_unix_socket() pushes a single UNIX socket into the 
-C<memcached_st> structure. This UNIX socket will be placed at the end. 
+memcached_server_add_unix_socket() pushes a single UNIX socket into the
+C<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 MEMCACHED_MAX_HOST_LENGTH.
 
@@ -84,19 +91,26 @@ 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_free().
 
-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, 
+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.
 
+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. memcached_server_cursor()
+is passed the original caller memcached_st in its current state. 
+
 =head1 RETURN
 
 Varies, see particular functions.
 
 =head1 HOME
 
-To find out more information please check: 
-L<http://tangent.org/552/libmemcached.html>
+To find out more information please check:
+L<https://launchpad.net/libmemcached>
 
 =head1 AUTHOR