Fixed mget_execute possibly failing into some non ending recursive call

[m6w6/libmemcached] / docs / memcached_get.pod

diff --git a/docs/memcached_get.pod b/docs/memcached_get.pod
index 4c80fb3e4e73db30ba6cf36f07c28db4af7ca7ab..db2c9b5ae9d8295b665bf1c0fd18758366d42b9a 100644 (file)
--- a/docs/memcached_get.pod
+++ b/docs/memcached_get.pod
@@ -1,6 +1,7 @@
 =head1 NAME
 
-memcached_get, memcached_mget, memcached_fetch - Get a value
+memcached_get, memcached_mget, memcached_fetch, memcached_mget_execute,
+memcached_mget_execute_by_key - Get a value
 
 =head1 LIBRARY
 
@@ -23,7 +24,8 @@ C Client Library for memcached (libmemcached, -lmemcached)
 
   memcached_return
   memcached_mget (memcached_st *ptr, 
-                  char **keys, size_t *key_length, 
+                  const char * const *keys, 
+                  const size_t *key_length, 
                   size_t number_of_keys);
   char *
   memcached_get_by_key(memcached_st *ptr, 
@@ -36,7 +38,8 @@ C Client Library for memcached (libmemcached, -lmemcached)
   memcached_return 
   memcached_mget_by_key(memcached_st *ptr, 
                         const char *master_key, size_t master_key_length,
-                        char **keys, size_t *key_length, 
+                        const char * const *keys, 
+                        const size_t *key_length, 
                         size_t number_of_keys);
 
   char *memcached_fetch (memcached_st *ptr,
@@ -52,17 +55,26 @@ C Client Library for memcached (libmemcached, -lmemcached)
                           unsigned int number_of_callbacks);
 
 
-  memcached_return 
+  memcached_return
   memcached_mget_execute(memcached_st *ptr,
-                         const char *master_key,
-                         size_t master_key_length,
-                         const char **keys,
-                         size_t *key_length,
+                         const char * const *keys,
+                         const size_t *key_length,
                          size_t number_of_keys,
                          memcached_execute_function *callback,
                          void *context,
                          unsigned int number_of_callbacks);
 
+  memcached_return 
+  memcached_mget_execute_by_key(memcached_st *ptr,
+                                const char *master_key,
+                                size_t master_key_length,
+                                const char * const *keys,
+                                const size_t *key_length,
+                                size_t number_of_keys,
+                                memcached_execute_function *callback,
+                                void *context,
+                                unsigned int number_of_callbacks);
+
 
 =head1 DESCRIPTION
 
@@ -113,14 +125,15 @@ you supply the calling function. Currently only one value is being passed
 to each function call. In the future there will be an option to allow this
 to be an array.
 
-memcached_mget_execute() is similar to memcached_mget(), but it may trigger
-the supplied callbacks with result sets while sending out the queries. If
-you try to perform a really large multiget with memcached_mget() you may
-encounter a deadlock in the OS kernel (we fail to write data to the socket
-because the input buffer is full). memcached_mget_execute() solves this
-problem by processing some of the results before continuing sending out
-requests. Please note that this function is only available in the binary
-protocol.
+memcached_mget_execute() and memcached_mget_execute_by_key() is
+similar to memcached_mget(), but it may trigger the supplied callbacks
+with result sets while sending out the queries. If you try to perform
+a really large multiget with memcached_mget() you may encounter a
+deadlock in the OS kernel (we fail to write data to the socket because
+the input buffer is full). memcached_mget_execute() solves this
+problem by processing some of the results before continuing sending
+out requests. Please note that this function is only available in the
+binary protocol.
 
 memcached_get_by_key() and memcached_mget_by_key() behave in a similar nature
 as memcached_get() and memcached_mget(). The difference is that they take