-.. highlight:: perl
+===============================
+Retrieving data from the server
+===============================
-memcached_get, memcached_mget, memcached_fetch, memcached_mget_execute, memcached_mget_execute_by_key
-*****************************************************************************************************
+--------
+SYNOPSIS
+--------
-Get a value
+#include <libmemcached/memcached.h>
+
+.. 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 *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);
-C Client Library for memcached (libmemcached, -lmemcached)
+.. c:function:: 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);
+.. 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 *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);
-.. code-block:: perl
-
- #include <libmemcached/memcached.h>
-
- 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
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 testsed 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
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.
key allowed for the original memcached ascii server.
-****
+----
HOME
-****
+----
To find out more information please check:
`https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
-******
-AUTHOR
-******
-
-
-Brian Aker, <brian@tangent.org>
-
-********
+--------
SEE ALSO
-********
+--------
:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`