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

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