Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

memcached_analyze (3libmemcached)

Name

memcached_analyze - libmemcached Documentation Analyze server information

Synopsis

#include <libmemcached/memcached.h>

memcached_analysis_st

memcached_analysis_st   *   memcached_analyze(memcached_st *ptr,   mem-
cached_stat_st *stat, memcached_return_t *error)

Compile and link with -lmemcached

Description

libmemcached                                  MEMCACHED_ANALYZE(3libmemcached)



NAME
       memcached_analyze - libmemcached Documentation

       Analyze server information

SYNOPSIS
       #include <libmemcached/memcached.h>

       memcached_analysis_st

       memcached_analysis_st   *   memcached_analyze(memcached_st *ptr,   mem-
       cached_stat_st *stat, memcached_return_t *error)

       Compile and link with -lmemcached

DESCRIPTION
       libmemcached has the ability to query a memcached server (or collection
       of  servers)  for  their  current state. Queries to find state return a
       memcached_analysis_st structure. You are responsible for  freeing  this
       structure.

       memcached_analyze()  analyzes  useful information based on the provided
       servers and sets the result to the memcached_analysis_st structure. The
       return value must be freed by the calling application.

       A command line tool, memstat with the option memstat --analyze, is pro-
       vided so that you do not have to  write  an  application  to  use  this
       method.

RETURN
       A  pointer  to the allocated memcached_analysis_st structure on success
       and a NULL pointer on failure. You may  inspect  the  error  detail  by
       checking the memcached_return_t value.

       Any  method  returning  a memcached_analysis_st expects you to free the
       memory allocated for it.

HOME
       To find out more information please check: http://libmemcached.org/


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+----------------------+
       |ATTRIBUTE TYPE |   ATTRIBUTE VALUE    |
       +---------------+----------------------+
       |Availability   | library/libmemcached |
       +---------------+----------------------+
       |Stability      | Uncommitted          |
       +---------------+----------------------+

SEE ALSO
       memcached(1) libmemcached(3) memcached_strerror(3)

AUTHOR
       Brian Aker

COPYRIGHT
       2011-2013, Brian Aker DataDifferential, http://datadifferential.com/



NOTES
       Source code for open source software components in Oracle  Solaris  can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This    software    was    built    from    source     available     at
       https://github.com/oracle/solaris-userland.    The  original  community
       source    was    downloaded     from      https://launchpad.net/libmem-
       cached/1.0/1.0.18/+download/libmemcached-1.0.18.tar.gz.

       Further information about this software can be found on the open source
       community website at http://libmemcached.org/libMemcached.html.



1.0.18                         February 09, 2014
                                              MEMCACHED_ANALYZE(3libmemcached)