git.m6w6.name Git - awesomized/libmemcached/blob - docs/man/memcached_stat_get_keys.3

   1 .TH "MEMCACHED_STAT_GET_KEYS" "3" "April 13, 2011" "0.47" "libmemcached"
   2 .SH NAME
   3 memcached_stat_get_keys \- libmemcached Documentation
   4 .
   5 .nr rst2man-indent-level 0
   6 .
   7 .de1 rstReportMargin
   8 \\$1 \\n[an-margin]
   9 level \\n[rst2man-indent-level]
  10 level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
  11 -
  12 \\n[rst2man-indent0]
  13 \\n[rst2man-indent1]
  14 \\n[rst2man-indent2]
  15 ..
  16 .de1 INDENT
  17 .\" .rstReportMargin pre:
  18 . RS \\$1
  19 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
  20 . nr rst2man-indent-level +1
  21 .\" .rstReportMargin post:
  22 ..
  23 .de UNINDENT
  24 . RE
  25 .\" indent \\n[an-margin]
  26 .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
  27 .nr rst2man-indent-level -1
  28 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
  29 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
  30 ..
  31 .\" Man page generated from reStructeredText.
  32 .
  33 .sp
  34 Get memcached statistics
  35 .SH LIBRARY
  36 .sp
  37 C Client Library for memcached (libmemcached, \-lmemcached)
  38 .SS SYNOPSIS
  39 .sp
  40 .nf
  41 .ft C
  42 #include <libmemcached/memcached.h>
  43
  44 memcached_stat_st *memcached_stat (memcached_st *ptr,
  45                                    char *args,
  46                                    memcached_return_t *error);
  47
  48 memcached_return_t memcached_stat_servername (memcached_stat_st *stat,
  49                                               char *args,
  50                                               const char *hostname,
  51                                               unsigned int port);
  52
  53 char *
  54   memcached_stat_get_value (memcached_st *ptr,
  55                             memcached_stat_st *stat,
  56                             const char *key,
  57                             memcached_return_t *error);
  58
  59 char **
  60   memcached_stat_get_keys (memcached_st *ptr,
  61                            memcached_stat_st *stat,
  62                            memcached_return_t *error);
  63
  64 memcached_return_t
  65   memcached_stat_execute (memcached_st *memc,
  66                           const char *args,
  67                           memcached_stat_fn func,
  68                           void *context);
  69 .ft P
  70 .fi
  71 .SS DESCRIPTION
  72 .sp
  73 libmemcached(3) has the ability to query a memcached server (or collection
  74 of servers) for their current state. Queries to find state return a
  75 \fBmemcached_stat_st\fP structure. You are responsible for freeing this structure.
  76 While it is possible to access the structure directly it is not advisable.
  77 <memcached_stat_get_value() has been provided to query the structure.
  78 .sp
  79 memcached_stat_execute() uses the servers found in \fBmemcached_stat_st\fP and
  80 executes a "stat" command on each server. args is an optional argument that
  81 can be passed in to modify the behavior of "stats". You will need to supply
  82 a callback function that will be supplied each pair of values returned by
  83 the memcached server.
  84 .sp
  85 memcached_stat() fetches an array of \fBmemcached_stat_st\fP structures containing
  86 the state of all available memcached servers. The return value must be freed
  87 by the calling application. If called with the \fBMEMCACHED_BEHAVIOR_USE_UDP\fPbehavior set, a NULL value is returned and the error parameter is set to
  88 \fBMEMCACHED_NOT_SUPPORTED\fP.
  89 .sp
  90 memcached_stat_servername() can be used standalone without a \fBmemcached_st\fP to
  91 obtain the state of a particular server.  "args" is used to define a
  92 particular state object (a list of these are not provided for by either
  93 the memcached_stat_get_keys() call nor are they defined in the memcached
  94 protocol). You must specify the hostname and port of the server you want to
  95 obtain information on.
  96 .sp
  97 memcached_stat_get_value() returns the value of a particular state key. You
  98 specify the key you wish to obtain.  The key must be null terminated.
  99 .sp
 100 memcached_stat_get_keys() returns a list of keys that the server has state
 101 objects on. You are responsible for freeing this list.
 102 .sp
 103 A command line tool, memstat(1), is provided so that you do not have to write
 104 an application to do this.
 105 .SH RETURN
 106 .sp
 107 Varies, see particular functions.
 108 .sp
 109 Any method returning a \fBmemcached_stat_st\fP expects you to free the
 110 memory allocated for it.
 111 .SH HOME
 112 .sp
 113 To find out more information please check:
 114 \fI\%http://libmemcached.org/\fP
 115 .SH AUTHOR
 116 .sp
 117 Brian Aker, <\fI\%brian@tangent.org\fP>
 118 .SS SEE ALSO
 119 .sp
 120 memcached(1) libmemcached(3) memcached_strerror(3)
 121 .SH AUTHOR
 122 Brian Aker
 123 .SH COPYRIGHT
 124 2011, Brian Aker DataDifferential, http://datadifferential.com/
 125 .\" Generated by docutils manpage writer.
 126 .\"
 127 .