memcached_analyze(3)

1MEMCACHED_ANALYZE(3)         libmemcached-awesome         MEMCACHED_ANALYZE(3)
2
3
4

NAME

6       memcached_analyze - libmemcached Documentation
7

SYNOPSIS

9       #include <libmemcached/memcached.h>
10              Compile and link with -lmemcached
11
12       typedef struct memcached_analysis_st memcached_analysis_st
13
14       memcached_analysis_st       *memcached_analyze(memcached_st       *ptr,
15       memcached_stat_st *stat, memcached_return_t *error)
16
17              Parameters
18
19                     • ptr -- pointer to initialized memcached_st struct
20
21                     • stat -- pointer to a memcached_stat_st struct to fill
22
23                     • error -- pointer to memcached_return_t indicating  suc‐
24                       cess
25
26              Returns
27                     pointer  to  an allocated and filled out memcached_analy‐
28                     sis_t struct
29

DESCRIPTION

31       libmemcached has the ability to query a memcached server (or collection
32       of  servers)  for  their  current state. Queries to find state return a
33       memcached_analysis_st structure. You are responsible for  freeing  this
34       structure.
35
36       memcached_analyze()  analyzes  useful information based on the provided
37       servers and sets the result to the memcached_analysis_st structure. The
38       return value must be freed by the calling application.
39
40       SEE ALSO:
41          memstat  -a|--analyze  [<arg>] A command line tool to analyze a mem‐
42          cached server.
43

RETURN VALUE

45       A pointer to the allocated memcached_analysis_st structure  on  success
46       and  a  NULL  pointer  on  failure. You may inspect the error detail by
47       checking the memcached_return_t value.
48
49       Any method returning a memcached_analysis_st expects you  to  free  the
50       memory allocated for it.
51