X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fmemcached_callback.pod;h=a11f9585deac8a108c2f8f075e32d11a610b0c3e;hb=7582050eb5e2bdc7e055c84d639a7cb5b407cd4c;hp=9b56a5fcf7f363c08018ce8741b491ec037176bb;hpb=d5ffc30a6f369ea210e92e6a55333121d32b9a55;p=awesomized%2Flibmemcached diff --git a/docs/memcached_callback.pod b/docs/memcached_callback.pod old mode 100755 new mode 100644 index 9b56a5fc..a11f9585 --- a/docs/memcached_callback.pod +++ b/docs/memcached_callback.pod @@ -1,6 +1,6 @@ =head1 NAME -memcached_callback_get memcached_callback_set +memcached_callback_get memcached_callback_set - Get and set a callback =head1 LIBRARY @@ -50,10 +50,11 @@ point of its execution all connections have been closed. =item MEMCACHED_CALLBACK_PREFIX_KEY You can set a value which will be used to create a domain for your keys. -The value specified here will be appended to each of your keys. The value can not -be greater then MEMCACHED_PREFIX_KEY_MAX_SIZE and will reduce MEMCACHED_MAX_KEY by +The value specified here will be prefixed to each of your keys. The value can not +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, -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 @@ -64,6 +65,7 @@ will copy the pointer to the clone. =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. +Your malloc must zero all memory. The prototype for this is: void *(*memcached_malloc_function)(memcached_st *ptr, const size_t size);