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

   1 =head1 NAME
   2
   3 memcached_analyze
   4
   5 =head1 LIBRARY
   6
   7 C Client Library for memcached (libmemcached, -lmemcached)
   8
   9 =head1 SYNOPSIS
  10
  11   #include <memcached.h>
  12
  13   memcached_analysis_st *memcached_analyze(memcached_st *ptr,
  14                                            memcached_stat_st *stat,
  15                                            memcached_return *error);
  16
  17 =head1 DESCRIPTION
  18
  19 libmemcached(3) has the ability to query a memcached server (or collection
  20 of servers) for their current state. Queries to find state return a
  21 C<memcached_analysis_st> structure. You are responsible for freeing this structure.
  22
  23 memcached_analyze() analyzes useful information based on the provided servers
  24 and sets the result to the C<memcached_analysis_st> structure. The return value
  25 must be freed by the calling application.
  26
  27 A command line tool, memstat(1) with the option --analyze, is provided so that
  28 you do not have to write an application to use this method.
  29
  30 =head1 RETURN
  31
  32 A pointer to the allocated C<memcached_analysis_st> structure on success and
  33 a NULL pointer on failure. You may inspect the error detail by checking the
  34 C<memcached_return> value.
  35
  36 Any method returning a C<memcached_analysis_st> expects you to free the
  37 memory allocated for it.
  38
  39 =head1 HOME
  40
  41 To find out more information please check:
  42 L<http://tangent.org/552/libmemcached.html>
  43
  44 =head1 AUTHOR
  45
  46 Toru Maesaka, E<lt>dev@torum.netE<gt>
  47
  48 =head1 SEE ALSO
  49
  50 memcached(1) libmemcached(3) memcached_strerror(3)
  51
  52 =cut