X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fman%2Fmemcached_mget_by_key.3;h=e0ae450f41e66036f2b8bbadcc7e76498502276c;hb=625e84ebfc422790372bc2984f504bdcb4da779c;hp=14287f10ab47b488aca9f1fdd37fdeb3a61463d1;hpb=281c398ba3a10af677494c4453cd09d85ca921e0;p=awesomized%2Flibmemcached diff --git a/docs/man/memcached_mget_by_key.3 b/docs/man/memcached_mget_by_key.3 index 14287f10..e0ae450f 100644 --- a/docs/man/memcached_mget_by_key.3 +++ b/docs/man/memcached_mget_by_key.3 @@ -1,6 +1,6 @@ -.TH "MEMCACHED_MGET_BY_KEY" "3" "April 08, 2011" "0.47" "libmemcached" +.TH "MEMCACHED_MGET_BY_KEY" "3" "June 17, 2011" "0.49" "libmemcached" .SH NAME -memcached_mget_by_key \- libmemcached Documentation +memcached_mget_by_key \- Retrieving data from the server . .nr rst2man-indent-level 0 . @@ -30,85 +30,48 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .. .\" Man page generated from reStructeredText. . +.SH SYNOPSIS .sp -Get a value -.SH LIBRARY -.sp -C Client Library for memcached (libmemcached, \-lmemcached) -.SS SYNOPSIS -.sp -.nf -.ft C #include - -memcached_result_st * - memcached_fetch_result (memcached_st *ptr, - memcached_result_st *result, - memcached_return_t *error); - -char * - memcached_get (memcached_st *ptr, - const char *key, size_t key_length, - size_t *value_length, - uint32_t *flags, - memcached_return_t *error); - -memcached_return_t - memcached_mget (memcached_st *ptr, - const char * const *keys, - const size_t *key_length, - size_t number_of_keys); -char * - memcached_get_by_key (memcached_st *ptr, - const char *master_key, size_t master_key_length, - const char *key, size_t key_length, - size_t *value_length, - uint32_t *flags, - memcached_return_t *error); - -memcached_return_t - memcached_mget_by_key (memcached_st *ptr, - const char *master_key, size_t master_key_length, - const char * const *keys, - const size_t *key_length, - size_t number_of_keys); - -char * - memcached_fetch (memcached_st *ptr, - char *key, size_t *key_length, - size_t *value_length, - uint32_t *flags, - memcached_return_t *error); - -memcached_return_t - memcached_fetch_execute (memcached_st *ptr, - memcached_execute_fn *callback, - void *context, - uint32_t number_of_callbacks); - - -memcached_return_t - memcached_mget_execute (memcached_st *ptr, - const char * const *keys, - const size_t *key_length, - size_t number_of_keys, - memcached_execute_fn *callback, - void *context, - uint32_t number_of_callbacks); - -memcached_return_t - memcached_mget_execute_by_key (memcached_st *ptr, - const char *master_key, - size_t master_key_length, - const char * const *keys, - const size_t *key_length, - size_t number_of_keys, - memcached_execute_fn *callback, - void *context, - uint32_t number_of_callbacks); -.ft P -.fi -.SS DESCRIPTION +.INDENT 0.0 +.TP +.B memcached_result_st * memcached_fetch_result (memcached_st *ptr, memcached_result_st *result, memcached_return_t *error); +.UNINDENT +.INDENT 0.0 +.TP +.B char * memcached_get (memcached_st *ptr, const char *key, size_t key_length, size_t *value_length, uint32_t *flags, memcached_return_t *error); +.UNINDENT +.INDENT 0.0 +.TP +.B memcached_return_t memcached_mget (memcached_st *ptr, const char * const *keys, const size_t *key_length, size_t number_of_keys); +.UNINDENT +.INDENT 0.0 +.TP +.B char * memcached_get_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, size_t *value_length, uint32_t *flags, memcached_return_t *error); +.UNINDENT +.INDENT 0.0 +.TP +.B memcached_return_t memcached_mget_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char * const *keys, const size_t *key_length, size_t number_of_keys); +.UNINDENT +.INDENT 0.0 +.TP +.B char * memcached_fetch (memcached_st *ptr, char *key, size_t *key_length, size_t *value_length, uint32_t *flags, memcached_return_t *error); +.UNINDENT +.INDENT 0.0 +.TP +.B memcached_return_t memcached_fetch_execute (memcached_st *ptr, memcached_execute_fn *callback, void *context, uint32_t number_of_callbacks); +.UNINDENT +.INDENT 0.0 +.TP +.B memcached_return_t memcached_mget_execute (memcached_st *ptr, const char * const *keys, const size_t *key_length, size_t number_of_keys, memcached_execute_fn *callback, void *context, uint32_t number_of_callbacks); +.UNINDENT +.INDENT 0.0 +.TP +.B memcached_return_t memcached_mget_execute_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char * const *keys, const size_t *key_length, size_t number_of_keys, memcached_execute_fn *callback, void *context, uint32_t number_of_callbacks); +.UNINDENT +.sp +Compile and link with \-lmemcached +.SH DESCRIPTION .sp memcached_get() is used to fetch an individual value from the server. You must pass in a key and its length to fetch the object. You must supply @@ -136,12 +99,12 @@ three pointer variables which will give you the state of the returned object. A uint32_t pointer to contain whatever flags you stored with the value, a size_t pointer which will be filled with size of of the object, and a memcached_return_t pointer to hold any error. The object will be returned -upon success and NULL will be returned on failure. MEMCACHD_END is returned -by the *error value when all objects that have been found are returned. -The final value upon MEMCACHED_END is null. Values returned by -memcached_fetch() musted be free\(aqed by the caller. memcached_fetch() will -be DEPRECATED in the near future, memcached_fetch_result() should be used -instead. +upon success and NULL will be returned on failure. \fBMEMCACHD_END\fP is +returned by the *error value when all objects that have been found are +returned. The final value upon \fBMEMCACHED_END\fP is null. Values +returned by memcached_fetch() must be freed by the caller. memcached_fetch() +will be DEPRECATED in the near future, memcached_fetch_result() should be +used instead. .sp memcached_fetch_result() is used to return a memcached_result_st(3) structure from a memcached server. The result object is forward compatible with changes @@ -163,7 +126,7 @@ memcached_mget_execute() and memcached_mget_execute_by_key() is similar to memcached_mget(), but it may trigger the supplied callbacks with result sets while sending out the queries. If you try to perform a really large multiget with memcached_mget() you may encounter a -deadlock in the OS kernel (we fail to write data to the socket because +deadlock in the OS kernel (it will fail to write data to the socket because the input buffer is full). memcached_mget_execute() solves this problem by processing some of the results before continuing sending out requests. Please note that this function is only available in the @@ -174,8 +137,8 @@ as memcached_get() and memcached_mget(). The difference is that they take a master key that is used for determining which server an object was stored if key partitioning was used for storage. .sp -All of the above functions are not testsed when the \fBMEMCACHED_BEHAVIOR_USE_UDP\fPhas been set. Executing any of these functions with this behavior on will result in -\fBMEMCACHED_NOT_SUPPORTED\fP being returned or, for those functions which do not return +All of the above functions are not tested when the \fBMEMCACHED_BEHAVIOR_USE_UDP\fPhas been set. Executing any of these functions with this behavior on will result in +\fBMEMCACHED_NOT_SUPPORTED\fP being returned, or for those functions which do not return a \fBmemcached_return_t\fP, the error function parameter will be set to \fBMEMCACHED_NOT_SUPPORTED\fP. .SH RETURN @@ -184,23 +147,28 @@ All objects returned must be freed by the calling application. memcached_get() and memcached_fetch() will return NULL on error. You must look at the value of error to determine what the actual error was. .sp +\fBmemcached_fetch_execute()\fP return \fBMEMCACHED_SUCCESS\fP if +all keys were successful. \fBMEMCACHED_NOTFOUND\fP will be return if no +keys at all were found. +.sp +\fBmemcached_fetch()\fP and \fBmemcached_fetch_result()\fP set error +to \fBMEMCACHED_END\fP upon successful conclusion. +\fBMEMCACHED_NOTFOUND\fP will be return if no keys at all were found. +.sp MEMCACHED_KEY_TOO_BIG is set to error whenever memcached_fetch() was used and the key was set larger then MEMCACHED_MAX_KEY, which was the largest key allowed for the original memcached ascii server. .SH HOME .sp To find out more information please check: -\fI\%https://launchpad.net/libmemcached\fP -.SH AUTHOR -.sp -Brian Aker, <\fI\%brian@tangent.org\fP> -.SS SEE ALSO +\fI\%http://libmemcached.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 +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" .