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

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