Fix for gcc 4.4 error.
[awesomized/libmemcached] / docs / memcached_server_st.pod
old mode 100755 (executable)
new mode 100644 (file)
index 32fb6ad..08ff778
@@ -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
 
@@ -9,17 +9,25 @@ C Client Library for memcached (libmemcached, -lmemcached)
 
 =head1 SYNOPSIS
 
-#include <memcached.h>
+  #include <memcached.h>
 
-void memcached_server_list_free(memcached_server_st *ptr);
-memcached_server_st *memcached_server_list_append(memcached_server_st *ptr, 
-                                             char *hostname, unsigned int port, 
-                                             memcached_return *error);
-unsigned int memcached_server_list_count(memcached_server_st *ptr);
-memcached_server_st *memcached_servers_parse(char *server_strings);
+  void memcached_server_list_free (memcached_server_st *ptr);
 
-=head1 DESCRIPTION
+  memcached_server_st *
+    memcached_server_list_append (memcached_server_st *ptr, 
+                                  const char *hostname,
+                                  unsigned int port, 
+                                  memcached_return *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
 memcached_server_st structures. You should not modify these structures
@@ -40,17 +48,24 @@ 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.
 
 =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
 
-Brian Aker, brian@tangent.org
+Brian Aker, E<lt>brian@tangent.orgE<gt>
 
 =head1 SEE ALSO