Fixed the support for DTrace so that it also builds on Mac OSX

[awesomized/libmemcached] / docs / memcached_servers.pod

diff --git a/docs/memcached_servers.pod b/docs/memcached_servers.pod
index 2fbd1a6632ce7a2e119d623056a9cdd449fb4be7..0e26e37d58e83938c55828854e7d514485e71175 100755 (executable)
--- a/docs/memcached_servers.pod
+++ b/docs/memcached_servers.pod
@@ -17,18 +17,22 @@ C Client Library for memcached (libmemcached, -lmemcached)
 
   memcached_return
     memcached_server_add (memcached_st *ptr,
-                          char *hostname,
+                          const char *hostname,
                           unsigned int port);
 
   memcached_return
     memcached_server_add_unix_socket (memcached_st *ptr,
-                                      char *hostname,
-                                      unsigned int port);
+                                      const char *socket);
 
   memcached_return
     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);
+
 =head1 DESCRIPTION
 
 libmemcached(3) performs operations on a list of hosts. The order of these
@@ -39,7 +43,7 @@ memcached_server_st(3).
 memcached_server_count() provides you a count of the current number of
 servers being used by a C<memcached_st> structure.
 
-memcached_server_list() is used to provide an array of all connected hosts.
+memcached_server_list() is used to provide an array of all defined hosts.
 You are responsible for freeing this list (aka it is not a pointer to the
 currently used structure).
 
@@ -58,6 +62,12 @@ 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.
 
+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_free().
+
 =head1 RETURN
 
 Varies, see particular functions.