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 =head1 DESCRIPTION
  34
  35 libmemcached(3) has the ability to query a memcached server (or collection
  36 of servers) for their current state. Queries to find state return a
  37 C<memcached_stat_st> structure. You are responsible for freeing this structure.
  38 While it is possible to access the structure directly it is not advisable.
  39 <memcached_stat_get_value() has been provided to query the structure.
  40
  41 memcached_stat() fetches an array of C<memcached_stat_st> structures containing
  42 the state of all available memcached servers. The return value must be freed
  43 by the calling application. If called with the C<MEMCACHED_BEHAVIOR_USE_UDP>
  44 behavior set, a NULL value is returned and the error parameter is set to
  45 C<MEMCACHED_NOT_SUPPORTED>.
  46
  47 memcached_stat_servername() can be used standalone without a C<memcached_st> to
  48 obtain the state of a particular server.  "args" is used to define a
  49 particular state object (a list of these are not provided for by either
  50 the memcached_stat_get_keys() call nor are they defined in the memcached
  51 protocol). You must specify the hostname and port of the server you want to
  52 obtain information on.
  53
  54 memcached_stat_get_value() returns the value of a particular state key. You
  55 specify the key you wish to obtain.  The key must be null terminated.
  56
  57 memcached_stat_get_keys() returns a list of keys that the server has state
  58 objects on. You are responsible for freeing this list.
  59
  60 A command line tool, memstat(1), is provided so that you do not have to write
  61 an application to do this.
  62
  63 =head1 RETURN
  64
  65 Varies, see particular functions.
  66
  67 Any method returning a C<memcached_stat_st> expects you to free the
  68 memory allocated for it.
  69
  70 =head1 HOME
  71
  72 To find out more information please check:
  73 L<https://launchpad.net/libmemcached>
  74
  75 =head1 AUTHOR
  76
  77 Brian Aker, E<lt>brian@tangent.orgE<gt>
  78
  79 =head1 SEE ALSO
  80
  81 memcached(1) libmemcached(3) memcached_strerror(3)
  82
  83 =cut
  84