4 memcached_stat, memcached_stat_servername, memcached_stat_get_value, memcached_stat_get_keys
5 ********************************************************************************************
8 Get memcached statistics
16 C Client Library for memcached (libmemcached, -lmemcached)
27 #include <memcached.h>
29 memcached_stat_st *memcached_stat (memcached_st *ptr,
31 memcached_return_t *error);
33 memcached_return_t memcached_stat_servername (memcached_stat_st *stat,
39 memcached_stat_get_value (memcached_st *ptr,
40 memcached_stat_st *stat,
42 memcached_return_t *error);
45 memcached_stat_get_keys (memcached_st *ptr,
46 memcached_stat_st *stat,
47 memcached_return_t *error);
50 memcached_stat_execute (memcached_st *memc,
52 memcached_stat_fn func,
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 \ ``memcached_stat_st``\ 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 \ ``memcached_stat_st``\ 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 \ ``memcached_stat_st``\ 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 \ ``MEMCACHED_BEHAVIOR_USE_UDP``\
77 behavior set, a NULL value is returned and the error parameter is set to
78 \ ``MEMCACHED_NOT_SUPPORTED``\ .
80 memcached_stat_servername() can be used standalone without a \ ``memcached_st``\ to
81 obtain the state of a particular server. "args" is used to define a
82 particular state object (a list of these are not provided for by either
83 the memcached_stat_get_keys() call nor are they defined in the memcached
84 protocol). You must specify the hostname and port of the server you want to
85 obtain information on.
87 memcached_stat_get_value() returns the value of a particular state key. You
88 specify the key you wish to obtain. The key must be null terminated.
90 memcached_stat_get_keys() returns a list of keys that the server has state
91 objects on. You are responsible for freeing this list.
93 A command line tool, memstat(1), is provided so that you do not have to write
94 an application to do this.
102 Varies, see particular functions.
104 Any method returning a \ ``memcached_stat_st``\ expects you to free the
105 memory allocated for it.
113 To find out more information please check:
114 `https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
122 Brian Aker, <brian@tangent.org>
130 memcached(1) libmemcached(3) memcached_strerror(3)