memcached_analyze(3)

1..::docs::memcached_analyze(3)   libmemcached   ..::docs::memcached_analyze(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 *memcached_analyze(memcached_st *ptr,
15                                                  memcached_stat_st *stat,
16                                                  memcached_return *error);
17

DESCRIPTION

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

RETURN

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

HOME

40       To find out more information please check:
41       <http://tangent.org/552/libmemcached.html>
42

AUTHOR

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