Fix for connect() to invalidate socket on failure.

[m6w6/libmemcached] / docs / memcached_get.pod

diff --git a/docs/memcached_get.pod b/docs/memcached_get.pod
index 6de4b5eb4af15ed0402da032d13a2b218401b496..f87d47ba03cfb08bdc5862343072f2ef80428e39 100755 (executable)
--- a/docs/memcached_get.pod
+++ b/docs/memcached_get.pod
@@ -25,12 +25,31 @@ C Client Library for memcached (libmemcached, -lmemcached)
   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, 
                          size_t *value_length,
                          uint16_t *flags, 
                          memcached_return *error);
+  memcached_return 
+  memcached_fetch_execute(memcached_st *ptr, 
+                          unsigned int (*callback[])(memcached_st *ptr, memcached_result_st *result, void *context),
+                          void *context,
+                          unsigned int number_of_callbacks
+                         )
 
 =head1 DESCRIPTION
 
@@ -67,6 +86,21 @@ 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_fetch_execute() is a callback function for result sets. Instead
+of returning the results to you for processing, it passes each of the
+result sets to the list of functions you provide. It passes to the function
+a memcached_st that can be cloned for use in called the cluster (it can not 
+be used directly). It also passed a result set which does not need to be freed.
+Finally it passes a "context". This is just a pointer to a memory reference
+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_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.