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