.TH "MEMCACHED_STAT_GET_VALUE" "3" "April 13, 2011" "0.47" "libmemcached"
.SH NAME
memcached_stat_get_value \- libmemcached Documentation
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.\" Man page generated from reStructeredText.
.
.sp
Get memcached statistics
.SH LIBRARY
.sp
C Client Library for memcached (libmemcached, \-lmemcached)
.SS SYNOPSIS
.sp
.nf
.ft C
#include <libmemcached/memcached.h>

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);
.ft P
.fi
.SS DESCRIPTION
.sp
libmemcached(3) has the ability to query a memcached server (or collection
of servers) for their current state. Queries to find state return a
\fBmemcached_stat_st\fP structure. You are responsible for freeing this structure.
While it is possible to access the structure directly it is not advisable.
<memcached_stat_get_value() has been provided to query the structure.
.sp
memcached_stat_execute() uses the servers found in \fBmemcached_stat_st\fP and
executes a "stat" command on each server. args is an optional argument that
can be passed in to modify the behavior of "stats". You will need to supply
a callback function that will be supplied each pair of values returned by
the memcached server.
.sp
memcached_stat() fetches an array of \fBmemcached_stat_st\fP structures containing
the state of all available memcached servers. The return value must be freed
by the calling application. If called with the \fBMEMCACHED_BEHAVIOR_USE_UDP\fPbehavior set, a NULL value is returned and the error parameter is set to
\fBMEMCACHED_NOT_SUPPORTED\fP.
.sp
memcached_stat_servername() can be used standalone without a \fBmemcached_st\fP to
obtain the state of a particular server.  "args" is used to define a
particular state object (a list of these are not provided for by either
the memcached_stat_get_keys() call nor are they defined in the memcached
protocol). You must specify the hostname and port of the server you want to
obtain information on.
.sp
memcached_stat_get_value() returns the value of a particular state key. You
specify the key you wish to obtain.  The key must be null terminated.
.sp
memcached_stat_get_keys() returns a list of keys that the server has state
objects on. You are responsible for freeing this list.
.sp
A command line tool, memstat(1), is provided so that you do not have to write
an application to do this.
.SH RETURN
.sp
Varies, see particular functions.
.sp
Any method returning a \fBmemcached_stat_st\fP expects you to free the
memory allocated for it.
.SH HOME
.sp
To find out more information please check:
\fI\%https://launchpad.net/libmemcached\fP
.SH AUTHOR
.sp
Brian Aker, <\fI\%brian@tangent.org\fP>
.SS SEE ALSO
.sp
memcached(1) libmemcached(3) memcached_strerror(3)
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\" 
.