memcached_analyze(3)

1memcached_analyze.pop(3)       memcached_analyze      memcached_analyze.pop(3)
2
3
4

NAME

6       memcached_analyze - Analyze server information
7

LIBRARY

9       C Client Library for memcached (libmemcached, -lmemcached)
10

SYNOPSIS

12         #include <memcached.h>
13
14         memcached_analysis_st *
15           memcached_analyze (memcached_st *ptr,
16                              memcached_stat_st *stat,
17                              memcached_return_t *error);
18

DESCRIPTION

20       libmemcached(3) has the ability to query a memcached server (or
21       collection of servers) for their current state. Queries to find state
22       return a "memcached_analysis_st" structure. You are responsible for
23       freeing this structure.
24
25       memcached_analyze() analyzes useful information based on the provided
26       servers and sets the result to the "memcached_analysis_st" structure.
27       The return value must be freed by the calling application.
28
29       A command line tool, memstat(1) with the option --analyze, is provided
30       so that you do not have to write an application to use this method.
31

RETURN

33       A pointer to the allocated "memcached_analysis_st" structure on success
34       and a NULL pointer on failure. You may inspect the error detail by
35       checking the "memcached_return_t" value.
36
37       Any method returning a "memcached_analysis_st" expects you to free the
38       memory allocated for it.
39

HOME

41       To find out more information please check:
42       <https://launchpad.net/libmemcached>
43

AUTHOR

45       Toru Maesaka, <dev@torum.net>
46