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

   1 .. highlight:: perl
   2
   3
   4 memcached_stat, memcached_stat_servername, memcached_stat_get_value, memcached_stat_get_keys
   5 ********************************************************************************************
   6
   7
   8 Get memcached statistics
   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_stat_st *memcached_stat (memcached_st *ptr,
  30                                       char *args,
  31                                       memcached_return_t *error);
  32
  33    memcached_return_t memcached_stat_servername (memcached_stat_st *stat,
  34                                                  char *args,
  35                                                  const char *hostname,
  36                                                  unsigned int port);
  37
  38    char *
  39      memcached_stat_get_value (memcached_st *ptr,
  40                                memcached_stat_st *stat,
  41                                const char *key,
  42                                memcached_return_t *error);
  43
  44    char **
  45      memcached_stat_get_keys (memcached_st *ptr,
  46                               memcached_stat_st *stat,
  47                               memcached_return_t *error);
  48
  49    memcached_return_t
  50      memcached_stat_execute (memcached_st *memc,
  51                              const char *args,
  52                              memcached_stat_fn func,
  53                              void *context);
  54
  55
  56
  57 ***********
  58 DESCRIPTION
  59 ***********
  60
  61
  62 libmemcached(3) has the ability to query a memcached server (or collection
  63 of servers) for their current state. Queries to find state return a
  64 \ ``memcached_stat_st``\  structure. You are responsible for freeing this structure.
  65 While it is possible to access the structure directly it is not advisable.
  66 <memcached_stat_get_value() has been provided to query the structure.
  67
  68 memcached_stat_execute() uses the servers found in \ ``memcached_stat_st``\  and
  69 executes a "stat" command on each server. args is an optional argument that
  70 can be passed in to modify the behavior of "stats". You will need to supply
  71 a callback function that will be supplied each pair of values returned by
  72 the memcached server.
  73
  74 memcached_stat() fetches an array of \ ``memcached_stat_st``\  structures containing
  75 the state of all available memcached servers. The return value must be freed
  76 by the calling application. If called with the \ ``MEMCACHED_BEHAVIOR_USE_UDP``\
  77 behavior set, a NULL value is returned and the error parameter is set to
  78 \ ``MEMCACHED_NOT_SUPPORTED``\ .
  79
  80 memcached_stat_servername() can be used standalone without a \ ``memcached_st``\  to
  81 obtain the state of a particular server.  "args" is used to define a
  82 particular state object (a list of these are not provided for by either
  83 the memcached_stat_get_keys() call nor are they defined in the memcached
  84 protocol). You must specify the hostname and port of the server you want to
  85 obtain information on.
  86
  87 memcached_stat_get_value() returns the value of a particular state key. You
  88 specify the key you wish to obtain.  The key must be null terminated.
  89
  90 memcached_stat_get_keys() returns a list of keys that the server has state
  91 objects on. You are responsible for freeing this list.
  92
  93 A command line tool, memstat(1), is provided so that you do not have to write
  94 an application to do this.
  95
  96
  97 ******
  98 RETURN
  99 ******
 100
 101
 102 Varies, see particular functions.
 103
 104 Any method returning a \ ``memcached_stat_st``\  expects you to free the
 105 memory allocated for it.
 106
 107
 108 ****
 109 HOME
 110 ****
 111
 112
 113 To find out more information please check:
 114 `https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
 115
 116
 117 ******
 118 AUTHOR
 119 ******
 120
 121
 122 Brian Aker, <brian@tangent.org>
 123
 124
 125 ********
 126 SEE ALSO
 127 ********
 128
 129
 130 memcached(1) libmemcached(3) memcached_strerror(3)
 131