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