X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fman%2Fmemcached_callback.3;h=bee784c429f02031f43587d98a854b09954bd447;hb=7287f37372f5e4198f7f16f5f6d6dcf9a8d5c1fb;hp=2f7a080f624d9218e25755fc945047f3ac82e683;hpb=abaee9e821c2037ba594e89879177c7dddbfb9ea;p=m6w6%2Flibmemcached diff --git a/docs/man/memcached_callback.3 b/docs/man/memcached_callback.3 index 2f7a080f..bee784c4 100644 --- a/docs/man/memcached_callback.3 +++ b/docs/man/memcached_callback.3 @@ -1,4 +1,4 @@ -.TH "MEMCACHED_CALLBACK" "3" "October 18, 2011" "1.01" "libmemcached" +.TH "MEMCACHED_CALLBACK" "3" "April 13, 2012" "1.0.6" "libmemcached" .SH NAME memcached_callback \- libmemcached Documentation . @@ -37,11 +37,15 @@ Get and set a callback #include .INDENT 0.0 .TP -.B memcached_return_t memcached_callback_set (memcached_st *ptr, memcached_callback_t flag, const void *data); +.B memcached_callback_t .UNINDENT .INDENT 0.0 .TP -.B void * memcached_callback_get (memcached_st *ptr, memcached_callback_t flag, memcached_return_t *error); +.B memcached_return_t memcached_callback_set(memcached_st\fI\ *ptr\fP, \fI\%memcached_callback_t\fP\fI\ flag\fP, const void\fI\ *data\fP) +.UNINDENT +.INDENT 0.0 +.TP +.B void * memcached_callback_get(memcached_st\fI\ *ptr\fP, \fI\%memcached_callback_t\fP\fI\ flag\fP, memcached_return_t\fI\ *error\fP) .UNINDENT .sp Compile and link with \-lmemcached @@ -51,10 +55,10 @@ 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 -\fBmemcached_callback_get()\fP takes a callback flag and returns the -structure or function set by \fBmemcached_callback_set()\fP. +\fI\%memcached_callback_get()\fP takes a callback flag and returns the +structure or function set by \fI\%memcached_callback_set()\fP. .sp -\fBmemcached_callback_set()\fP changes the function/structure assigned by a +\fI\%memcached_callback_set()\fP changes the function/structure assigned by a callback flag. No connections are reset. .sp You can use \fI\%MEMCACHED_CALLBACK_USER_DATA\fP to provide custom context @@ -76,7 +80,6 @@ At the point of its execution all connections are closed. .INDENT 0.0 .TP .B MEMCACHED_CALLBACK_PREFIX_KEY -. See \fI\%MEMCACHED_CALLBACK_NAMESPACE\fP .UNINDENT .INDENT 0.0 @@ -86,7 +89,7 @@ See \fI\%MEMCACHED_CALLBACK_NAMESPACE\fP .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 \fBMEMCACHED_PREFIX_KEY_MAX_SIZE \- 1\fP and will +not be greater then \fBMEMCACHED_PREFIX_KEY_MAX_SIZE\fP \- 1 and will reduce \fBMEMCACHED_MAX_KEY\fP by the value of your key. .sp The prefix key is only applied to the primary key, not the master key. @@ -155,11 +158,11 @@ The prototype for this is: .UNINDENT .SH RETURN .sp -\fBmemcached_callback_get()\fP return the function or structure that was +\fI\%memcached_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 -\fBmemcached_callback_set()\fP returns \fBMEMCACHED_SUCCESS\fP upon +\fI\%memcached_callback_set()\fP returns \fBMEMCACHED_SUCCESS\fP upon successful setting, otherwise \fBMEMCACHED_FAILURE\fP on error. .SH HOME .sp