memcached_stat(3)

1memcached_stat.pop(3)           memcached_stat           memcached_stat.pop(3)
2
3
4

NAME

6       memcached_stat, memcached_stat_servername, memcached_stat_get_value,
7       memcached_stat_get_keys - Get memcached statistics
8

LIBRARY

10       C Client Library for memcached (libmemcached, -lmemcached)
11

SYNOPSIS

13         #include <memcached.h>
14
15         memcached_stat_st *memcached_stat (memcached_st *ptr,
16                                            char *args,
17                                            memcached_return_t *error);
18
19         memcached_return_t memcached_stat_servername (memcached_stat_st *stat,
20                                                       char *args,
21                                                       const char *hostname,
22                                                       unsigned int port);
23
24         char *
25           memcached_stat_get_value (memcached_st *ptr,
26                                     memcached_stat_st *stat,
27                                     const char *key,
28                                     memcached_return_t *error);
29
30         char **
31           memcached_stat_get_keys (memcached_st *ptr,
32                                    memcached_stat_st *stat,
33                                    memcached_return_t *error);
34
35         memcached_return_t
36           memcached_stat_execute (memcached_st *memc,
37                                   const char *args,
38                                   memcached_stat_fn func,
39                                   void *context);
40

DESCRIPTION

42       libmemcached(3) has the ability to query a memcached server (or
43       collection of servers) for their current state. Queries to find state
44       return a "memcached_stat_st" structure. You are responsible for freeing
45       this structure.  While it is possible to access the structure directly
46       it is not advisable.  <memcached_stat_get_value() has been provided to
47       query the structure.
48
49       memcached_stat_execute() uses the servers found in "memcached_stat_st"
50       and executes a "stat" command on each server. args is an optional
51       argument that can be passed in to modify the behavior of "stats". You
52       will need to supply a callback function that will be supplied each pair
53       of values returned by the memcached server.
54
55       memcached_stat() fetches an array of "memcached_stat_st" structures
56       containing the state of all available memcached servers. The return
57       value must be freed by the calling application. If called with the
58       "MEMCACHED_BEHAVIOR_USE_UDP" behavior set, a NULL value is returned and
59       the error parameter is set to "MEMCACHED_NOT_SUPPORTED".
60
61       memcached_stat_servername() can be used standalone without a
62       "memcached_st" to obtain the state of a particular server.  "args" is
63       used to define a particular state object (a list of these are not
64       provided for by either the memcached_stat_get_keys() call nor are they
65       defined in the memcached protocol). You must specify the hostname and
66       port of the server you want to obtain information on.
67
68       memcached_stat_get_value() returns the value of a particular state key.
69       You specify the key you wish to obtain.  The key must be null
70       terminated.
71
72       memcached_stat_get_keys() returns a list of keys that the server has
73       state objects on. You are responsible for freeing this list.
74
75       A command line tool, memstat(1), is provided so that you do not have to
76       write an application to do this.
77

RETURN

79       Varies, see particular functions.
80
81       Any method returning a "memcached_stat_st" expects you to free the
82       memory allocated for it.
83

HOME

85       To find out more information please check:
86       <https://launchpad.net/libmemcached>
87

AUTHOR

89       Brian Aker, <brian@tangent.org>
90