memcached_analyze man page

memcached_analyze — libmemcached Documentation

Analyze server information

Synopsis

#include <libmemcached/memcached.h>

memcached_analysis_st

memcached_analysis_st * memcached_analyze(memcached_st *ptr, memcached_stat_st *stat, memcached_return_t *error)

Compile and link with -lmemcached

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.

Home

To find out more information please check: http://libmemcached.org/

See Also

memcached(1) libmemcached(3) memcached_strerror(3)

Author

Brian Aker

Info

February 09, 2014 1.0.18 libmemcached