Tagging version 0.21 for release

[awesomized/libmemcached] / docs / memcached_get.pod

diff --git a/docs/memcached_get.pod b/docs/memcached_get.pod
index 1cf0a60ca053443c9e6d41f627e25883ce17069d..df0ac7799ee985f3e85e37edbc89e2c3c9cfde9d 100755 (executable)
--- a/docs/memcached_get.pod
+++ b/docs/memcached_get.pod
@@ -16,7 +16,7 @@ C Client Library for memcached (libmemcached, -lmemcached)
                       memcached_return *error);
 
   char *memcached_get (memcached_st *ptr,
-                       char *key, size_t key_length,
+                       const char *key, size_t key_length,
                        size_t *value_length, 
                        uint32_t *flags,
                        memcached_return *error);
@@ -27,26 +27,26 @@ C Client Library for memcached (libmemcached, -lmemcached)
                   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, 
+                       const char *master_key, size_t master_key_length, 
+                       const char *key, size_t key_length, 
                        size_t *value_length, 
                        uint32_t *flags,
                        memcached_return *error);
 
   memcached_return 
   memcached_mget_by_key(memcached_st *ptr, 
-                        char *master_key, size_t master_key_length,
+                        const 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, 
+                         const char *key, size_t *key_length, 
                          size_t *value_length,
                          uint32_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),
+                          memcached_return (*callback[])(memcached_st *ptr, memcached_result_st *result, void *context),
                           void *context,
                           unsigned int number_of_callbacks);
 
@@ -58,7 +58,8 @@ three pointer variables which will give you the state of the returned
 object.  A uint32_t pointer to contain whatever flags you stored with the value,
 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. 
+upon success and NULL will be returned on failure. Any object returned by
+memcached_get() must be released by the caller application. 
 
 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
@@ -77,7 +78,10 @@ three pointer variables which will give you the state of the returned
 object.  A uint32_t pointer to contain whatever flags you stored with the value,
 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. 
+upon success and NULL will be returned on failure. MEMCACHD_END is returned
+by the *error value when all objects that have been found are returned. 
+The final value upon MEMCACHED_END is null. Values returned by
+memcached_fetch() musted be free'ed by the caller.
 
 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