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

   1 .TH "MEMCACHED_ANALYZE" "3" "March 23, 2012" "1.0.5" "libmemcached"
   2 .SH NAME
   3 memcached_analyze \- 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 Analyze server information
  35 .SH SYNOPSIS
  36 .sp
  37 #include <libmemcached/memcached.h>
  38 .INDENT 0.0
  39 .TP
  40 .B memcached_analysis_st
  41 .UNINDENT
  42 .INDENT 0.0
  43 .TP
  44 .B \fI\%memcached_analysis_st\fP * memcached_analyze(memcached_st\fI\ *ptr\fP, memcached_stat_st\fI\ *stat\fP, memcached_return_t\fI\ *error\fP)
  45 .UNINDENT
  46 .sp
  47 Compile and link with \-lmemcached
  48 .SH DESCRIPTION
  49 .sp
  50 \fBlibmemcached\fP has the ability to query a memcached server (or
  51 collection of servers) for their current state. Queries to find state return a
  52 \fI\%memcached_analysis_st\fP structure. You are responsible for freeing this structure.
  53 .sp
  54 \fI\%memcached_analyze()\fP analyzes useful information based on the
  55 provided servers and sets the result to the \fI\%memcached_analysis_st\fP
  56 structure. The return value must be freed by the calling application.
  57 .sp
  58 A command line tool, \fBmemstat\fP with the option \fImemstat \-\-analyze\fP,
  59 is provided so that you do not have to write an application to use this method.
  60 .SH RETURN
  61 .sp
  62 A pointer to the allocated \fI\%memcached_analysis_st\fP structure on
  63 success and a NULL pointer on failure. You may inspect the error detail by
  64 checking the \fBmemcached_return_t\fP value.
  65 .sp
  66 Any method returning a \fI\%memcached_analysis_st\fP expects you to free the
  67 memory allocated for it.
  68 .SH HOME
  69 .sp
  70 To find out more information please check:
  71 \fI\%http://libmemcached.org/\fP
  72 .SH SEE ALSO
  73 .sp
  74 \fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP
  75 .SH AUTHOR
  76 Brian Aker
  77 .SH COPYRIGHT
  78 2011, Brian Aker DataDifferential, http://datadifferential.com/
  79 .\" Generated by docutils manpage writer.
  80 .\"
  81 .