37
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);
44
.B memcached_return_t (*memcached_stat_fn)(memcached_server_instance_st\fI\ server\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, const char\fI\ *value\fP, size_t\fI\ value_length\fP, void\fI\ *context\fP)
48
.B \fI\%memcached_stat_st\fP *memcached_stat(memcached_st\fI\ *ptr\fP, char\fI\ *args\fP, memcached_return_t\fI\ *error\fP)
52
.B memcached_return_t memcached_stat_servername(\fI\%memcached_stat_st\fP\fI\ *stat\fP, char\fI\ *args\fP, const char\fI\ *hostname\fP, in_port_t\fI\ port\fP)
56
.B char * memcached_stat_get_value(memcached_st\fI\ *ptr\fP, \fI\%memcached_stat_st\fP\fI\ *stat\fP, const char\fI\ *key\fP, memcached_return_t\fI\ *error\fP)
60
.B char ** memcached_stat_get_keys(memcached_st\fI\ *ptr\fP, \fI\%memcached_stat_st\fP\fI\ *stat\fP, memcached_return_t\fI\ *error\fP)
64
.B memcached_return_t memcached_stat_execute(memcached_st\fI\ *memc\fP, const char\fI\ *args\fP, \fI\%memcached_stat_fn\fP\fI\ func\fP, void\fI\ *context\fP)
59
67
Compile and link with \-lmemcached
62
70
libmemcached(3) has the ability to query a memcached server (or collection
63
71
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. While it is possible to access the structure directly it is not advisable. \fBmemcached_stat_get_value()\fP has been provided to query the structure.
72
\fI\%memcached_stat_st\fP structure. You are responsible for freeing this structure. While it is possible to access the structure directly it is not advisable. \fI\%memcached_stat_get_value()\fP has been provided to query the structure.
66
\fBmemcached_stat_execute()\fP 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
74
\fI\%memcached_stat_execute()\fP uses the servers found in \fI\%memcached_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
67
75
the memcached server.
69
\fBmemcached_stat()\fP 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\fP behavior set, a NULL value is returned and the error parameter is set to \fBMEMCACHED_NOT_SUPPORTED\fP.
77
\fI\%memcached_stat()\fP fetches an array of \fI\%memcached_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\fP behavior set, a NULL value is returned and the error parameter is set to \fBMEMCACHED_NOT_SUPPORTED\fP.
71
\fBmemcached_stat_servername()\fP 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
72
the \fBmemcached_stat_get_keys()\fP call nor are they defined in the memcached protocol). You must specify the hostname and port of the server you want to
79
\fI\%memcached_stat_servername()\fP 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
80
the \fI\%memcached_stat_get_keys()\fP call nor are they defined in the memcached protocol). You must specify the hostname and port of the server you want to
73
81
obtain information on.
75
\fBmemcached_stat_get_value()\fP returns the value of a particular state key. You specify the key you wish to obtain. The key must be null terminated.
83
\fI\%memcached_stat_get_value()\fP returns the value of a particular state key. You specify the key you wish to obtain. The key must be null terminated.
77
\fBmemcached_stat_get_keys()\fP returns a list of keys that the server has state objects on. You are responsible for freeing this list.
85
\fI\%memcached_stat_get_keys()\fP returns a list of keys that the server has state objects on. You are responsible for freeing this list.
79
87
A command line tool, memstat(1), is provided so that you do not have to write
80
88
an application to do this.
added
removed
docs/man/memcached_stat_execute.3
