git.m6w6.name Git - m6w6/libmemcached/blob - docs/memcached_analyze.rst

   1 .. highlight:: perl
   2
   3
   4 memcached_analyze
   5 *****************
   6
   7
   8 memcached_analyze - Analyze server information
   9
  10
  11 *******
  12 LIBRARY
  13 *******
  14
  15
  16 C Client Library for memcached (libmemcached, -lmemcached)
  17
  18
  19 ********
  20 SYNOPSIS
  21 ********
  22
  23
  24
  25 .. code-block:: perl
  26
  27    #include <memcached.h>
  28
  29    memcached_analysis_st *
  30      memcached_analyze (memcached_st *ptr,
  31                         memcached_stat_st *stat,
  32                         memcached_return_t *error);
  33
  34
  35
  36 ***********
  37 DESCRIPTION
  38 ***********
  39
  40
  41 libmemcached(3) has the ability to query a memcached server (or collection
  42 of servers) for their current state. Queries to find state return a
  43 \ ``memcached_analysis_st``\  structure. You are responsible for freeing this structure.
  44
  45 memcached_analyze() analyzes useful information based on the provided servers
  46 and sets the result to the \ ``memcached_analysis_st``\  structure. The return value
  47 must be freed by the calling application.
  48
  49 A command line tool, memstat(1) with the option --analyze, is provided so that
  50 you do not have to write an application to use this method.
  51
  52
  53 ******
  54 RETURN
  55 ******
  56
  57
  58 A pointer to the allocated \ ``memcached_analysis_st``\  structure on success and
  59 a NULL pointer on failure. You may inspect the error detail by checking the
  60 \ ``memcached_return_t``\  value.
  61
  62 Any method returning a \ ``memcached_analysis_st``\  expects you to free the
  63 memory allocated for it.
  64
  65
  66 ****
  67 HOME
  68 ****
  69
  70
  71 To find out more information please check:
  72 `https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
  73
  74
  75 ******
  76 AUTHOR
  77 ******
  78
  79
  80 Toru Maesaka, <dev@torum.net>
  81
  82
  83 ********
  84 SEE ALSO
  85 ********
  86
  87
  88 memcached(1) libmemcached(3) memcached_strerror(3)
  89