Fix Trond's email address.
[awesomized/libmemcached] / docs / memcached_server_st.pod
index b0a20d8c9a18f1f9db56e6be2acdd23d6fe9b054..32d4e1e98344b014e88fae9564707b3f9dfd9c69 100644 (file)
@@ -1,7 +1,7 @@
 =head1 NAME
 
 memcached_server_list_free, memcached_server_list_append,
-memcached_server_list_count, memcached_servers_parse
+memcached_server_list_count, memcached_servers_parse - Manage server list
 
 =head1 LIBRARY
 
@@ -17,12 +17,16 @@ C Client Library for memcached (libmemcached, -lmemcached)
     memcached_server_list_append (memcached_server_st *ptr, 
                                   const char *hostname,
                                   unsigned int port, 
-                                  memcached_return *error);
+                                  memcached_return_t *error);
 
   unsigned int memcached_server_list_count (memcached_server_st *ptr);
 
   memcached_server_st *memcached_servers_parse (const char *server_strings);
 
+  const char *memcached_server_error (memcached_server_st *ptr);
+
+  void memcached_server_error_reset (memcached_server_st *ptr);
+
 =head1 DESCRIPTION
 
 libmemcached(3) operates on a list of hosts which are stored in
@@ -35,7 +39,7 @@ of memcached_server_st that you passed to it.
 
 memcached_server_list_append() adds a server to the end of a
 memcached_server_st array. On error null will be returned and the
-memcached_return pointer you passed into the function will be set with the
+memcached_return_t pointer you passed into the function will be set with the
 appropriate error. If the value of port is zero, it is set to the default
 port of a memcached server.
 
@@ -44,6 +48,12 @@ command line applications, and parse it to an array of memcached_server_st.
 The example is "localhost, foo:555, foo, bar". All hosts except foo:555 will
 be set to the default port, while that host will have a port of 555.
 
+memcached_server_error() can be used to look at the text of the last error 
+message sent by the server to to the client. Use memcached_server_error_reset() 
+to reset the message (this does not currently free up the memory associated
+with the message).
+
+
 =head1 RETURN
 
 Varies, see particular functions.
@@ -51,7 +61,7 @@ Varies, see particular functions.
 =head1 HOME
 
 To find out more information please check:
-L<http://tangent.org/552/libmemcached.html>
+L<https://launchpad.net/libmemcached>
 
 =head1 AUTHOR