X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fman%2Fmemcached_mget_execute_by_key.3;h=610e43eb1f0ddc0142ae089a086b80320b1c96bf;hb=a5f039742fa3d25829d788edff0e84bdc41401f7;hp=8e591b9119cf353cc78a5d8e7df9199b8c38c61a;hpb=67456d74f5bd4f354a360d70da503dc58cbe5971;p=awesomized%2Flibmemcached diff --git a/docs/man/memcached_mget_execute_by_key.3 b/docs/man/memcached_mget_execute_by_key.3 index 8e591b91..610e43eb 100644 --- a/docs/man/memcached_mget_execute_by_key.3 +++ b/docs/man/memcached_mget_execute_by_key.3 @@ -1,4 +1,4 @@ -.TH "MEMCACHED_MGET_EXECUTE_BY_KEY" "3" "April 14, 2011" "0.47" "libmemcached" +.TH "MEMCACHED_MGET_EXECUTE_BY_KEY" "3" "June 17, 2011" "0.49" "libmemcached" .SH NAME memcached_mget_execute_by_key \- Retrieving data from the server . @@ -99,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 @@ -126,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 @@ -137,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 @@ -147,6 +147,14 @@ 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.