Merged Jean-Charles Redoutey

[awesomized/libmemcached] / docs / memcached_get.pod

diff --git a/docs/memcached_get.pod b/docs/memcached_get.pod
old mode 100755 (executable)
new mode 100644 (file)
index 0a2edee..1fe7298
--- a/docs/memcached_get.pod
+++ b/docs/memcached_get.pod
@@ -1,6 +1,6 @@
 =head1 NAME
 
-memcached_get, memcached_mget, memcached_fetch
+memcached_get, memcached_mget, memcached_fetch - Get a value
 
 =head1 LIBRARY
 
@@ -24,7 +24,7 @@ C Client Library for memcached (libmemcached, -lmemcached)
   memcached_return
   memcached_mget (memcached_st *ptr, 
                   char **keys, size_t *key_length, 
-                  unsigned int number_of_keys);
+                  size_t number_of_keys);
   char *
   memcached_get_by_key(memcached_st *ptr, 
                        const char *master_key, size_t master_key_length, 
@@ -37,7 +37,7 @@ C Client Library for memcached (libmemcached, -lmemcached)
   memcached_mget_by_key(memcached_st *ptr, 
                         const char *master_key, size_t master_key_length,
                         char **keys, size_t *key_length, 
-                        unsigned int number_of_keys);
+                        size_t number_of_keys);
 
   char *memcached_fetch (memcached_st *ptr,
                          char *key, size_t *key_length, 
@@ -104,6 +104,12 @@ 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.
 
+All of the above functions are not supported when the C<MEMCACHED_BEHAVIOR_USE_UDP>
+has been set. Executing any of these functions with this behavior on will result in 
+C<MEMCACHED_NOT_SUPPORTED> being returned or, for those functions which do not return
+a C<memcached_return>, the error function parameter will be set to 
+C<MEMCACHED_NOT_SUPPORTED>.
+
 =head1 RETURN
 
 All objects returned must be freed by the calling application.