X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fman%2Fmemcached_callback_get.3;h=ff00b04ad4d26624d64d978506f49097d1bdb90d;hb=1fcd4c0fbe57bb3f4f68725bf8173fa522354b07;hp=d245c78fd0df28d2caff087468f9e8ba22e3386f;hpb=281c398ba3a10af677494c4453cd09d85ca921e0;p=m6w6%2Flibmemcached diff --git a/docs/man/memcached_callback_get.3 b/docs/man/memcached_callback_get.3 index d245c78f..ff00b04a 100644 --- a/docs/man/memcached_callback_get.3 +++ b/docs/man/memcached_callback_get.3 @@ -1,4 +1,4 @@ -.TH "MEMCACHED_CALLBACK_GET" "3" "April 08, 2011" "0.47" "libmemcached" +.TH "MEMCACHED_CALLBACK_GET" "3" "October 18, 2011" "1.01" "libmemcached" .SH NAME memcached_callback_get \- libmemcached Documentation . @@ -32,157 +32,149 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] . .sp Get and set a callback -.SH LIBRARY +.SH SYNOPSIS .sp -C Client Library for memcached (libmemcached, \-lmemcached) -.SS SYNOPSIS -.sp -.nf -.ft C #include - -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, const 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(). +\fBmemcached_callback_get()\fP takes a callback flag and returns the +structure or function set by \fBmemcached_callback_set()\fP. .sp -memcached_callback_set() changes the function/structure assigned by a +\fBmemcached_callback_set()\fP 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 -.sp -MEMCACHED_CALLBACK_CLEANUP_FUNCTION +You can use \fI\%MEMCACHED_CALLBACK_USER_DATA\fP to provide custom context +if required for any of the callbacks. .INDENT 0.0 -.INDENT 3.5 -.sp -When memcached_delete() is called this function will be excuted. At the -point of its execution all connections have been closed. -.UNINDENT +.TP +.B MEMCACHED_CALLBACK_CLEANUP_FUNCTION .UNINDENT .sp -MEMCACHED_CALLBACK_CLONE_FUNCTION +When \fBmemcached_delete()\fP is called this function will be excuted. At +the point of its execution all connections are closed. .INDENT 0.0 -.INDENT 3.5 -.sp -When memcached_delete() is called this function will be excuted. At the -point of its execution all connections have been closed. -.UNINDENT +.TP +.B MEMCACHED_CALLBACK_CLONE_FUNCTION .UNINDENT .sp -MEMCACHED_CALLBACK_PREFIX_KEY +When \fBmemcached_delete()\fP is called this function will be excuted. +At the point of its execution all connections are closed. .INDENT 0.0 -.INDENT 3.5 +.TP +.B MEMCACHED_CALLBACK_PREFIX_KEY +. +See \fI\%MEMCACHED_CALLBACK_NAMESPACE\fP +.UNINDENT +.INDENT 0.0 +.TP +.B MEMCACHED_CALLBACK_NAMESPACE +.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 \fBMEMCACHED_PREFIX_KEY_MAX_SIZE \- 1\fP and will +reduce \fBMEMCACHED_MAX_KEY\fP by the value of your key. .sp -If you set a value with the value being NULL then the prefix key is disabled. -.UNINDENT -.UNINDENT +The prefix key is only applied to the primary key, not the master key. +\fBMEMCACHED_FAILURE\fP will be returned if no key is set. In the case of +a key which is too long, \fBMEMCACHED_BAD_KEY_PROVIDED\fP will be returned. .sp -MEMCACHED_CALLBACK_USER_DATA +If you set a value with the value being NULL then the prefix key is disabled. .INDENT 0.0 -.INDENT 3.5 -.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 +.TP +.B MEMCACHED_CALLBACK_USER_DATA .UNINDENT .sp -MEMCACHED_CALLBACK_MALLOC_FUNCTION +This allows you to store a pointer to a specifc piece of data. This can be +retrieved from inside of \fBmemcached_fetch_execute()\fP. Cloning a +\fBmemcached_st\fP will copy the pointer to the clone. .INDENT 0.0 -.INDENT 3.5 -.sp -DEPRECATED: use memcached_set_memory_allocators instead. -.UNINDENT +.TP +.B MEMCACHED_CALLBACK_MALLOC_FUNCTION .UNINDENT .sp -MEMCACHED_CALLBACK_REALLOC_FUNCTION +Deprecated since version <0.32: Use \fBmemcached_set_memory_allocators\fP instead. .INDENT 0.0 -.INDENT 3.5 -.sp -DEPRECATED: use memcached_set_memory_allocators instead. -.UNINDENT +.TP +.B MEMCACHED_CALLBACK_REALLOC_FUNCTION .UNINDENT .sp -MEMCACHED_CALLBACK_FREE_FUNCTION +Deprecated since version <0.32: Use \fBmemcached_set_memory_allocators\fP instead. .INDENT 0.0 -.INDENT 3.5 -.sp -DEPRECATED: use memcached_set_memory_allocators instead. -.UNINDENT +.TP +.B MEMCACHED_CALLBACK_FREE_FUNCTION .UNINDENT .sp -MEMCACHED_CALLBACK_GET_FAILURE +Deprecated since version <0.32: Use \fBmemcached_set_memory_allocators\fP instead. .INDENT 0.0 -.INDENT 3.5 +.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 \fBmemcached_st\fP 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). +\fBMEMCACHED_SUCCESS\fP or \fBMEMCACHED_BUFFERED\fP. Returning +\fBMEMCACHED_BUFFERED\fP 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_return_t (*memcached_trigger_key)(memcached_st *ptr, char *key, size_t key_length, memcached_result_st *result); .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 +.INDENT 0.0 +.TP +.B typedef memcached_return_t (*memcached_trigger_delete_key)(memcached_st *ptr, char *key, size_t key_length); .UNINDENT .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. +\fBmemcached_callback_get()\fP return the function or structure that was +provided. Upon error, nothing is set, null is returned, and the +\fBmemcached_return_t\fP argument is set to \fBMEMCACHED_FAILURE\fP. .sp -memcached_callback_set() returns MEMCACHED_SUCCESS upon successful setting, -otherwise MEMCACHED_FAILURE on error. +\fBmemcached_callback_set()\fP returns \fBMEMCACHED_SUCCESS\fP upon +successful setting, otherwise \fBMEMCACHED_FAILURE\fP on error. .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> -.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. .\" .