1
.TH "MEMCACHED_STAT_EXECUTE" "3" "June 17, 2011" "0.49" "libmemcached"
3
memcached_stat_execute \- libmemcached Documentation
5
.nr rst2man-indent-level 0
9
level \\n[rst2man-indent-level]
10
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
17
.\" .rstReportMargin pre:
19
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
20
. nr rst2man-indent-level +1
21
.\" .rstReportMargin post:
25
.\" indent \\n[an-margin]
26
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
27
.nr rst2man-indent-level -1
28
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
29
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
31
.\" Man page generated from reStructeredText.
34
Get memcached statistics
37
#include <libmemcached/memcached.h>
40
.B memcached_stat_st *memcached_stat (memcached_st *ptr, char *args, memcached_return_t *error);
44
.B memcached_return_t memcached_stat_servername (memcached_stat_st *stat, char *args, const char *hostname, unsigned int port);
48
.B char * memcached_stat_get_value (memcached_st *ptr, memcached_stat_st *stat, const char *key, memcached_return_t *error);
52
.B char ** memcached_stat_get_keys (memcached_st *ptr, memcached_stat_st *stat, memcached_return_t *error);
56
.B memcached_return_t memcached_stat_execute (memcached_st *memc, const char *args, memcached_stat_fn func, void *context);
59
Compile and link with \-lmemcached
62
libmemcached(3) has the ability to query a memcached server (or collection
63
of servers) for their current state. Queries to find state return a
64
\fBmemcached_stat_st\fP structure. You are responsible for freeing this structure.
65
While it is possible to access the structure directly it is not advisable.
66
<memcached_stat_get_value() has been provided to query the structure.
68
memcached_stat_execute() uses the servers found in \fBmemcached_stat_st\fP and
69
executes a "stat" command on each server. args is an optional argument that
70
can be passed in to modify the behavior of "stats". You will need to supply
71
a callback function that will be supplied each pair of values returned by
74
memcached_stat() fetches an array of \fBmemcached_stat_st\fP structures containing
75
the state of all available memcached servers. The return value must be freed
76
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
77
\fBMEMCACHED_NOT_SUPPORTED\fP.
79
memcached_stat_servername() can be used standalone without a \fBmemcached_st\fP to
80
obtain the state of a particular server. "args" is used to define a
81
particular state object (a list of these are not provided for by either the
82
\fBmemcached_stat_get_keys()\fP call nor are they defined in the
83
memcached protocol). You must specify the hostname and port of the server
84
you want to obtain information on.
86
memcached_stat_get_value() returns the value of a particular state key. You
87
specify the key you wish to obtain. The key must be null terminated.
89
\fBmemcached_stat_get_keys()\fP returns a list of keys that the server
90
has state objects on. You are responsible for freeing this list.
92
A command line tool, memstat(1), is provided so that you do not have to write
93
an application to do this.
96
Varies, see particular functions.
98
Any method returning a \fBmemcached_stat_st\fP expects you to free the
99
memory allocated for it.
102
To find out more information please check:
103
\fI\%http://libmemcached.org/\fP
106
Brian Aker, <\fI\%brian@tangent.org\fP>
109
memcached(1) libmemcached(3) memcached_strerror(3)
113
2011, Brian Aker DataDifferential, http://datadifferential.com/
114
.\" Generated by docutils manpage writer.
added
removed
docs/man/memcached_stat_execute.3
