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