Fix for config to not be stored into filesystem.

[awesomized/libmemcached] / docs / memcached_servers.pod

diff --git a/docs/memcached_servers.pod b/docs/memcached_servers.pod
index 3eace72e4448168d7a9499d91d697aa2ac14a294..0e26e37d58e83938c55828854e7d514485e71175 100755 (executable)
--- a/docs/memcached_servers.pod
+++ b/docs/memcached_servers.pod
@@ -8,35 +8,65 @@ C Client Library for memcached (libmemcached, -lmemcached)
 
 =head1 SYNOPSIS
 
 
 =head1 SYNOPSIS
 

-#include <memcached.h>
+  #include <memcached.h>

 
 

-unsigned int memcached_server_count(memcached_st *ptr);
-memcached_server_st *memcached_server_list(memcached_st *ptr);
-memcached_return memcached_server_add(memcached_st *ptr, char *hostname, unsigned int port);
-memcached_return memcached_server_push(memcached_st *ptr, memcached_server_st *list);
+  unsigned int memcached_server_count (memcached_st *ptr);

 
 

-=head1 DESCRIPTION
+  memcached_server_st *
+    memcached_server_list (memcached_st *ptr);
+
+  memcached_return
+    memcached_server_add (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_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
 hosts determine routing to keys. Functions are provided to add keys to
 
 libmemcached(3) performs operations on a list of hosts. The order of these
 hosts determine routing to keys. Functions are provided to add keys to

-memcached_st structures. To manipulate lists of servers see server_st(3).
+memcached_st structures. To manipulate lists of servers see
+memcached_server_st(3).

 
 memcached_server_count() provides you a count of the current number of
 
 memcached_server_count() provides you a count of the current number of

-servers being used by a memcached_st structure.
+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 memcached_st
+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_push() pushes an array of memcached_server_st into the memcached_st
-structure. These servers will be placed at the 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_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
+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
 
 
 =head1 RETURN
 


@@ -44,11 +74,12 @@ Varies, see particular functions.
 
 =head1 HOME
 
 
 =head1 HOME
 

-To find out more information please check: http://tangent.org/552/libmemcached.html
+To find out more information please check: 
+L<http://tangent.org/552/libmemcached.html>

 
 =head1 AUTHOR
 
 
 =head1 AUTHOR
 

-Brian Aker, brian@tangent.org
+Brian Aker, E<lt>brian@tangent.orgE<gt>

 
 =head1 SEE ALSO
 
 
 =head1 SEE ALSO