Style cleanup
[m6w6/libmemcached] / docs / memcached_stats.rst
1 ==================================================
2 Working with statistical information from a server
3 ==================================================
4
5
6 Get memcached statistics
7
8 .. index:: object: memcached_st
9
10
11 --------
12 SYNOPSIS
13 --------
14
15 #include <libmemcached/memcached.h>
16
17 .. c:function:: memcached_stat_st *memcached_stat (memcached_st *ptr, char *args, memcached_return_t *error);
18
19 .. c:function:: memcached_return_t memcached_stat_servername (memcached_stat_st *stat, char *args, const char *hostname, unsigned int port);
20
21 .. c:function:: char * memcached_stat_get_value (memcached_st *ptr, memcached_stat_st *stat, const char *key, memcached_return_t *error);
22
23 .. c:function:: char ** memcached_stat_get_keys (memcached_st *ptr, memcached_stat_st *stat, memcached_return_t *error);
24
25 .. c:function:: memcached_return_t memcached_stat_execute (memcached_st *memc, const char *args, memcached_stat_fn func, void *context);
26
27 Compile and link with -lmemcached
28
29 -----------
30 DESCRIPTION
31 -----------
32
33
34 libmemcached(3) has the ability to query a memcached server (or collection
35 of servers) for their current state. Queries to find state return a
36 :c:type:`memcached_stat_st` structure. You are responsible for freeing this structure. While it is possible to access the structure directly it is not advisable. :c:func:`memcached_stat_get_value()` has been provided to query the structure.
37
38 :c:func:`memcached_stat_execute()` uses the servers found in :c:type:`memcached_stat_st` 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
39 the memcached server.
40
41 :c:func:`memcached_stat()` fetches an array of :c:type:`memcached_stat_st` structures containing the state of all available memcached servers. The return value must be freed by the calling application. If called with the :c:type:`MEMCACHED_BEHAVIOR_USE_UDP` behavior set, a NULL value is returned and the error parameter is set to :c:type:`MEMCACHED_NOT_SUPPORTED`.
42
43 :c:func:`memcached_stat_servername()` can be used standalone without a :c:type:`memcached_st` 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
44 the :c:func:`memcached_stat_get_keys()` call nor are they defined in the memcached protocol). You must specify the hostname and port of the server you want to
45 obtain information on.
46
47 :c:func:`memcached_stat_get_value()` returns the value of a particular state key. You specify the key you wish to obtain. The key must be null terminated.
48
49 :c:func:`memcached_stat_get_keys()` returns a list of keys that the server has state objects on. You are responsible for freeing this list.
50
51 A command line tool, memstat(1), is provided so that you do not have to write
52 an application to do this.
53
54
55 ------
56 RETURN
57 ------
58
59
60 Varies, see particular functions.
61
62 Any method returning a :c:type:`memcached_stat_st` expects you to free the
63 memory allocated for it.
64
65
66 ----
67 HOME
68 ----
69
70
71 To find out more information please check:
72 `http://libmemcached.org/ <http://libmemcached.org/>`_
73
74
75 ------
76 AUTHOR
77 ------
78
79
80 Brian Aker, <brian@tangent.org>
81
82
83 --------
84 SEE ALSO
85 --------
86
87
88 :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
89