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

   1 =head1 NAME
   2
   3 memcached_stat, memcached_stat_servername, memcached_stat_get_value, memcached_stat_get_keys - Get memcached statistics
   4
   5 =head1 LIBRARY
   6
   7 C Client Library for memcached (libmemcached, -lmemcached)
   8
   9 =head1 SYNOPSIS
  10
  11   #include <memcached.h>
  12
  13   memcached_stat_st *memcached_stat (memcached_st *ptr,
  14                                      char *args,
  15                                      memcached_return_t *error);
  16
  17   memcached_return_t memcached_stat_servername (memcached_stat_st *stat,
  18                                                 char *args,
  19                                                 const char *hostname,
  20                                                 unsigned int port);
  21
  22   char *
  23     memcached_stat_get_value (memcached_st *ptr,
  24                               memcached_stat_st *stat,
  25                               const char *key,
  26                               memcached_return_t *error);
  27
  28   char **
  29     memcached_stat_get_keys (memcached_st *ptr,
  30                              memcached_stat_st *stat,
  31                              memcached_return_t *error);
  32
  33   memcached_return_t
  34     memcached_stat_execute (memcached_st *memc,
  35                             const char *args,
  36                             memcached_stat_fn func,
  37                             void *context);
  38
  39 =head1 DESCRIPTION
  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 C<memcached_stat_st> structure. You are responsible for freeing this structure.
  44 While it is possible to access the structure directly it is not advisable.
  45 <memcached_stat_get_value() has been provided to query the structure.
  46
  47 memcached_stat_execute() uses the servers found in C<memcached_stat_st> and
  48 executes a "stat" command on each server. args is an optional argument that
  49 can be passed in to modify the behavior of "stats". You will need to supply
  50 a callback function that will be supplied each pair of values returned by
  51 the memcached server.
  52
  53 memcached_stat() fetches an array of C<memcached_stat_st> structures containing
  54 the state of all available memcached servers. The return value must be freed
  55 by the calling application. If called with the C<MEMCACHED_BEHAVIOR_USE_UDP>
  56 behavior set, a NULL value is returned and the error parameter is set to
  57 C<MEMCACHED_NOT_SUPPORTED>.
  58
  59 memcached_stat_servername() can be used standalone without a C<memcached_st> to
  60 obtain the state of a particular server.  "args" is used to define a
  61 particular state object (a list of these are not provided for by either
  62 the memcached_stat_get_keys() call nor are they defined in the memcached
  63 protocol). You must specify the hostname and port of the server you want to
  64 obtain information on.
  65
  66 memcached_stat_get_value() returns the value of a particular state key. You
  67 specify the key you wish to obtain.  The key must be null terminated.
  68
  69 memcached_stat_get_keys() returns a list of keys that the server has state
  70 objects on. You are responsible for freeing this list.
  71
  72 A command line tool, memstat(1), is provided so that you do not have to write
  73 an application to do this.
  74
  75 =head1 RETURN
  76
  77 Varies, see particular functions.
  78
  79 Any method returning a C<memcached_stat_st> expects you to free the
  80 memory allocated for it.
  81
  82 =head1 HOME
  83
  84 To find out more information please check:
  85 L<https://launchpad.net/libmemcached>
  86
  87 =head1 AUTHOR
  88
  89 Brian Aker, E<lt>brian@tangent.orgE<gt>
  90
  91 =head1 SEE ALSO
  92
  93 memcached(1) libmemcached(3) memcached_strerror(3)
  94
  95 =cut
  96