X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=libmemcached%2Fmemcached.h;h=60c63b58565253cbc302ecb02941d70295671298;hb=824533fd2626b1060855e543aaad381675ae2695;hp=bbf82e231367e74d2de518cd8bad26f5c08f6f15;hpb=3b706525e1b66b907905bb9eddd7fd824e8311de;p=m6w6%2Flibmemcached diff --git a/libmemcached/memcached.h b/libmemcached/memcached.h index bbf82e23..ddde6952 100644 --- a/libmemcached/memcached.h +++ b/libmemcached/memcached.h @@ -1,10 +1,13 @@ -/* +/* LibMemcached + * Copyright (C) 2006-2009 Brian Aker + * All rights reserved. + * + * Use and distribution licensed under the BSD license. See + * the COPYING file in the parent directory for full text. + * * Summary: interface for memcached server * Description: main include file for libmemcached * - * Copy: See Copyright for the status of this software. - * - * Author: Brian Aker */ #ifndef __MEMCACHED_H__ @@ -12,268 +15,341 @@ #include #include + +#if !defined(__cplusplus) +# include +#endif + #include #include -#include -#include -#include -#include -#include -#include -#include +#include +#include +#include +#include +#include +// Everything above this line must be in the order specified. +#include +#include +#include +#include +#include +#include +#include #ifdef __cplusplus extern "C" { #endif -/* These are Private and should not be used by applications */ -#define MEMCACHED_VERSION_STRING_LENGTH 12 - -/* Public defines */ -#define MEMCACHED_DEFAULT_PORT 11211 -#define MEMCACHED_MAX_KEY 251 /* We add one to have it null terminated */ -#define MEMCACHED_MAX_BUFFER 8196 -#define MEMCACHED_MAX_HOST_LENGTH 64 -#define MEMCACHED_WHEEL_SIZE 1024 -#define MEMCACHED_STRIDE 4 -#define MEMCACHED_DEFAULT_TIMEOUT INT32_MAX - -/* string value */ -#define LIBMEMCACHED_VERSION_STRING "0.18" +#define MEMCACHED_VERSION_STRING_LENGTH 24 + +struct memcached_analysis_st { + uint32_t average_item_size; + uint32_t longest_uptime; + uint32_t least_free_server; + uint32_t most_consumed_server; + uint32_t oldest_server; + double pool_hit_ratio; + uint64_t most_used_bytes; + uint64_t least_remaining_bytes; +}; struct memcached_stat_st { + uint32_t connection_structures; + uint32_t curr_connections; + uint32_t curr_items; uint32_t pid; - uint32_t uptime; - uint32_t threads; - uint32_t time; uint32_t pointer_size; - uint32_t rusage_user_seconds; - uint32_t rusage_user_microseconds; - uint32_t rusage_system_seconds; uint32_t rusage_system_microseconds; - uint32_t curr_items; - uint32_t total_items; - uint64_t limit_maxbytes; - uint32_t curr_connections; + uint32_t rusage_system_seconds; + uint32_t rusage_user_microseconds; + uint32_t rusage_user_seconds; + uint32_t threads; + uint32_t time; uint32_t total_connections; - uint32_t connection_structures; + uint32_t total_items; + uint32_t uptime; uint64_t bytes; + uint64_t bytes_read; + uint64_t bytes_written; uint64_t cmd_get; uint64_t cmd_set; + uint64_t evictions; uint64_t get_hits; uint64_t get_misses; - uint64_t evictions; - uint64_t bytes_read; - uint64_t bytes_written; + uint64_t limit_maxbytes; char version[MEMCACHED_VERSION_STRING_LENGTH]; }; struct memcached_st { - memcached_allocated is_allocated; + struct { + bool is_allocated:1; + bool is_initialized:1; + bool is_purging:1; + } options; + memcached_server_distribution_t distribution; + memcached_hash_t hash; + uint32_t continuum_points_counter; memcached_server_st *hosts; - unsigned int number_of_hosts; - unsigned int cursor_server; + memcached_server_st *last_disconnected_server; + int32_t snd_timeout; + int32_t rcv_timeout; + uint32_t server_failure_limit; + uint32_t io_msg_watermark; + uint32_t io_bytes_watermark; + uint32_t io_key_prefetch; + uint32_t number_of_hosts; + uint32_t cursor_server; int cached_errno; - uint32_t flags; - int send_size; - int recv_size; + struct { + bool auto_eject_hosts:1; + bool binary_protocol:1; + bool buffer_requests:1; + bool hash_with_prefix_key:1; + bool ketama_weighted:1; + bool no_block:1; + bool no_reply:1; + bool randomize_replica_read:1; + bool reuse_memory:1; + bool support_cas:1; + bool tcp_nodelay:1; + bool use_cache_lookups:1; + bool use_sort_hosts:1; + bool use_udp:1; + bool verify_key:1; + } flags; int32_t poll_timeout; int32_t connect_timeout; int32_t retry_timeout; - memcached_result_st result; - memcached_hash hash; - memcached_server_distribution distribution; + uint32_t continuum_count; + int send_size; + int recv_size; void *user_data; - unsigned int wheel[MEMCACHED_WHEEL_SIZE]; - memcached_clone_func on_clone; - memcached_cleanup_func on_cleanup; - memcached_free_function call_free; - memcached_malloc_function call_malloc; - memcached_realloc_function call_realloc; - memcached_trigger_key get_key_failure; -#ifdef NOT_USED /* Future Use */ - uint8_t replicas; - memcached_return warning; -#endif + time_t next_distribution_rebuild; + size_t prefix_key_length; + uint32_t number_of_replicas; + memcached_hash_t distribution_hash; + memcached_result_st result; + memcached_continuum_item_st *continuum; + memcached_clone_fn on_clone; + memcached_cleanup_fn on_cleanup; + memcached_free_fn call_free; + memcached_malloc_fn call_malloc; + memcached_realloc_fn call_realloc; + memcached_calloc_fn call_calloc; + memcached_trigger_key_fn get_key_failure; + memcached_trigger_delete_key_fn delete_trigger; + memcached_callback_st *callbacks; + char prefix_key[MEMCACHED_PREFIX_KEY_MAX_SIZE]; }; +LIBMEMCACHED_API +memcached_return_t memcached_version(memcached_st *ptr); + /* Public API */ + +LIBMEMCACHED_API const char * memcached_lib_version(void); +LIBMEMCACHED_API memcached_st *memcached_create(memcached_st *ptr); +LIBMEMCACHED_API void memcached_free(memcached_st *ptr); +LIBMEMCACHED_API memcached_st *memcached_clone(memcached_st *clone, memcached_st *ptr); -memcached_return memcached_delete(memcached_st *ptr, char *key, size_t key_length, +LIBMEMCACHED_API +memcached_return_t memcached_delete(memcached_st *ptr, const char *key, size_t key_length, time_t expiration); -memcached_return memcached_increment(memcached_st *ptr, - char *key, size_t key_length, +LIBMEMCACHED_API +memcached_return_t memcached_increment(memcached_st *ptr, + const char *key, size_t key_length, uint32_t offset, uint64_t *value); -memcached_return memcached_decrement(memcached_st *ptr, - char *key, size_t key_length, +LIBMEMCACHED_API +memcached_return_t memcached_decrement(memcached_st *ptr, + const char *key, size_t key_length, uint32_t offset, uint64_t *value); + +LIBMEMCACHED_API +memcached_return_t memcached_increment_by_key(memcached_st *ptr, + const char *master_key, size_t master_key_length, + const char *key, size_t key_length, + uint64_t offset, + uint64_t *value); + +LIBMEMCACHED_API +memcached_return_t memcached_decrement_by_key(memcached_st *ptr, + const char *master_key, size_t master_key_length, + const char *key, size_t key_length, + uint64_t offset, + uint64_t *value); + +LIBMEMCACHED_API +memcached_return_t memcached_increment_with_initial(memcached_st *ptr, + const char *key, + size_t key_length, + uint64_t offset, + uint64_t initial, + time_t expiration, + uint64_t *value); +LIBMEMCACHED_API +memcached_return_t memcached_decrement_with_initial(memcached_st *ptr, + const char *key, + size_t key_length, + uint64_t offset, + uint64_t initial, + time_t expiration, + uint64_t *value); +LIBMEMCACHED_API +memcached_return_t memcached_increment_with_initial_by_key(memcached_st *ptr, + const char *master_key, + size_t master_key_length, + const char *key, + size_t key_length, + uint64_t offset, + uint64_t initial, + time_t expiration, + uint64_t *value); +LIBMEMCACHED_API +memcached_return_t memcached_decrement_with_initial_by_key(memcached_st *ptr, + const char *master_key, + size_t master_key_length, + const char *key, + size_t key_length, + uint64_t offset, + uint64_t initial, + time_t expiration, + uint64_t *value); +LIBMEMCACHED_API void memcached_stat_free(memcached_st *, memcached_stat_st *); -memcached_stat_st *memcached_stat(memcached_st *ptr, char *args, memcached_return *error); -memcached_return memcached_stat_servername(memcached_stat_st *stat, char *args, - char *hostname, unsigned int port); -memcached_return memcached_flush(memcached_st *ptr, time_t expiration); -memcached_return memcached_verbosity(memcached_st *ptr, unsigned int verbosity); + +LIBMEMCACHED_API +memcached_stat_st *memcached_stat(memcached_st *ptr, char *args, memcached_return_t *error); + +LIBMEMCACHED_API +memcached_return_t memcached_stat_servername(memcached_stat_st *memc_stat, char *args, + const char *hostname, in_port_t port); + +LIBMEMCACHED_API +memcached_return_t memcached_flush(memcached_st *ptr, time_t expiration); + +LIBMEMCACHED_API +memcached_return_t memcached_verbosity(memcached_st *ptr, unsigned int verbosity); + +LIBMEMCACHED_API void memcached_quit(memcached_st *ptr); -char *memcached_strerror(memcached_st *ptr, memcached_return rc); -memcached_return memcached_behavior_set(memcached_st *ptr, memcached_behavior flag, uint64_t data); -uint64_t memcached_behavior_get(memcached_st *ptr, memcached_behavior flag); - -/* All of the functions for adding data to the server */ -memcached_return memcached_set(memcached_st *ptr, char *key, size_t key_length, - char *value, size_t value_length, - time_t expiration, - uint32_t flags); -memcached_return memcached_add(memcached_st *ptr, char *key, size_t key_length, - char *value, size_t value_length, - time_t expiration, - uint32_t flags); -memcached_return memcached_replace(memcached_st *ptr, char *key, size_t key_length, - char *value, size_t value_length, - time_t expiration, - uint32_t flags); -memcached_return memcached_append(memcached_st *ptr, - char *key, size_t key_length, - char *value, size_t value_length, - time_t expiration, - uint32_t flags); -memcached_return memcached_prepend(memcached_st *ptr, - char *key, size_t key_length, - char *value, size_t value_length, - time_t expiration, - uint32_t flags); -memcached_return memcached_cas(memcached_st *ptr, - char *key, size_t key_length, - char *value, size_t value_length, - time_t expiration, - uint32_t flags, - uint64_t cas); - -/* Get functions */ -char *memcached_get(memcached_st *ptr, char *key, size_t key_length, - size_t *value_length, - uint32_t *flags, - memcached_return *error); -memcached_return memcached_mget(memcached_st *ptr, - char **keys, size_t *key_length, - unsigned int number_of_keys); -char *memcached_fetch(memcached_st *ptr, char *key, size_t *key_length, - size_t *value_length, uint32_t *flags, - memcached_return *error); -memcached_result_st *memcached_fetch_result(memcached_st *ptr, - memcached_result_st *result, - memcached_return *error); + +LIBMEMCACHED_API +const char *memcached_strerror(memcached_st *ptr, memcached_return_t rc); + +/* The two public hash bits */ +LIBMEMCACHED_API +uint32_t memcached_generate_hash_value(const char *key, size_t key_length, memcached_hash_t hash_algorithm); + +LIBMEMCACHED_API +uint32_t memcached_generate_hash(memcached_st *ptr, const char *key, size_t key_length); + +LIBMEMCACHED_API +memcached_return_t memcached_flush_buffers(memcached_st *mem); /* Server Public functions */ -memcached_return memcached_server_add_udp(memcached_st *ptr, - char *hostname, - unsigned int port); -memcached_return memcached_server_add_unix_socket(memcached_st *ptr, - char *filename); -memcached_return memcached_server_add(memcached_st *ptr, char *hostname, - unsigned int port); +LIBMEMCACHED_API +memcached_return_t memcached_server_add_udp(memcached_st *ptr, + const char *hostname, + in_port_t port); +LIBMEMCACHED_API +memcached_return_t memcached_server_add_unix_socket(memcached_st *ptr, + const char *filename); +LIBMEMCACHED_API +memcached_return_t memcached_server_add(memcached_st *ptr, + const char *hostname, in_port_t port); + +LIBMEMCACHED_API +memcached_return_t memcached_server_add_udp_with_weight(memcached_st *ptr, + const char *hostname, + in_port_t port, + uint32_t weight); +LIBMEMCACHED_API +memcached_return_t memcached_server_add_unix_socket_with_weight(memcached_st *ptr, + const char *filename, + uint32_t weight); +LIBMEMCACHED_API +memcached_return_t memcached_server_add_with_weight(memcached_st *ptr, const char *hostname, + in_port_t port, + uint32_t weight); +LIBMEMCACHED_API void memcached_server_list_free(memcached_server_st *ptr); -memcached_return memcached_server_push(memcached_st *ptr, memcached_server_st *list); -memcached_server_st *memcached_server_list_append(memcached_server_st *ptr, - char *hostname, unsigned int port, - memcached_return *error); +LIBMEMCACHED_API +memcached_return_t memcached_server_push(memcached_st *ptr, memcached_server_st *list); + +LIBMEMCACHED_API +memcached_server_st *memcached_server_list_append(memcached_server_st *ptr, + const char *hostname, + in_port_t port, + memcached_return_t *error); +LIBMEMCACHED_API +memcached_server_st *memcached_server_list_append_with_weight(memcached_server_st *ptr, + const char *hostname, + in_port_t port, + uint32_t weight, + memcached_return_t *error); +LIBMEMCACHED_API unsigned int memcached_server_list_count(memcached_server_st *ptr); -memcached_server_st *memcached_servers_parse(char *server_strings); - -char *memcached_stat_get_value(memcached_st *ptr, memcached_stat_st *stat, - char *key, memcached_return *error); -char ** memcached_stat_get_keys(memcached_st *ptr, memcached_stat_st *stat, - memcached_return *error); - -char *memcached_get_by_key(memcached_st *ptr, - char *master_key, size_t master_key_length, - char *key, size_t key_length, - size_t *value_length, - uint32_t *flags, - memcached_return *error); - -memcached_return memcached_mget_by_key(memcached_st *ptr, - char *master_key, size_t master_key_length, - char **keys, size_t *key_length, - unsigned int number_of_keys); - -memcached_return memcached_set_by_key(memcached_st *ptr, - char *master_key, size_t master_key_length, - char *key, size_t key_length, - char *value, size_t value_length, - time_t expiration, - uint32_t flags); - -memcached_return memcached_add_by_key(memcached_st *ptr, - char *master_key, size_t master_key_length, - char *key, size_t key_length, - char *value, size_t value_length, - time_t expiration, - uint32_t flags); - -memcached_return memcached_replace_by_key(memcached_st *ptr, - char *master_key, size_t master_key_length, - char *key, size_t key_length, - char *value, size_t value_length, - time_t expiration, - uint32_t flags); - -memcached_return memcached_prepend_by_key(memcached_st *ptr, - char *master_key, size_t master_key_length, - char *key, size_t key_length, - char *value, size_t value_length, - time_t expiration, - uint32_t flags); - -memcached_return memcached_append_by_key(memcached_st *ptr, - char *master_key, size_t master_key_length, - char *key, size_t key_length, - char *value, size_t value_length, - time_t expiration, - uint32_t flags); - -memcached_return memcached_cas_by_key(memcached_st *ptr, - char *master_key, size_t master_key_length, - char *key, size_t key_length, - char *value, size_t value_length, - time_t expiration, - uint32_t flags, - uint64_t cas); -memcached_return memcached_delete_by_key(memcached_st *ptr, - char *master_key, size_t master_key_length, - char *key, size_t key_length, - time_t expiration); - -memcached_return memcached_fetch_execute(memcached_st *ptr, - unsigned int (*callback[])(memcached_st *ptr, memcached_result_st *result, void *context), - void *context, - unsigned int number_of_callbacks - ); - -memcached_return memcached_callback_set(memcached_st *ptr, - memcached_callback flag, - void *data); -void *memcached_callback_get(memcached_st *ptr, - memcached_callback flag, - memcached_return *error); - -memcached_return memcached_server_cursor(memcached_st *ptr, - memcached_server_function *callback, - void *context, - unsigned int number_of_callbacks); +LIBMEMCACHED_API +memcached_server_st *memcached_servers_parse(const char *server_strings); + +LIBMEMCACHED_API +char *memcached_stat_get_value(memcached_st *ptr, memcached_stat_st *memc_stat, + const char *key, memcached_return_t *error); +LIBMEMCACHED_API +char ** memcached_stat_get_keys(memcached_st *ptr, memcached_stat_st *memc_stat, + memcached_return_t *error); + +LIBMEMCACHED_API +memcached_return_t memcached_delete_by_key(memcached_st *ptr, + const char *master_key, size_t master_key_length, + const char *key, size_t key_length, + time_t expiration); + +LIBMEMCACHED_API +memcached_return_t memcached_fetch_execute(memcached_st *ptr, + memcached_execute_fn *callback, + void *context, + unsigned int number_of_callbacks); + +LIBMEMCACHED_API +memcached_return_t memcached_set_memory_allocators(memcached_st *ptr, + memcached_malloc_fn mem_malloc, + memcached_free_fn mem_free, + memcached_realloc_fn mem_realloc, + memcached_calloc_fn mem_calloc); + +LIBMEMCACHED_API +void memcached_get_memory_allocators(memcached_st *ptr, + memcached_malloc_fn *mem_malloc, + memcached_free_fn *mem_free, + memcached_realloc_fn *mem_realloc, + memcached_calloc_fn *mem_calloc); + +LIBMEMCACHED_API +void *memcached_get_user_data(memcached_st *ptr); +LIBMEMCACHED_API +void *memcached_set_user_data(memcached_st *ptr, void *data); + +LIBMEMCACHED_LOCAL +memcached_return_t run_distribution(memcached_st *ptr); + +#define memcached_is_allocated(__object) ((__object)->options.is_allocated) +#define memcached_is_initialized(__object) ((__object)->options.is_initialized) #ifdef __cplusplus } #endif + #endif /* __MEMCACHED_H__ */