9 memcached_stat, memcached_stat_servername, memcached_stat_get_value, memcached_stat_get_keys - Get memcached statistics
17 C Client Library for memcached (libmemcached, -lmemcached)
28 #include <memcached.h>
30 memcached_stat_st *memcached_stat (memcached_st *ptr,
32 memcached_return_t *error);
34 memcached_return_t memcached_stat_servername (memcached_stat_st *stat,
40 memcached_stat_get_value (memcached_st *ptr,
41 memcached_stat_st *stat,
43 memcached_return_t *error);
46 memcached_stat_get_keys (memcached_st *ptr,
47 memcached_stat_st *stat,
48 memcached_return_t *error);
51 memcached_stat_execute (memcached_st *memc,
53 memcached_stat_fn func,
63 libmemcached(3) has the ability to query a memcached server (or collection
64 of servers) for their current state. Queries to find state return a
65 \ ``memcached_stat_st``\ structure. You are responsible for freeing this structure.
66 While it is possible to access the structure directly it is not advisable.
67 <memcached_stat_get_value() has been provided to query the structure.
69 memcached_stat_execute() uses the servers found in \ ``memcached_stat_st``\ and
70 executes a "stat" command on each server. args is an optional argument that
71 can be passed in to modify the behavior of "stats". You will need to supply
72 a callback function that will be supplied each pair of values returned by
75 memcached_stat() fetches an array of \ ``memcached_stat_st``\ structures containing
76 the state of all available memcached servers. The return value must be freed
77 by the calling application. If called with the \ ``MEMCACHED_BEHAVIOR_USE_UDP``\
78 behavior set, a NULL value is returned and the error parameter is set to
79 \ ``MEMCACHED_NOT_SUPPORTED``\ .
81 memcached_stat_servername() can be used standalone without a \ ``memcached_st``\ to
82 obtain the state of a particular server. "args" is used to define a
83 particular state object (a list of these are not provided for by either
84 the memcached_stat_get_keys() call nor are they defined in the memcached
85 protocol). You must specify the hostname and port of the server you want to
86 obtain information on.
88 memcached_stat_get_value() returns the value of a particular state key. You
89 specify the key you wish to obtain. The key must be null terminated.
91 memcached_stat_get_keys() returns a list of keys that the server has state
92 objects on. You are responsible for freeing this list.
94 A command line tool, memstat(1), is provided so that you do not have to write
95 an application to do this.
103 Varies, see particular functions.
105 Any method returning a \ ``memcached_stat_st``\ expects you to free the
106 memory allocated for it.
114 To find out more information please check:
115 `https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
123 Brian Aker, <brian@tangent.org>
131 memcached(1) libmemcached(3) memcached_strerror(3)