-.TH "MEMCACHED_CALLBACK" "3" "April 09, 2011" "0.47" "libmemcached"
+.TH "MEMCACHED_CALLBACK" "3" "June 02, 2011" "0.47" "libmemcached"
.SH NAME
memcached_callback \- libmemcached Documentation
.
.
.sp
Get and set a callback
-.SH LIBRARY
-.sp
-C Client Library for memcached (libmemcached, \-lmemcached)
.SH SYNOPSIS
.sp
#include <libmemcached/memcached.h>
.TP
.B void * memcached_callback_get (memcached_st *ptr, memcached_callback_t flag, memcached_return_t *error);
.UNINDENT
+.sp
+Compile and link with \-lmemcached
.SH DESCRIPTION
.sp
libmemcached(3) can have callbacks set key execution points. These either
memcached_callback_set() changes the function/structure assigned by a
callback flag. No connections are reset.
.sp
-You can use MEMCACHED_CALLBACK_USER_DATA to provide custom context if required for any
-of the callbacks
+You can use MEMCACHED_CALLBACK_USER_DATA to provide custom context if required for any of the callbacks.
.INDENT 0.0
.TP
.B MEMCACHED_CALLBACK_CLEANUP_FUNCTION
-.
-When memcached_delete() is called this function will be excuted. At the
-point of its execution all connections have been closed.
.UNINDENT
+.sp
+When memcached_delete() is called this function will be excuted. At the point of its execution all connections are closed.
.INDENT 0.0
.TP
.B MEMCACHED_CALLBACK_CLONE_FUNCTION
-.
-When memcached_delete() is called this function will be excuted. At the
-point of its execution all connections have been closed.
.UNINDENT
+.sp
+When memcached_delete() is called this function will be excuted. At the
+point of its execution all connections are closed.
.INDENT 0.0
.TP
.B MEMCACHED_CALLBACK_PREFIX_KEY
-.
+.UNINDENT
+.sp
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 \- 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. 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.
+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.
+.sp
+The prefix key is only applied to the primary 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.
.sp
If you set a value with the value being NULL then the prefix key is disabled.
-.UNINDENT
.INDENT 0.0
.TP
.B MEMCACHED_CALLBACK_USER_DATA
-.
+.UNINDENT
+.sp
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.
-.UNINDENT
.INDENT 0.0
.TP
.B MEMCACHED_CALLBACK_MALLOC_FUNCTION
-.
-DEPRECATED: use memcached_set_memory_allocators instead.
.UNINDENT
+.sp
+DEPRECATED: use memcached_set_memory_allocators instead.
.INDENT 0.0
.TP
.B MEMCACHED_CALLBACK_REALLOC_FUNCTION
-.
-DEPRECATED: use memcached_set_memory_allocators instead.
.UNINDENT
+.sp
+DEPRECATED: use memcached_set_memory_allocators instead.
.INDENT 0.0
.TP
.B MEMCACHED_CALLBACK_FREE_FUNCTION
-.
-DEPRECATED: use memcached_set_memory_allocators instead.
.UNINDENT
+.sp
+DEPRECATED: use memcached_set_memory_allocators instead.
.INDENT 0.0
.TP
.B MEMCACHED_CALLBACK_GET_FAILURE
-.
+.UNINDENT
+.sp
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
-returned to the calling process. You must clone the memcached_st in order to
+.sp
+You are responsible for populating the result object provided. This result object will then be stored in the server and returned to the calling process.
+.sp
+You must clone the memcached_st in order to
make use of it. The value will be stored only if you return
MEMCACHED_SUCCESS or MEMCACHED_BUFFERED. Returning MEMCACHED_BUFFERED will
cause the object to be buffered and not sent immediatly (if this is the default behavior based on your connection setup this will happen automatically).
.sp
The prototype for this is:
memcached_return_t (*memcached_trigger_key)(memcached_st *ptr, char *key, size_t key_length, memcached_result_st *result);
-.UNINDENT
.INDENT 0.0
.TP
.B MEMCACHED_CALLBACK_DELETE_TRIGGER
.SH HOME
.sp
To find out more information please check:
-\fI\%https://launchpad.net/libmemcached\fP
+\fI\%http://libmemcached.org/\fP
.SH AUTHOR
.sp
Brian Aker, <\fI\%brian@tangent.org\fP>
projects / m6w6 / libmemcached / blobdiff