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

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