6 Analyze server information
13 .. index:: object: memcached_analysis_st
16 #include <libmemcached/memcached.h>
18 .. c:function:: memcached_analysis_st * memcached_analyze (memcached_st *ptr, memcached_stat_st *stat, memcached_return_t *error);
20 Compile and link with -lmemcached
27 libmemcached(3) has the ability to query a memcached server (or collection
28 of servers) for their current state. Queries to find state return a
29 \ ``memcached_analysis_st``\ structure. You are responsible for freeing this structure.
31 memcached_analyze() analyzes useful information based on the provided servers
32 and sets the result to the \ ``memcached_analysis_st``\ structure. The return value
33 must be freed by the calling application.
35 A command line tool, memstat(1) with the option --analyze, is provided so that
36 you do not have to write an application to use this method.
44 A pointer to the allocated \ ``memcached_analysis_st``\ structure on success and
45 a NULL pointer on failure. You may inspect the error detail by checking the
46 \ ``memcached_return_t``\ value.
48 Any method returning a \ ``memcached_analysis_st``\ expects you to free the
49 memory allocated for it.
57 To find out more information please check:
58 `http://libmemcached.org/ <http://libmemcached.org/>`_
66 :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`