6 Analyze server information
14 C Client Library for memcached (libmemcached, -lmemcached)
25 #include <libmemcached/memcached.h>
27 memcached_analysis_st *
28 memcached_analyze (memcached_st *ptr,
29 memcached_stat_st *stat,
30 memcached_return_t *error);
39 libmemcached(3) has the ability to query a memcached server (or collection
40 of servers) for their current state. Queries to find state return a
41 \ ``memcached_analysis_st``\ structure. You are responsible for freeing this structure.
43 memcached_analyze() analyzes useful information based on the provided servers
44 and sets the result to the \ ``memcached_analysis_st``\ structure. The return value
45 must be freed by the calling application.
47 A command line tool, memstat(1) with the option --analyze, is provided so that
48 you do not have to write an application to use this method.
56 A pointer to the allocated \ ``memcached_analysis_st``\ structure on success and
57 a NULL pointer on failure. You may inspect the error detail by checking the
58 \ ``memcached_return_t``\ value.
60 Any method returning a \ ``memcached_analysis_st``\ expects you to free the
61 memory allocated for it.
69 To find out more information please check:
70 `https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
78 :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`