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

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