1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
|
=================
Anaylzing servers
=================
Analyze server information
--------
SYNOPSIS
--------
.. index:: object: memcached_analysis_st
#include <libmemcached/memcached.h>
.. c:type:: memcached_analysis_st
.. c:function:: memcached_analysis_st * memcached_analyze (memcached_st *ptr, memcached_stat_st *stat, memcached_return_t *error)
Compile and link with -lmemcached
-----------
DESCRIPTION
-----------
:program:`libmemcached` has the ability to query a memcached server (or
collection of servers) for their current state. Queries to find state return a
:c:type:`memcached_analysis_st` structure. You are responsible for freeing this structure.
:c:func:`memcached_analyze` analyzes useful information based on the
provided servers and sets the result to the :c:type:`memcached_analysis_st`
structure. The return value must be freed by the calling application.
A command line tool, :program:`memstat` with the option :option:`memstat --analyze`,
is provided so that you do not have to write an application to use this method.
------
RETURN
------
A pointer to the allocated :c:type:`memcached_analysis_st` structure on
success and a NULL pointer on failure. You may inspect the error detail by
checking the :c:type:`memcached_return_t` value.
Any method returning a :c:type:`memcached_analysis_st` expects you to free the
memory allocated for it.
----
HOME
----
To find out more information please check:
`http://libmemcached.org/ <http://libmemcached.org/>`_
--------
SEE ALSO
--------
:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
|