Merge Padraig

[awesomized/libmemcached] / docs / memcached_servers.pod

diff --git a/docs/memcached_servers.pod b/docs/memcached_servers.pod
old mode 100755 (executable)
new mode 100644 (file)
index 3e471bc..125e1f4
--- a/docs/memcached_servers.pod
+++ b/docs/memcached_servers.pod
@@ -1,6 +1,6 @@
 =head1 NAME
 
 =head1 NAME
 

-memcached_server_count, memcached_server_list, memcached_server_add, memcached_server_push
+memcached_server_count, memcached_server_list, memcached_server_add, memcached_server_push - Manage server list

 
 =head1 LIBRARY
 
 
 =head1 LIBRARY
 


@@ -17,13 +17,27 @@ C Client Library for memcached (libmemcached, -lmemcached)
 
   memcached_return
     memcached_server_add (memcached_st *ptr,
 
   memcached_return
     memcached_server_add (memcached_st *ptr,

-                          char *hostname,
+                          const char *hostname,

                           unsigned int port);
 
                           unsigned int port);
 

+  memcached_return
+    memcached_server_add_udp (memcached_st *ptr,
+                          const char *hostname,
+                          unsigned int port);
+
+  memcached_return
+    memcached_server_add_unix_socket (memcached_st *ptr,
+                                      const 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);
 

+  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
 =head1 DESCRIPTION
 
 libmemcached(3) performs operations on a list of hosts. The order of these


@@ -34,13 +48,26 @@ 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).
 

-memcached_server_add() pushes a single server into the C<memcached_st>
+memcached_server_add() pushes a single TCP server into the C<memcached_st>
+structure. This server will be placed at the end. Duplicate servers are
+allowed, so duplication is not checked. Executing this function with the
+C<MEMCACHED_BEHAVIOR_USE_UDP> behavior set will result in a 
+C<MEMCACHED_INVALID_HOST_PROTOCOL>.
+
+memcached_server_add_udp() pushes a single UDP server into the C<memcached_st>

 structure. This server will be placed at the end. Duplicate servers are
 structure. This server will be placed at the end. Duplicate servers are

-allowed, so duplication is not checked.
+allowed, so duplication is not checked. Executing this function with out
+setting the C<MEMCACHED_BEHAVIOR_USE_UDP> behavior will result in a 
+C<MEMCACHED_INVALID_HOST_PROTOCOL>.
+
+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
 
 memcached_server_push() pushes an array of C<memcached_server_st> into
 the C<memcached_st> structure. These servers will be placed at the


@@ -48,6 +75,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.
 
 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.
 =head1 RETURN
 
 Varies, see particular functions.