Man page - memcached_stat(3)
Packages contas this manual
- memcached_server_list_append(3)
- libmemcached(3)
- memcached_version(3)
- memcached_delete_by_key(3)
- memcached_get(3)
- memcached_replace(3)
- memcached_stats(3)
- memcached_pool_create(3)
- memcached_callback_get(3)
- memcached_fetch_execute(3)
- memcached_touch(3)
- memcached_result_length(3)
- memcached_create(3)
- memcached_decrement(3)
- memcached_lib_version(3)
- memcached_servers(3)
- memcached_dump(3)
- memcached_behavior(3)
- memcached_last_error_errno(3)
- memcached_destroy_sasl_auth_data(3)
- memcached_set_sasl_callbacks(3)
- memcached_delete(3)
- memcached_quit(3)
- memcached_flush_buffers(3)
- memcached_fetch_result(3)
- memcached_replace_by_key(3)
- memcached_exist(3)
- memcached_server_push(3)
- memcached_prepend_by_key(3)
- memcached_mget(3)
- memcached_server_cursor(3)
- libmemcachedutil(3)
- memcached_clone(3)
- memcached_sasl(3)
- memcached_result_value(3)
- memcached_result_create(3)
- memcached_stat_get_keys(3)
- memcached_mget_execute_by_key(3)
- memcached_result_flags(3)
- memcached_decrement_with_initial(3)
- memcached_add(3)
- memcached_set_by_key(3)
- memcached_callback_set(3)
- memcached_touch_by_key(3)
- memcached_servers_parse(3)
- memcached_set_memory_allocators(3)
- memcached_stat_servername(3)
- memcached_last_error_message(3)
- memcached(3)
- memcached_behavior_set(3)
- memcached_server_list_free(3)
- memcached_server_list_count(3)
- memcached_server_add(3)
- memcached_pool_st(3)
- memcached_get_by_key(3)
- memcached_behavior_get(3)
- memcached_callback(3)
- memcached_set_user_data(3)
- memcached_last_error(3)
- memcached_server_count(3)
- memcached_server_list(3)
- memcached_set(3)
- memcached_result_st(3)
- libmemcached_check_configuration(3)
- memcached_increment_with_initial(3)
- memcached_cas_by_key(3)
- memcached_get_memory_allocators(3)
- memcached_result_free(3)
- memcached_memory_allocators(3)
- memcached_set_encoding_key(3)
- memcached_flush(3)
- memcached_append_by_key(3)
- memcached_stat(3)
- memcached_prepend(3)
- memcached_cas(3)
- memcached_servers_reset(3)
- memcached_server_st(3)
- memcached_verbosity(3)
- libmemcached_examples(3)
- memcached_stat_execute(3)
- memcached_pool_behavior_set(3)
- memcached_increment(3)
- memcached_pool_destroy(3)
- memcached_fetch(3)
- memcached_get_sasl_callbacks(3)
- memcached_add_by_key(3)
- memcached_mget_by_key(3)
- libmemcached_configuration(3)
- memcached_return_t(3)
- memcached_result_key_value(3)
- memcached_stat_get_value(3)
- memcached_set_memory_allocators_context(3)
- memcached_get_user_data(3)
- memcached_pool_push(3)
- memcached_pool(3)
- memcached_free(3)
- memcached_pool_behavior_get(3)
- memcached_strerror(3)
- memcached_user_data(3)
- memcached_mget_execute(3)
- memcached_result_cas(3)
- memcached_exist_by_key(3)
- memcached_append(3)
- memcached_pool_fetch(3)
- memcached_result_key_length(3)
- memcached_server_add_unix_socket(3)
- memcached_pool_pop(3)
- memcached_pool_release(3)
- memcached_sasl_set_auth_data(3)
- memcached_generate_hash(3)
- memcached_auto(3)
- memcached_analyze(3)
- memcached_generate_hash_value(3)
apt-get install libmemcached-dev
Manual
| MEMCACHED_STAT(3) | libmemcached-awesome | MEMCACHED_STAT(3) |
NAME
memcached_stat - libmemcached Documentation
Get memcached statistics
SYNOPSIS
- #include <libmemcached/memcached.h>
- Compile and link with -lmemcached
- 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
- 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
- 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
- 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
- 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
- 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
libmemcached has the ability to query a memcached(1) server (or collection of servers) for their current state. Queries to find state return a memcached_stat_st structure. You are responsible for freeing this structure. While it is possible to access the structure directly it is not advisable. memcached_stat_get_value() has been provided to query the structure.
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.
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. 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.
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.
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.
memcached_stat_get_keys() returns a list of keys that the server has state objects on. You are responsible for freeing this list.
A command line tool, memstat, is provided so that you do not have to write an application to do this.
RETURN VALUE
Varies, see particular functions.
Any method returning a memcached_stat_st expects you to free the memory allocated for it.
SEE ALSO
memcached(1) libmemcached(3) memcached_strerror(3)
| October 29, 2024 | 1.1 |