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
   4
   5 =head1 LIBRARY
   6
   7 C Client Library for memcached (libmemcached, -lmemcached)
   8
   9 =head1 SYNOPSIS
  10
  11 #include <memcached.h>
  12 memcached_stat_st *memcached_stat(memcached_st *ptr, char *args, memcached_return *error);
  13 memcached_return memcached_stat_servername(memcached_stat_st *stat, char *args,
  14                                            char *hostname, unsigned int port);
  15 char *memcached_stat_get_value(memcached_st *ptr, memcached_stat_st *stat,
  16                                char *key, memcached_return *error);
  17 char ** memcached_stat_get_keys(memcached_st *ptr, memcached_stat_st *stat,
  18                                 memcached_return *error);
  19
  20 =head1 DESCRIPTION
  21
  22 libmemcached(3) has the ability to query a memcached server (or collection
  23 of servers) for their current state. Queries to find state return a
  24 memcached_stat_st structure. You are responsible for freeing this structure.
  25 While it is possible to access the structure directly it is not advisable.
  26 memcached_stat_get_value(3) has been provided to query the structure.
  27
  28 memcached_stat() fetches an array of memcached_stat_st structures containing
  29 the state of all available memcached servers. The return value must be freed
  30 by the calling application.
  31
  32 memcached_stat_servername() can be used standalone without a memcached_st to
  33 obtain the state of a particular server.  "args" is used to define a
  34 particular state object (a list of these are not provided for by either
  35 the memcached_stat_get_keys call nor are they defined in the memcached
  36 protocol). You must specify the hostname and port fo the server you want to
  37 obtain information on
  38
  39 memcached_stat_get_value() returns the value of a particular state key. You
  40 specify the key you wish to obtain (this key must be null terminated).
  41
  42 memcached_stat_get_keys() returns a list of keys that the server has state
  43 objects on. You are responsible for freeing this list.
  44
  45 A command line tool, memstat(1) is provided so that you do not have to write
  46 an application to do this.
  47
  48 =head1 RETURN
  49
  50 memcached_stat() returns memcached_return. The value on success will be MEMCACHED_SUCCESS. For all errors check with memcached_strerror().
  51 Any method returning a memcached_stat_st expects you to free the memory
  52 allocated for it.
  53
  54 =head1 HOME
  55
  56 To find out more information please check: http://tangent.org/552/libmemcached.html
  57
  58 =head1 AUTHOR
  59
  60 Brian Aker, brian@tangent.org
  61
  62 =head1 SEE ALSO
  63
  64 memcached(1) libmemcached(3) memcached_strerror(3)
  65
  66 =cut
  67