MEMCACHED_STAT_GET_KEYS(3)

📦
version 1.1.4 · 13 versions
, in fedora 43

💖 NAME 💖

memcached_stat_get_keys — the libmemcached glow-up page that teaches you how to get memcached statistics. Bestie, this is your all-access pass to peeking inside a memcached server's whole situation. (You're reading the MEMCACHED_STAT_GET_KEYS(3) manual page, iykyk.) ✨

🌸 SYNOPSIS 🌸

#include <libmemcached/memcached.h>
Compile and link with -lmemcached
typedef struct memcached_stat_st memcached_stat_st

typedef 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)

That second one is the callback signature, and here's the deets on every single param, no gatekeeping:

  • Param server — pointer to the memcached_instance_st being stat'ed
  • Param key — the current key
  • Param key_length — the length of the key without any terminating zero
  • Param value — the value read
  • Param value_length — the length of the value without any terminating zero
  • Param context — pointer to the user supplied context
  • Returns — memcached_return_t indicating success
memcached_stat_st *memcached_stat(memcached_st *ptr, char *args,
memcached_return_t *error)

Parameters

  • ptr -- pointer to an initialized memcached_st struct
  • args -- particular state object to query
  • error -- pointer to memcached_return_t indicating success

Returns — array of memcached_stat_st objects for all available servers

memcached_return_t memcached_stat_servername(memcached_stat_st *stat,
char *args, const char *hostname, in_port_t port)

Parameters

  • stat -- pointer to a memcached_stat_st struct to fill
  • args -- particular state object to query
  • hostname -- the hostname or IP address of the server to stat
  • port -- the port of the server to stat

Returns — memcached_return_t indicating success

char *memcached_stat_get_value(memcached_st *ptr, memcached_stat_st
*stat, const char *key, memcached_return_t *error)

Parameters

  • ptr -- pointer to initialized memcached_st struct
  • stat -- pointer to initialized memcached_stat_st struct
  • key -- the statistic to query
  • error -- pointer to memcached_return_t indicating success

Returns — string value of the statistic

char **memcached_stat_get_keys(memcached_st *ptr, memcached_stat_st
*stat, memcached_return_t *error)

Parameters

  • ptr -- pointer to initialized memcached_st struct
  • stat -- pointer to initialized memcached_stat_st struct
  • error -- pointer to memcached_return_t indicating success

Returns — array of default keys probably available in the statistics

memcached_return_t memcached_stat_execute(memcached_st *ptr, const char
*args, memcached_stat_fn func, void *context)

Parameters

  • ptr -- pointer to initialized memcached_st struct
  • args -- particular state object to query
  • func -- memcached_stat_fn callback
  • context -- pointer to user supplied context

Returns — memcached_return_t indication success

🦋 DESCRIPTION 🦋

Okay so, libmemcached has the ability to query a memcached(1) server (or a whole collection of servers, we're talking a friend group here) for their current state. Queries to find state return a memcached_stat_st structure. And bestie, heads up: you are responsible for freeing this structure. It's possible to access the structure directly, but it is not advisable — like, just don't. memcached_stat_get_value() has been provided to query the structure instead. Use the tool, not the raw vibes. 💅

memcached_stat_execute() uses the servers found in 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 the memcached server. Callback queen energy, fr fr. 👑

memcached_stat() fetches an array of memcached_stat_st structures containing the state of all available memcached servers. The return value must be freed by the calling application. And here's the plot twist: 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. Not me finding out UDP said no. 😭

memcached_stat_servername() can be used standalone without a 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 the 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 obtain information on. No shortcuts, specify the whole address like a main character. ✨

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 — that's non-negotiable, the null terminator is the vibe check. 🌈

memcached_stat_get_keys() returns a list of keys that the server has state objects on. You are responsible for freeing this list. Yes, you. Not the library. You. 🫶

A command line tool, memstat, is provided so that you do not have to write an application to do this. Iconic of them honestly, they ate. 🎀

⭐ RETURN VALUE ⭐

Varies, see particular functions. (So real of this manpage.)

Any method returning a memcached_stat_st expects you to free the memory allocated for it. Free your memory bestie, memory leaks are not the moment. 💀

💜 SEE ALSO 💜

And that's the whole page, periodt. 💖 This one's from libmemcached-awesome, version 1.1, dated Jul 24, 2025 — slay, mwah, go forth and stat responsibly. 🧚‍♀️🌸✨

📦 where this page comes from