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

   1 .TH "MEMCACHED_STAT" "3" "June 10, 2011" "0.47" "libmemcached"
   2 .SH NAME
   3 memcached_stat \- 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 SYNOPSIS
  36 .sp
  37 #include <libmemcached/memcached.h>
  38 .INDENT 0.0
  39 .TP
  40 .B memcached_stat_st *memcached_stat (memcached_st *ptr, char *args, memcached_return_t *error);
  41 .UNINDENT
  42 .INDENT 0.0
  43 .TP
  44 .B memcached_return_t memcached_stat_servername (memcached_stat_st *stat, char *args, const char *hostname, unsigned int port);
  45 .UNINDENT
  46 .INDENT 0.0
  47 .TP
  48 .B char * memcached_stat_get_value (memcached_st *ptr, memcached_stat_st *stat, const char *key, memcached_return_t *error);
  49 .UNINDENT
  50 .INDENT 0.0
  51 .TP
  52 .B char ** memcached_stat_get_keys (memcached_st *ptr, memcached_stat_st *stat, memcached_return_t *error);
  53 .UNINDENT
  54 .INDENT 0.0
  55 .TP
  56 .B memcached_return_t memcached_stat_execute (memcached_st *memc, const char *args, memcached_stat_fn func, void *context);
  57 .UNINDENT
  58 .sp
  59 Compile and link with \-lmemcached
  60 .SH DESCRIPTION
  61 .sp
  62 libmemcached(3) has the ability to query a memcached server (or collection
  63 of servers) for their current state. Queries to find state return a
  64 \fBmemcached_stat_st\fP structure. You are responsible for freeing this structure.
  65 While it is possible to access the structure directly it is not advisable.
  66 <memcached_stat_get_value() has been provided to query the structure.
  67 .sp
  68 memcached_stat_execute() uses the servers found in \fBmemcached_stat_st\fP and
  69 executes a "stat" command on each server. args is an optional argument that
  70 can be passed in to modify the behavior of "stats". You will need to supply
  71 a callback function that will be supplied each pair of values returned by
  72 the memcached server.
  73 .sp
  74 memcached_stat() fetches an array of \fBmemcached_stat_st\fP structures containing
  75 the state of all available memcached servers. The return value must be freed
  76 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
  77 \fBMEMCACHED_NOT_SUPPORTED\fP.
  78 .sp
  79 memcached_stat_servername() can be used standalone without a \fBmemcached_st\fP to
  80 obtain the state of a particular server.  "args" is used to define a
  81 particular state object (a list of these are not provided for by either the
  82 \fBmemcached_stat_get_keys()\fP call nor are they defined in the
  83 memcached protocol). You must specify the hostname and port of the server
  84 you want to obtain information on.
  85 .sp
  86 memcached_stat_get_value() returns the value of a particular state key. You
  87 specify the key you wish to obtain.  The key must be null terminated.
  88 .sp
  89 \fBmemcached_stat_get_keys()\fP returns a list of keys that the server
  90 has state objects on. You are responsible for freeing this list.
  91 .sp
  92 A command line tool, memstat(1), is provided so that you do not have to write
  93 an application to do this.
  94 .SH RETURN
  95 .sp
  96 Varies, see particular functions.
  97 .sp
  98 Any method returning a \fBmemcached_stat_st\fP expects you to free the
  99 memory allocated for it.
 100 .SH HOME
 101 .sp
 102 To find out more information please check:
 103 \fI\%http://libmemcached.org/\fP
 104 .SH AUTHOR
 105 .sp
 106 Brian Aker, <\fI\%brian@tangent.org\fP>
 107 .SH SEE ALSO
 108 .sp
 109 memcached(1) libmemcached(3) memcached_strerror(3)
 110 .SH AUTHOR
 111 Brian Aker
 112 .SH COPYRIGHT
 113 2011, Brian Aker DataDifferential, http://datadifferential.com/
 114 .\" Generated by docutils manpage writer.
 115 .\"
 116 .