Updating the mget function in the C++ interface to take a std::vector of

[awesomized/libmemcached] / docs / memcached_callback.pod

diff --git a/docs/memcached_callback.pod b/docs/memcached_callback.pod
old mode 100755 (executable)
new mode 100644 (file)
index e1b2fb1..6eba4f3
--- a/docs/memcached_callback.pod
+++ b/docs/memcached_callback.pod
@@ -1,6 +1,6 @@
 =head1 NAME
 
 =head1 NAME
 

-memcached_callback_get memcached_callback_set
+memcached_callback_get, memcached_callback_set - Get and set a callback

 
 =head1 LIBRARY
 
 
 =head1 LIBRARY
 


@@ -51,9 +51,10 @@ point of its execution all connections have been closed.
 
 You can set a value which will be used to create a domain for your keys.
 The value specified here will be prefixed to each of your keys. The value can not
 
 You can set a value which will be used to create a domain for your keys.
 The value specified here will be prefixed to each of your keys. The value can not

-be greater then MEMCACHED_PREFIX_KEY_MAX_SIZE and will reduce MEMCACHED_MAX_KEY by
+be greater then MEMCACHED_PREFIX_KEY_MAX_SIZE - 1 and will reduce MEMCACHED_MAX_KEY by

 the value of your key. The prefix key is only applied to the primary key,
 the value of your key. The prefix key is only applied to the primary key,

-not the master key.
+not the master key. MEMCACHED_FAILURE will be returned if no key is set. In the case
+of a key which is too long MEMCACHED_BAD_KEY_PROVIDED will be returned.

 
 =item MEMCACHED_CALLBACK_USER_DATA
 
 
 =item MEMCACHED_CALLBACK_USER_DATA
 


@@ -63,24 +64,15 @@ will copy the pointer to the clone.
 
 =item  MEMCACHED_CALLBACK_MALLOC_FUNCTION
 
 
 =item  MEMCACHED_CALLBACK_MALLOC_FUNCTION
 

-This alllows yout to pass in a customized version of malloc that will be used instead of the builtin malloc(3) call.
-The prototype for this is:
-
-void *(*memcached_malloc_function)(memcached_st *ptr, const size_t size);
+DEPRECATED: use memcached_set_memory_allocators instead.

 
 =item  MEMCACHED_CALLBACK_REALLOC_FUNCTION
 
 
 =item  MEMCACHED_CALLBACK_REALLOC_FUNCTION
 

-This alllows yout to pass in a customized version of realloc that will be used instead of the builtin realloc(3) call.
-The prototype for this is:
-
-void *(*memcached_realloc_function)(memcached_st *ptr, void *mem, const size_t size);
+DEPRECATED: use memcached_set_memory_allocators instead.

 
 =item  MEMCACHED_CALLBACK_FREE_FUNCTION
 
 
 =item  MEMCACHED_CALLBACK_FREE_FUNCTION
 

-This alllows yout to pass in a customized version of realloc that will be used instead of the builtin free(3) call.
-The prototype for this is:
-
-typedef void (*memcached_free_function)(memcached_st *ptr, void *mem);
+DEPRECATED: use memcached_set_memory_allocators instead.

 
 =item  MEMCACHED_CALLBACK_GET_FAILURE
 
 
 =item  MEMCACHED_CALLBACK_GET_FAILURE