Updating documentation on consistent hashing.

[m6w6/libmemcached] / docs / memcached_servers.pod

diff --git a/docs/memcached_servers.pod b/docs/memcached_servers.pod
index 3e471bce1b6388b8ca83d17fb607aa6cc9b2bb95..2fbd1a6632ce7a2e119d623056a9cdd449fb4be7 100755 (executable)
--- a/docs/memcached_servers.pod
+++ b/docs/memcached_servers.pod
@@ -20,6 +20,11 @@ C Client Library for memcached (libmemcached, -lmemcached)
                           char *hostname,
                           unsigned int port);
 
                           char *hostname,
                           unsigned int port);
 

+  memcached_return
+    memcached_server_add_unix_socket (memcached_st *ptr,
+                                      char *hostname,
+                                      unsigned int port);
+

   memcached_return
     memcached_server_push (memcached_st *ptr,
                            memcached_server_st *list);
   memcached_return
     memcached_server_push (memcached_st *ptr,
                            memcached_server_st *list);


@@ -42,6 +47,11 @@ memcached_server_add() pushes a single server into the C<memcached_st>
 structure. This server will be placed at the end. Duplicate servers are
 allowed, so duplication is not checked.
 
 structure. This server will be placed at the end. Duplicate servers are
 allowed, so duplication is not checked.
 

+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.
+

 memcached_server_push() pushes an array of C<memcached_server_st> into
 the C<memcached_st> structure. These servers will be placed at the
 end. Duplicate servers are allowed, so duplication is not checked. A
 memcached_server_push() pushes an array of C<memcached_server_st> into
 the C<memcached_st> structure. These servers will be placed at the
 end. Duplicate servers are allowed, so duplication is not checked. A