From: Brian Aker Date: Tue, 22 Jan 2008 18:17:42 +0000 (-0800) Subject: Clarify caller return behavior X-Git-Tag: 0.15~8 X-Git-Url: https://git.m6w6.name/?a=commitdiff_plain;h=536c81533f38155ce3bb88237d66007ccc3d858f;p=m6w6%2Flibmemcached Clarify caller return behavior --- diff --git a/docs/memcached_get.pod b/docs/memcached_get.pod index 1cf0a60c..bd8623bb 100755 --- a/docs/memcached_get.pod +++ b/docs/memcached_get.pod @@ -58,7 +58,8 @@ 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 pointer to hold any error. The object will be returned -upon success and NULL will be returned on failure. +upon success and NULL will be returned on failure. Any object returned by +memcached_get() must be released by the caller application. memcached_mget() is used to select multiple keys at once. For multiple key operations it is always faster to use this function. This function always @@ -77,7 +78,10 @@ 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 pointer to hold any error. The object will be returned -upon success and NULL will be returned on failure. +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'ed by the caller. 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