X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fmemcached_get.rst;h=c563f396c73d3b271f0b6a65ea5460179302740c;hb=a6c3e3a3d04f379b1480c8c88a8eae17e54b1449;hp=a489af4383108236dc422347ab32b55158026908;hpb=1eae35aca01e152e10113cd97b7571ebd6eb5bd9;p=m6w6%2Flibmemcached diff --git a/docs/memcached_get.rst b/docs/memcached_get.rst index a489af43..c563f396 100644 --- a/docs/memcached_get.rst +++ b/docs/memcached_get.rst @@ -1,104 +1,40 @@ -.. highlight:: perl +=============================== +Retrieving data from the server +=============================== +.. index:: object: memcached_st -**** -NAME -**** +-------- +SYNOPSIS +-------- -memcached_get, memcached_mget, memcached_fetch, memcached_mget_execute, -memcached_mget_execute_by_key - Get a value +#include + +.. c:function:: memcached_result_st * memcached_fetch_result (memcached_st *ptr, memcached_result_st *result, memcached_return_t *error); +.. c:function:: char * memcached_get (memcached_st *ptr, const char *key, size_t key_length, size_t *value_length, uint32_t *flags, memcached_return_t *error); -******* -LIBRARY -******* +.. c:function:: memcached_return_t memcached_mget (memcached_st *ptr, const char * const *keys, const size_t *key_length, size_t number_of_keys); +.. c:function:: 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); -C Client Library for memcached (libmemcached, -lmemcached) +.. c:function:: 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); +.. c:function:: char * memcached_fetch (memcached_st *ptr, char *key, size_t *key_length, size_t *value_length, uint32_t *flags, memcached_return_t *error); -******** -SYNOPSIS -******** +.. c:function:: memcached_return_t memcached_fetch_execute (memcached_st *ptr, memcached_execute_fn *callback, void *context, uint32_t number_of_callbacks); +.. c:function:: 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); +.. c:function:: 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); -.. code-block:: perl - - #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); +Compile and link with -lmemcached - -*********** +----------- DESCRIPTION -*********** +----------- memcached_get() is used to fetch an individual value from the server. You @@ -130,7 +66,7 @@ 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'ed by the caller. memcached_fetch() will +memcached_fetch() must be freed by the caller. memcached_fetch() will be DEPRECATED in the near future, memcached_fetch_result() should be used instead. @@ -154,7 +90,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 @@ -165,16 +101,16 @@ 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. -All of the above functions are not supported when the \ ``MEMCACHED_BEHAVIOR_USE_UDP``\ +All of the above functions are not tested when the \ ``MEMCACHED_BEHAVIOR_USE_UDP``\ has been set. Executing any of these functions with this behavior on will result in -\ ``MEMCACHED_NOT_SUPPORTED``\ being returned or, for those functions which do not return +\ ``MEMCACHED_NOT_SUPPORTED``\ being returned, or for those functions which do not return a \ ``memcached_return_t``\ , the error function parameter will be set to \ ``MEMCACHED_NOT_SUPPORTED``\ . -****** +------ RETURN -****** +------ All objects returned must be freed by the calling application. @@ -186,27 +122,18 @@ and the key was set larger then MEMCACHED_MAX_KEY, which was the largest key allowed for the original memcached ascii server. -**** +---- HOME -**** +---- To find out more information please check: -`https://launchpad.net/libmemcached `_ - +`http://libmemcached.org/ `_ -****** -AUTHOR -****** -Brian Aker, - - -******** +-------- SEE ALSO -******** - - -memcached(1) libmemcached(3) memcached_strerror(3) +-------- +:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`