32/64 bit cleanup issue in tests.

[awesomized/libmemcached] / docs / memcached_servers.pod

diff --git a/docs/memcached_servers.pod b/docs/memcached_servers.pod
index f4f789d4185938a8b9c5a7c64798a51f765c70d6..6ffd8e225aa90aed1c32e8a01bd97d705ac2b2d0 100644 (file)
--- 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,7 +10,7 @@ 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);
@@ -41,6 +41,12 @@ C Client Library for memcached (libmemcached, -lmemcached)
   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
 
@@ -90,6 +96,13 @@ 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.
@@ -97,7 +110,7 @@ Varies, see particular functions.
 =head1 HOME
 
 To find out more information please check:
-L<http://tangent.org/552/libmemcached.html>
+L<https://launchpad.net/libmemcached>
 
 =head1 AUTHOR