X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fmemcached_callback.pod;h=9b56a5fcf7f363c08018ce8741b491ec037176bb;hb=d5ffc30a6f369ea210e92e6a55333121d32b9a55;hp=56ba4e29c6a4e3bbb1a4554f0986d92105d4b0f0;hpb=3b706525e1b66b907905bb9eddd7fd824e8311de;p=awesomized%2Flibmemcached diff --git a/docs/memcached_callback.pod b/docs/memcached_callback.pod index 56ba4e29..9b56a5fc 100755 --- a/docs/memcached_callback.pod +++ b/docs/memcached_callback.pod @@ -47,34 +47,42 @@ point of its execution all connections have been closed. When memcached_delete() is called this function will be excuted. At the 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 of your key. The prefix key is only applied to the primary key, +not the master key. + =item MEMCACHED_CALLBACK_USER_DATA This allows you to store a pointer to a specifc piece of data. This can be retrieved from inside of memcached_fetch_execute(). Cloning a memcached_st 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); -=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); -=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); -=item MEMCACHED_CALLBACK_GET_FAILURE, +=item MEMCACHED_CALLBACK_GET_FAILURE This function implements the read through cache behavior. On failure of retrieval this callback will be called. You are responsible for populating the result object provided. This result object will then be stored in the server and @@ -86,6 +94,15 @@ cause the object to be buffered and not sent immediatly (if this is the default The prototype for this is: memcached_return (*memcached_trigger_key)(memcached_st *ptr, char *key, size_t key_length, memcached_result_st *result); +=item MEMCACHED_CALLBACK_DELETE_TRIGGER + +This function implements a trigger upon successful deletion of a key. The memcached_st structure will need to be cloned +in order to make use of it. + +The prototype for this is: +typedef memcached_return (*memcached_trigger_delete_key)(memcached_st *ptr, char *key, size_t key_length); + + =back =head1 RETURN