git.m6w6.name Git - awesomized/libmemcached/blob - docs/source/libmemcached/memcached_stats.rst

   1 Working with statistical information from a server
   2 ==================================================
   3
   4 Get memcached statistics
   5
   6 .. index:: object: memcached_st
   7
   8 SYNOPSIS
   9 --------
  10
  11 #include <libmemcached/memcached.h>
  12
  13 .. type:: memcached_stat_st
  14
  15 .. type:: memcached_return_t (*memcached_stat_fn)(const memcached_instance_st * server, const char *key, size_t key_length, const char *value, size_t value_length, void *context)
  16
  17 .. function:: memcached_stat_st *memcached_stat (memcached_st *ptr, char *args, memcached_return_t *error)
  18
  19 .. function:: memcached_return_t memcached_stat_servername (memcached_stat_st *stat, char *args, const char *hostname, in_port_t port)
  20
  21 .. function:: char * memcached_stat_get_value (memcached_st *ptr, memcached_stat_st *stat, const char *key, memcached_return_t *error)
  22
  23 .. function:: char ** memcached_stat_get_keys (memcached_st *ptr, memcached_stat_st *stat, memcached_return_t *error)
  24
  25 .. function:: memcached_return_t memcached_stat_execute (memcached_st *memc, const char *args, memcached_stat_fn func, void *context)
  26
  27 Compile and link with -lmemcached
  28
  29 DESCRIPTION
  30 -----------
  31
  32 libmemcached(3) has the ability to query a memcached server (or collection
  33 of servers) for their current state. Queries to find state return a
  34 :type:`memcached_stat_st` structure. You are responsible for freeing this structure. While it is possible to access the structure directly it is not advisable. :func:`memcached_stat_get_value` has been provided to query the structure.
  35
  36 :func:`memcached_stat_execute` uses the servers found in :type:`memcached_stat_st` 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
  37 the memcached server.
  38
  39 :func:`memcached_stat` fetches an array of :type:`memcached_stat_st` structures containing the state of all available memcached servers. The return value must be freed by the calling application. If called with the `MEMCACHED_BEHAVIOR_USE_UDP` behavior set, a NULL value is returned and the error parameter is set to `MEMCACHED_NOT_SUPPORTED`.
  40
  41 :func:`memcached_stat_servername` can be used standalone without a :type:`memcached_st` 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
  42 the :func:`memcached_stat_get_keys` call nor are they defined in the memcached protocol). You must specify the hostname and port of the server you want to
  43 obtain information on.
  44
  45 :func:`memcached_stat_get_value` returns the value of a particular state key. You specify the key you wish to obtain.  The key must be null terminated.
  46
  47 :func:`memcached_stat_get_keys` returns a list of keys that the server has state objects on. You are responsible for freeing this list.
  48
  49 A command line tool, memstat(1), is provided so that you do not have to write
  50 an application to do this.
  51
  52 RETURN VALUE
  53 ------------
  54
  55 Varies, see particular functions.
  56
  57 Any method returning a :type:`memcached_stat_st` expects you to free the
  58 memory allocated for it.
  59
  60 SEE ALSO
  61 --------
  62
  63 .. only:: man
  64
  65   :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
  66