MEMCACHED_BEHAVIOR_CONNECT_TIMEOUT added from Marcelo's patch to make sure

[awesomized/libmemcached] / docs / memcached_servers.pod

diff --git a/docs/memcached_servers.pod b/docs/memcached_servers.pod
index 3e471bce1b6388b8ca83d17fb607aa6cc9b2bb95..d417dfd15aa3555ee8ad2c5c6acaf73ef49bb97c 100755 (executable)
--- a/docs/memcached_servers.pod
+++ b/docs/memcached_servers.pod
@@ -20,6 +20,10 @@ 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 *socket);
+

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


@@ -34,7 +38,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_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).
 
 You are responsible for freeing this list (aka it is not a pointer to the
 currently used structure).
 


@@ -42,6 +46,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