-.TH "MEMCACHED_CALLBACK" "3" "April 08, 2011" "0.47" "libmemcached"
+.TH "MEMCACHED_CALLBACK" "3" "April 09, 2011" "0.47" "libmemcached"
.SH NAME
memcached_callback \- libmemcached Documentation
.
.SH LIBRARY
.sp
C Client Library for memcached (libmemcached, \-lmemcached)
-.SS SYNOPSIS
+.SH SYNOPSIS
.sp
-.nf
-.ft C
#include <libmemcached/memcached.h>
-
-memcached_return_t
- memcached_callback_set (memcached_st *ptr,
- memcached_callback_t flag,
- void *data);
-
-void *
- memcached_callback_get (memcached_st *ptr,
- memcached_callback_t flag,
- memcached_return_t *error);
-.ft P
-.fi
-.SS DESCRIPTION
+.INDENT 0.0
+.TP
+.B memcached_return_t memcached_callback_set (memcached_st *ptr, memcached_callback_t flag, void *data);
+.UNINDENT
+.INDENT 0.0
+.TP
+.B void * memcached_callback_get (memcached_st *ptr, memcached_callback_t flag, memcached_return_t *error);
+.UNINDENT
+.SH DESCRIPTION
.sp
libmemcached(3) can have callbacks set key execution points. These either
provide function calls at points in the code, or return pointers to
.sp
You can use MEMCACHED_CALLBACK_USER_DATA to provide custom context if required for any
of the callbacks
-.sp
-MEMCACHED_CALLBACK_CLEANUP_FUNCTION
.INDENT 0.0
-.INDENT 3.5
-.sp
+.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
-.UNINDENT
-.sp
-MEMCACHED_CALLBACK_CLONE_FUNCTION
.INDENT 0.0
-.INDENT 3.5
-.sp
+.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
-.UNINDENT
-.sp
-MEMCACHED_CALLBACK_PREFIX_KEY
.INDENT 0.0
-.INDENT 3.5
-.sp
+.TP
+.B 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 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
.sp
If you set a value with the value being NULL then the prefix key is disabled.
.UNINDENT
-.UNINDENT
-.sp
-MEMCACHED_CALLBACK_USER_DATA
.INDENT 0.0
-.INDENT 3.5
-.sp
+.TP
+.B 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.
.UNINDENT
-.UNINDENT
-.sp
-MEMCACHED_CALLBACK_MALLOC_FUNCTION
.INDENT 0.0
-.INDENT 3.5
-.sp
+.TP
+.B MEMCACHED_CALLBACK_MALLOC_FUNCTION
+.
DEPRECATED: use memcached_set_memory_allocators instead.
.UNINDENT
-.UNINDENT
-.sp
-MEMCACHED_CALLBACK_REALLOC_FUNCTION
.INDENT 0.0
-.INDENT 3.5
-.sp
+.TP
+.B MEMCACHED_CALLBACK_REALLOC_FUNCTION
+.
DEPRECATED: use memcached_set_memory_allocators instead.
.UNINDENT
-.UNINDENT
-.sp
-MEMCACHED_CALLBACK_FREE_FUNCTION
.INDENT 0.0
-.INDENT 3.5
-.sp
+.TP
+.B MEMCACHED_CALLBACK_FREE_FUNCTION
+.
DEPRECATED: use memcached_set_memory_allocators instead.
.UNINDENT
-.UNINDENT
-.sp
-MEMCACHED_CALLBACK_GET_FAILURE
.INDENT 0.0
-.INDENT 3.5
-.sp
+.TP
+.B 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
returned to the calling process. You must clone the memcached_st in order to
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
-.UNINDENT
-.sp
-MEMCACHED_CALLBACK_DELETE_TRIGGER
.INDENT 0.0
-.INDENT 3.5
+.TP
+.B MEMCACHED_CALLBACK_DELETE_TRIGGER
+.UNINDENT
.sp
-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.
+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.
.sp
-The prototype for this is:
-typedef memcached_return_t (*memcached_trigger_delete_key)(memcached_st *ptr, char *key, size_t key_length);
-.UNINDENT
-.UNINDENT
+The prototype for this is: typedef memcached_return_t (*memcached_trigger_delete_key)(memcached_st *ptr, char *key, size_t key_length);
.SH RETURN
.sp
memcached_callback_get() return the function or structure that was provided.
.SH AUTHOR
.sp
Brian Aker, <\fI\%brian@tangent.org\fP>
-.SS SEE ALSO
+.SH SEE ALSO
.sp
\fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
projects / m6w6 / libmemcached / blobdiff