Analyzing servers¶
Analyze server information
SYNOPSIS¶
- #include <libmemcached/memcached.h>
Compile and link with -lmemcached
-
type
memcached_analysis_st¶ typedef struct memcached_analysis_st memcached_analysis_st;
-
memcached_analysis_st *
memcached_analyze(memcached_st *ptr, memcached_stat_st *stat, memcached_return_t *error)¶
DESCRIPTION¶
libmemcached has the ability to query a memcached server (or
collection of servers) for their current state. Queries to find state return a
memcached_analysis_st structure. You are responsible for freeing this structure.
memcached_analyze() analyzes useful information based on the
provided servers and sets the result to the memcached_analysis_st
structure. The return value must be freed by the calling application.
A command line tool, memstat with the option memstat --analyze,
is provided so that you do not have to write an application to use this method.
RETURN¶
A pointer to the allocated memcached_analysis_st structure on
success and a NULL pointer on failure. You may inspect the error detail by
checking the memcached_return_t value.
Any method returning a memcached_analysis_st expects you to free the
memory allocated for it.