1..::docs::memcached_stats(3) libmemcached ..::docs::memcached_stats(3)
2
3
4
6 memcached_stat, memcached_stat_servername, memcached_stat_get_value,
7 memcached_stat_get_keys - Get memcached statistics
8
10 C Client Library for memcached (libmemcached, -lmemcached)
11
13 #include <memcached.h>
14
15 memcached_stat_st *memcached_stat (memcached_st *ptr,
16 char *args,
17 memcached_return *error);
18
19 memcached_return memcached_stat_servername (memcached_stat_st *stat,
20 char *args,
21 char *hostname,
22 unsigned int port);
23
24 char *memcached_stat_get_value (memcached_st *ptr,
25 memcached_stat_st *stat,
26 char *key,
27 memcached_return *error);
28
29 char ** memcached_stat_get_keys (memcached_st *ptr,
30 memcached_stat_st *stat,
31 memcached_return *error);
32
34 libmemcached(3) has the ability to query a memcached server (or
35 collection of servers) for their current state. Queries to find state
36 return a "memcached_stat_st" structure. You are responsible for freeing
37 this structure. While it is possible to access the structure directly
38 it is not advisable. <memcached_stat_get_value() has been provided to
39 query the structure.
40
41 memcached_stat() fetches an array of "memcached_stat_st" structures
42 containing the state of all available memcached servers. The return
43 value must be freed by the calling application. If called with the
44 "MEMCACHED_BEHAVIOR_USE_UDP" behavior set, a NULL value is returned and
45 the error parameter is set to "MEMCACHED_NOT_SUPPORTED".
46
47 memcached_stat_servername() can be used standalone without a
48 "memcached_st" to obtain the state of a particular server. "args" is
49 used to define a particular state object (a list of these are not
50 provided for by either the memcached_stat_get_keys() call nor are they
51 defined in the memcached protocol). You must specify the hostname and
52 port of the server you want to obtain information on.
53
54 memcached_stat_get_value() returns the value of a particular state key.
55 You specify the key you wish to obtain. The key must be null
56 terminated.
57
58 memcached_stat_get_keys() returns a list of keys that the server has
59 state objects on. You are responsible for freeing this list.
60
61 A command line tool, memstat(1), is provided so that you do not have to
62 write an application to do this.
63
65 Varies, see particular functions.
66
67 Any method returning a "memcached_stat_st" expects you to free the
68 memory allocated for it.
69
71 To find out more information please check:
72 <http://tangent.org/552/libmemcached.html>
73
75 Brian Aker, <brian@tangent.org>
76
78 memcached(1) libmemcached(3) memcached_strerror(3)
79
80
81
82 2009-05-23 ..::docs::memcached_stats(3)