9 memcached_analyze - Analyze server information
17 C Client Library for memcached (libmemcached, -lmemcached)
28 #include <memcached.h>
30 memcached_analysis_st *
31 memcached_analyze (memcached_st *ptr,
32 memcached_stat_st *stat,
33 memcached_return_t *error);
42 libmemcached(3) has the ability to query a memcached server (or collection
43 of servers) for their current state. Queries to find state return a
44 \ ``memcached_analysis_st``\ structure. You are responsible for freeing this structure.
46 memcached_analyze() analyzes useful information based on the provided servers
47 and sets the result to the \ ``memcached_analysis_st``\ structure. The return value
48 must be freed by the calling application.
50 A command line tool, memstat(1) with the option --analyze, is provided so that
51 you do not have to write an application to use this method.
59 A pointer to the allocated \ ``memcached_analysis_st``\ structure on success and
60 a NULL pointer on failure. You may inspect the error detail by checking the
61 \ ``memcached_return_t``\ value.
63 Any method returning a \ ``memcached_analysis_st``\ expects you to free the
64 memory allocated for it.
72 To find out more information please check:
73 `https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
81 Toru Maesaka, <dev@torum.net>
89 memcached(1) libmemcached(3) memcached_strerror(3)