Suggested change from Antony

[m6w6/libmemcached] / docs / memcached_get.pod

diff --git a/docs/memcached_get.pod b/docs/memcached_get.pod
index 1c95ec38ca22d3ce32234d52199fb09797987033..111a3b614d381234ea0527aefb4da701d7222433 100755 (executable)
--- a/docs/memcached_get.pod
+++ b/docs/memcached_get.pod
@@ -10,6 +10,11 @@ C Client Library for memcached (libmemcached, -lmemcached)
 
   #include <memcached.h>
 
+  memcached_result_st *
+  memcached_fetch_result(memcached_st *ptr, 
+                      memcached_result_st *result,
+                      memcached_return *error);
+
   char *memcached_get (memcached_st *ptr,
                        char *key, size_t key_length,
                        size_t *value_length, 
@@ -17,9 +22,22 @@ C Client Library for memcached (libmemcached, -lmemcached)
                        memcached_return *error);
 
   memcached_return
-    memcached_mget (memcached_st *ptr, 
-                    char **keys, size_t *key_length, 
-                    unsigned int number_of_keys);
+  memcached_mget (memcached_st *ptr, 
+                  char **keys, size_t *key_length, 
+                  unsigned int number_of_keys);
+  char *
+  memcached_get_by_key(memcached_st *ptr, 
+                       char *master_key, size_t master_key_length, 
+                       char *key, size_t key_length, 
+                       size_t *value_length, 
+                       uint16_t *flags,
+                       memcached_return *error);
+
+  memcached_return 
+  memcached_mget_by_key(memcached_st *ptr, 
+                        char *master_key, size_t master_key_length,
+                        char **keys, size_t *key_length, 
+                        unsigned int number_of_keys);
 
   char *memcached_fetch (memcached_st *ptr,
                          char *key, size_t *key_length, 
@@ -40,7 +58,12 @@ upon success and NULL will be returned on failure.
 memcached_mget() is used to select multiple keys at once. For multiple key
 operations it is always faster to use this function. This function always
 works asynchronously. memcached_fetch() is then used to retrieve any keys
-found. No error is given on keys that are not found.
+found. No error is given on keys that are not found. You must call either
+memcached_fetch() or memcached_fetch_result() after a successful call to
+memcached_mget(). You should continue to call these functions until they
+return NULL (aka no more values). If you need to quit in the middle of a
+memcached_get() call, execute a memcached_quit(). After you do this, you can
+issue new queries against the server.
 
 memcached_fetch() is used to fetch an individual value from the server. 
 memcached_mget() must always be called before using this method.  You
@@ -51,6 +74,17 @@ a size_t pointer which will be filled with size of of the object, and a
 memcached_return pointer to hold any error. The object will be returned
 upon success and NULL will be returned on failure. 
 
+memcached_fetch_result() is used to return a memcached_result_st(3) structure 
+from a memcached server. The result object is forward compatible with changes
+to the server. For more information please refer to the memcached_result_st(3) 
+help. This function will dynamically allocate a result structure for you
+if you do not pass one to the function.
+
+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
+a master key that is used for determining which server an object was stored
+if key partitioning was used for storage.
+
 =head1 RETURN
 
 All objects returned must be freed by the calling application.