Style cleanup
[awesomized/libmemcached] / docs / memcached_servers.pod
index 125e1f4b1ba169c33d6fa3c7df885fd3fe2305f9..80241c6afc559fe2d0ddaf07de2b2fc67011667b 100644 (file)
@@ -1,6 +1,6 @@
 =head1 NAME
 
-memcached_server_count, memcached_server_list, memcached_server_add, memcached_server_push - Manage server list
+memcached_server_count, memcached_server_list, memcached_server_add, memcached_server_push, memcached_server_get_last_disconnect - Manage server list
 
 =head1 LIBRARY
 
@@ -15,28 +15,32 @@ C Client Library for memcached (libmemcached, -lmemcached)
   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_return_t *error);
+
+  memcached_server_st *                          
+    memcached_server_get_last_disconnect (memcached_st *ptr)
+    
 
 =head1 DESCRIPTION
 
@@ -81,6 +85,11 @@ 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, 
+the returned server is a very good candidate.
+
 =head1 RETURN
 
 Varies, see particular functions.