This cleans up some accidental linking we were getting with curses.
[m6w6/libmemcached] / docs / memcached_stats.pod
index 26b0252f743418b8bbe5de581bd6fca5cb3df8a0..3b198d99633e6ec0f02372062f409ffae5d98fd2 100644 (file)
@@ -12,21 +12,29 @@ C Client Library for memcached (libmemcached, -lmemcached)
 
   memcached_stat_st *memcached_stat (memcached_st *ptr,
                                      char *args,
-                                     memcached_return *error);
-
-  memcached_return memcached_stat_servername (memcached_stat_st *stat,
-                                              char *args, 
-                                              char *hostname,
-                                              unsigned int port);
-
-  char *memcached_stat_get_value (memcached_st *ptr,
-                                  memcached_stat_st *stat, 
-                                  char *key,
-                                  memcached_return *error);
-
-  char ** memcached_stat_get_keys (memcached_st *ptr,
-                                   memcached_stat_st *stat, 
-                                   memcached_return *error);
+                                     memcached_return_t *error);
+
+  memcached_return_t memcached_stat_servername (memcached_stat_st *stat,
+                                                char *args, 
+                                                const char *hostname,
+                                                unsigned int port);
+
+  char *
+    memcached_stat_get_value (memcached_st *ptr,
+                              memcached_stat_st *stat, 
+                              const char *key,
+                              memcached_return_t *error);
+
+  char ** 
+    memcached_stat_get_keys (memcached_st *ptr,
+                             memcached_stat_st *stat, 
+                             memcached_return_t *error);
+
+  memcached_return_t
+    memcached_stat_execute (memcached_st *memc,
+                            const char *args,
+                            memcached_stat_fn func,
+                            void *context);
 
 =head1 DESCRIPTION
 
@@ -36,6 +44,12 @@ C<memcached_stat_st> structure. You are responsible for freeing this structure.
 While it is possible to access the structure directly it is not advisable.
 <memcached_stat_get_value() has been provided to query the structure.
 
+memcached_stat_execute() uses the servers found in C<memcached_stat_st> and 
+executes a "stat" command on each server. args is an optional argument that 
+can be passed in to modify the behavior of "stats". You will need to supply
+a callback function that will be supplied each pair of values returned by
+the memcached server.
+
 memcached_stat() fetches an array of C<memcached_stat_st> structures containing
 the state of all available memcached servers. The return value must be freed
 by the calling application. If called with the C<MEMCACHED_BEHAVIOR_USE_UDP>
@@ -68,7 +82,7 @@ memory allocated for it.
 =head1 HOME
 
 To find out more information please check:
-L<http://tangent.org/552/libmemcached.html>
+L<https://launchpad.net/libmemcached>
 
 =head1 AUTHOR