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

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