+++ /dev/null
-.TH "MEMCACHED_CALLBACK" "3" "June 10, 2011" "0.47" "libmemcached"
-.SH NAME
-memcached_callback \- libmemcached Documentation
-.
-.nr rst2man-indent-level 0
-.
-.de1 rstReportMargin
-\\$1 \\n[an-margin]
-level \\n[rst2man-indent-level]
-level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
--
-\\n[rst2man-indent0]
-\\n[rst2man-indent1]
-\\n[rst2man-indent2]
-..
-.de1 INDENT
-.\" .rstReportMargin pre:
-. RS \\$1
-. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
-. nr rst2man-indent-level +1
-.\" .rstReportMargin post:
-..
-.de UNINDENT
-. RE
-.\" indent \\n[an-margin]
-.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
-.nr rst2man-indent-level -1
-.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
-.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
-..
-.\" Man page generated from reStructeredText.
-.
-.sp
-Get and set a callback
-.SH SYNOPSIS
-.sp
-#include <libmemcached/memcached.h>
-.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
-.sp
-Compile and link with \-lmemcached
-.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
-structures for particular usages.
-.sp
-memcached_callback_get() takes a callback flag and returns the structure or
-function set by memcached_callback_set().
-.sp
-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.
-.INDENT 0.0
-.TP
-.B MEMCACHED_CALLBACK_CLEANUP_FUNCTION
-.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
-.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.
-.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.
-.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.
-.INDENT 0.0
-.TP
-.B MEMCACHED_CALLBACK_MALLOC_FUNCTION
-.UNINDENT
-.sp
-DEPRECATED: use memcached_set_memory_allocators instead.
-.INDENT 0.0
-.TP
-.B MEMCACHED_CALLBACK_REALLOC_FUNCTION
-.UNINDENT
-.sp
-DEPRECATED: use memcached_set_memory_allocators instead.
-.INDENT 0.0
-.TP
-.B MEMCACHED_CALLBACK_FREE_FUNCTION
-.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.
-.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);
-.INDENT 0.0
-.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.
-.sp
-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.
-Upon error, nothing is set, null is returned, and the memcached_return_t
-argument is set to MEMCACHED_FAILURE.
-.sp
-memcached_callback_set() returns MEMCACHED_SUCCESS upon successful setting,
-otherwise MEMCACHED_FAILURE on error.
-.SH HOME
-.sp
-To find out more information please check:
-\fI\%http://libmemcached.org/\fP
-.SH AUTHOR
-.sp
-Brian Aker, <\fI\%brian@tangent.org\fP>
-.SH SEE ALSO
-.sp
-\fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP
-.SH AUTHOR
-Brian Aker
-.SH COPYRIGHT
-2011, Brian Aker DataDifferential, http://datadifferential.com/
-.\" Generated by docutils manpage writer.
-.\"
-.
projects / awesomized / libmemcached / blobdiff