X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fmemcached_stats.rst;h=0c0115c9d44664d4bfa35d8ae7ec03841987bd29;hb=1056271e7a25406f0a118faeebeb67decf1c243b;hp=f1f89701588e46fea16206276e8ee9b6e01b3e27;hpb=1eae35aca01e152e10113cd97b7571ebd6eb5bd9;p=m6w6%2Flibmemcached diff --git a/docs/memcached_stats.rst b/docs/memcached_stats.rst index f1f89701..0c0115c9 100644 --- a/docs/memcached_stats.rst +++ b/docs/memcached_stats.rst @@ -1,63 +1,34 @@ -.. highlight:: perl +================================================== +Working with statistical information from a server +================================================== -**** -NAME -**** +Get memcached statistics +.. index:: object: memcached_st -memcached_stat, memcached_stat_servername, memcached_stat_get_value, memcached_stat_get_keys - Get memcached statistics +-------- +SYNOPSIS +-------- -******* -LIBRARY -******* +#include +.. c:function:: memcached_stat_st *memcached_stat (memcached_st *ptr, char *args, memcached_return_t *error); -C Client Library for memcached (libmemcached, -lmemcached) +.. c:function:: memcached_return_t memcached_stat_servername (memcached_stat_st *stat, char *args, const char *hostname, unsigned int port); +.. c:function:: char * memcached_stat_get_value (memcached_st *ptr, memcached_stat_st *stat, const char *key, memcached_return_t *error); -******** -SYNOPSIS -******** - - - -.. code-block:: perl - - #include - - memcached_stat_st *memcached_stat (memcached_st *ptr, - char *args, - memcached_return_t *error); - - memcached_return_t memcached_stat_servername (memcached_stat_st *stat, - char *args, - const char *hostname, - unsigned int port); - - char * - memcached_stat_get_value (memcached_st *ptr, - memcached_stat_st *stat, - const char *key, - memcached_return_t *error); - - char ** - memcached_stat_get_keys (memcached_st *ptr, - memcached_stat_st *stat, - memcached_return_t *error); - - memcached_return_t - memcached_stat_execute (memcached_st *memc, - const char *args, - memcached_stat_fn func, - void *context); - - - -*********** +.. c:function:: char ** memcached_stat_get_keys (memcached_st *ptr, memcached_stat_st *stat, memcached_return_t *error); + +.. c:function:: memcached_return_t memcached_stat_execute (memcached_st *memc, const char *args, memcached_stat_fn func, void *context); + +Compile and link with -lmemcached + +----------- DESCRIPTION -*********** +----------- libmemcached(3) has the ability to query a memcached server (or collection @@ -95,9 +66,9 @@ A command line tool, memstat(1), is provided so that you do not have to write an application to do this. -****** +------ RETURN -****** +------ Varies, see particular functions. @@ -106,26 +77,26 @@ Any method returning a \ ``memcached_stat_st``\ expects you to free the memory allocated for it. -**** +---- 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)