X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=libmemcached%2Fmemcached.h;h=9ac0df70e42b585ba4a3425b5ce578128c560004;hb=29db6c77e126d9ae0c416ad76402fdbef7372cdb;hp=d3ec176e827ff72bc564c99c8ac1a8feadb9fdc0;hpb=8af90ac15d8ba8ec464e5ad402ed2d27b95f81e3;p=awesomized%2Flibmemcached diff --git a/libmemcached/memcached.h b/libmemcached/memcached.h index d3ec176e..9ac0df70 100644 --- a/libmemcached/memcached.h +++ b/libmemcached/memcached.h @@ -12,235 +12,119 @@ #include #include +#if !defined(__cplusplus) +# include +#endif #include #include +#ifdef MEMCACHED_INTERNAL +#include +#endif +#include +#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 +#define MEMCACHED_VERSION_STRING_LENGTH 24 /* string value */ -#define LIBMEMCACHED_VERSION_STRING "0.17" - -typedef enum { - MEMCACHED_SUCCESS, - MEMCACHED_FAILURE, - MEMCACHED_HOST_LOOKUP_FAILURE, - MEMCACHED_CONNECTION_FAILURE, - MEMCACHED_CONNECTION_BIND_FAILURE, - MEMCACHED_WRITE_FAILURE, - MEMCACHED_READ_FAILURE, - MEMCACHED_UNKNOWN_READ_FAILURE, - MEMCACHED_PROTOCOL_ERROR, - MEMCACHED_CLIENT_ERROR, - MEMCACHED_SERVER_ERROR, - MEMCACHED_CONNECTION_SOCKET_CREATE_FAILURE, - MEMCACHED_DATA_EXISTS, - MEMCACHED_DATA_DOES_NOT_EXIST, - MEMCACHED_NOTSTORED, - MEMCACHED_STORED, - MEMCACHED_NOTFOUND, - MEMCACHED_MEMORY_ALLOCATION_FAILURE, - MEMCACHED_PARTIAL_READ, - MEMCACHED_SOME_ERRORS, - MEMCACHED_NO_SERVERS, - MEMCACHED_END, - MEMCACHED_DELETED, - MEMCACHED_VALUE, - MEMCACHED_STAT, - MEMCACHED_ERRNO, - MEMCACHED_FAIL_UNIX_SOCKET, - MEMCACHED_NOT_SUPPORTED, - MEMCACHED_NO_KEY_PROVIDED, - MEMCACHED_FETCH_NOTFINISHED, - MEMCACHED_TIMEOUT, - MEMCACHED_BUFFERED, - MEMCACHED_BAD_KEY_PROVIDED, - MEMCACHED_MAXIMUM_RETURN, /* Always add new error code before */ -} memcached_return; - -typedef struct memcached_st memcached_st; -typedef struct memcached_stat_st memcached_stat_st; -typedef struct memcached_result_st memcached_result_st; -typedef struct memcached_string_st memcached_string_st; -typedef struct memcached_server_st memcached_server_st; -typedef memcached_return (*memcached_clone_func)(memcached_st *parent, memcached_st *clone); -typedef memcached_return (*memcached_cleanup_func)(memcached_st *ptr); -typedef void (*memcached_free_function)(memcached_st *ptr, void *mem); -typedef void *(*memcached_malloc_function)(memcached_st *ptr, const size_t size); -typedef void *(*memcached_realloc_function)(memcached_st *ptr, void *mem, const size_t size); -typedef memcached_return (*memcached_execute_function)(memcached_st *ptr, memcached_result_st *result, void *context); -typedef memcached_return (*memcached_server_function)(memcached_st *ptr, memcached_server_st *server, void *context); - -typedef enum { - MEMCACHED_DISTRIBUTION_MODULA, - MEMCACHED_DISTRIBUTION_CONSISTENT, -} memcached_server_distribution; - -typedef enum { - MEMCACHED_BEHAVIOR_NO_BLOCK, - MEMCACHED_BEHAVIOR_TCP_NODELAY, - MEMCACHED_BEHAVIOR_HASH, - MEMCACHED_BEHAVIOR_KETAMA, - MEMCACHED_BEHAVIOR_SOCKET_SEND_SIZE, - MEMCACHED_BEHAVIOR_SOCKET_RECV_SIZE, - MEMCACHED_BEHAVIOR_CACHE_LOOKUPS, - MEMCACHED_BEHAVIOR_SUPPORT_CAS, - MEMCACHED_BEHAVIOR_POLL_TIMEOUT, - MEMCACHED_BEHAVIOR_DISTRIBUTION, - MEMCACHED_BEHAVIOR_BUFFER_REQUESTS, - MEMCACHED_BEHAVIOR_USER_DATA, - MEMCACHED_BEHAVIOR_SORT_HOSTS, - MEMCACHED_BEHAVIOR_VERIFY_KEY, - MEMCACHED_BEHAVIOR_CONNECT_TIMEOUT, - MEMCACHED_BEHAVIOR_RETRY_TIMEOUT, -} memcached_behavior; - -typedef enum { - MEMCACHED_CALLBACK_USER_DATA, - MEMCACHED_CALLBACK_CLEANUP_FUNCTION, - MEMCACHED_CALLBACK_CLONE_FUNCTION, - MEMCACHED_CALLBACK_MALLOC_FUNCTION, - MEMCACHED_CALLBACK_REALLOC_FUNCTION, - MEMCACHED_CALLBACK_FREE_FUNCTION, -} memcached_callback; - -typedef enum { - MEMCACHED_HASH_DEFAULT= 0, - MEMCACHED_HASH_MD5, - MEMCACHED_HASH_CRC, - MEMCACHED_HASH_FNV1_64, - MEMCACHED_HASH_FNV1A_64, - MEMCACHED_HASH_FNV1_32, - MEMCACHED_HASH_FNV1A_32, - MEMCACHED_HASH_KETAMA, - MEMCACHED_HASH_HSIEH, - MEMCACHED_HASH_MURMUR, -} memcached_hash; - -typedef enum { - MEMCACHED_CONNECTION_UNKNOWN, - MEMCACHED_CONNECTION_TCP, - MEMCACHED_CONNECTION_UDP, - MEMCACHED_CONNECTION_UNIX_SOCKET, -} memcached_connection; - -typedef enum { - MEMCACHED_NOT_ALLOCATED, - MEMCACHED_ALLOCATED, - MEMCACHED_USED, -} memcached_allocated; - -struct memcached_server_st { - char hostname[MEMCACHED_MAX_HOST_LENGTH]; - unsigned int port; - int fd; - int cached_errno; - unsigned int cursor_active; - char write_buffer[MEMCACHED_MAX_BUFFER]; - size_t write_buffer_offset; - char read_buffer[MEMCACHED_MAX_BUFFER]; - size_t read_data_length; - size_t read_buffer_length; - char *read_ptr; - memcached_allocated sockaddr_inited; - struct addrinfo *address_info; - memcached_connection type; - uint8_t major_version; - uint8_t minor_version; - uint8_t micro_version; - uint16_t count; - time_t next_retry; - memcached_st *root; +struct memcached_continuum_item_st { + uint32_t index; + uint32_t value; +}; + +#define LIBMEMCACHED_VERSION_STRING "0.30" + +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_string_st { - memcached_st *root; - memcached_allocated is_allocated; - char *string; - char *end; - size_t current_size; - size_t block_size; -}; - -struct memcached_result_st { - memcached_allocated is_allocated; - memcached_st *root; - char key[MEMCACHED_MAX_KEY]; - size_t key_length; - memcached_string_st value; - uint32_t flags; - uint64_t cas; - /* Add result callback function */ -}; - struct memcached_st { - memcached_allocated is_allocated; + uint8_t purging; + bool is_allocated; + uint8_t distribution; + uint8_t hash; + uint32_t continuum_points_counter; memcached_server_st *hosts; - unsigned int number_of_hosts; - unsigned int cursor_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; 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]; + time_t next_distribution_rebuild; + size_t prefix_key_length; + memcached_hash hash_continuum; + memcached_result_st result; + memcached_continuum_item_st *continuum; 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; -#ifdef NOT_USED /* Future Use */ - uint8_t replicas; - memcached_return warning; -#endif + memcached_calloc_function call_calloc; + memcached_trigger_key get_key_failure; + memcached_trigger_delete_key delete_trigger; + char prefix_key[MEMCACHED_PREFIX_KEY_MAX_SIZE]; + uint32_t number_of_replicas; }; + /* Public API */ const char * memcached_lib_version(void); @@ -248,16 +132,30 @@ memcached_st *memcached_create(memcached_st *ptr); void memcached_free(memcached_st *ptr); memcached_st *memcached_clone(memcached_st *clone, memcached_st *ptr); -memcached_return memcached_delete(memcached_st *ptr, char *key, size_t key_length, +memcached_return 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, + 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, + const char *key, size_t key_length, uint32_t offset, uint64_t *value); +memcached_return 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); +memcached_return 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); 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, @@ -269,144 +167,61 @@ 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); +/* The two public hash bits */ +uint32_t memcached_generate_hash_value(const char *key, size_t key_length, memcached_hash hash_algorithm); +uint32_t memcached_generate_hash(memcached_st *ptr, const char *key, size_t key_length); -/* Server Public functions */ -#define memcached_server_count(A) (A)->number_of_hosts -#define memcached_server_name(A,B) (B).hostname -#define memcached_server_port(A,B) (B).port -#define memcached_server_list(A) (A)->hosts -#define memcached_server_response_count(A) (A)->cursor_active +memcached_return memcached_flush_buffers(memcached_st *mem); +/* Server Public functions */ memcached_return memcached_server_add_udp(memcached_st *ptr, - char *hostname, + const 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, + const char *filename); +memcached_return memcached_server_add(memcached_st *ptr, const char *hostname, unsigned int port); + +memcached_return memcached_server_add_udp_with_weight(memcached_st *ptr, + const char *hostname, + unsigned int port, + uint32_t weight); +memcached_return memcached_server_add_unix_socket_with_weight(memcached_st *ptr, + const char *filename, + uint32_t weight); +memcached_return memcached_server_add_with_weight(memcached_st *ptr, const char *hostname, + unsigned int port, + uint32_t weight); 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); + const char *hostname, + unsigned int port, + memcached_return *error); +memcached_server_st *memcached_server_list_append_with_weight(memcached_server_st *ptr, + const char *hostname, + unsigned int port, + uint32_t weight, + memcached_return *error); unsigned int memcached_server_list_count(memcached_server_st *ptr); -memcached_server_st *memcached_servers_parse(char *server_strings); +memcached_server_st *memcached_servers_parse(const char *server_strings); char *memcached_stat_get_value(memcached_st *ptr, memcached_stat_st *stat, - char *key, memcached_return *error); + const 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, + const char *master_key, size_t master_key_length, + const 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), + memcached_execute_function *callback, void *context, - unsigned int number_of_callbacks - ); + unsigned int number_of_callbacks); memcached_return memcached_callback_set(memcached_st *ptr, memcached_callback flag, @@ -415,59 +230,32 @@ 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); - -/* Result Struct */ -void memcached_result_free(memcached_result_st *result); -memcached_result_st *memcached_result_create(memcached_st *ptr, - memcached_result_st *result); -#define memcached_result_key_value(A) (A)->key -#define memcached_result_key_length(A) (A)->key_length -#ifdef FIX -#define memcached_result_value(A) memcached_string_value((A)->value) -#define memcached_result_length(A) memcached_string_length((A)->value) -#else -char *memcached_result_value(memcached_result_st *ptr); -size_t memcached_result_length(memcached_result_st *ptr); -#endif -#define memcached_result_flags(A) (A)->flags -#define memcached_result_cas(A) (A)->cas - - -#ifndef __WATCHPOINT_H__ -#define __WATCHPOINT_H__ -/* Some personal debugging functions */ -#ifdef HAVE_DEBUG -#define WATCHPOINT fprintf(stderr, "\nWATCHPOINT %s:%d (%s)\n", __FILE__, __LINE__,__func__);fflush(stdout); -#ifdef __MEMCACHED_H__ -#define WATCHPOINT_ERROR(A) fprintf(stderr, "\nWATCHPOINT %s:%d %s\n", __FILE__, __LINE__, memcached_strerror(NULL, A));fflush(stdout); -#define WATCHPOINT_IFERROR(A) if(A != MEMCACHED_SUCCESS)fprintf(stderr, "\nWATCHPOINT %s:%d %s\n", __FILE__, __LINE__, memcached_strerror(NULL, A));fflush(stdout); -#endif -#define WATCHPOINT_STRING(A) fprintf(stderr, "\nWATCHPOINT %s:%d (%s) %s\n", __FILE__, __LINE__,__func__,A);fflush(stdout); -#define WATCHPOINT_STRING_LENGTH(A,B) fprintf(stderr, "\nWATCHPOINT %s:%d (%s) %.*s\n", __FILE__, __LINE__,__func__,(int)B,A);fflush(stdout); -#define WATCHPOINT_NUMBER(A) fprintf(stderr, "\nWATCHPOINT %s:%d (%s) %zu\n", __FILE__, __LINE__,__func__,(size_t)(A));fflush(stdout); -#define WATCHPOINT_ERRNO(A) fprintf(stderr, "\nWATCHPOINT %s:%d (%s) %s\n", __FILE__, __LINE__,__func__, strerror(A));fflush(stdout); -#define WATCHPOINT_ASSERT(A) assert((A)); -#else -#define WATCHPOINT -#ifdef __MEMCACHED_H__ -#define WATCHPOINT_ERROR(A) -#define WATCHPOINT_IFERROR(A) -#endif -#define WATCHPOINT_STRING(A) -#define WATCHPOINT_NUMBER(A) -#define WATCHPOINT_ERRNO(A) -#define WATCHPOINT_ASSERT(A) -#endif +memcached_return memcached_dump(memcached_st *ptr, memcached_dump_func *function, void *context, uint32_t number_of_callbacks); + + +memcached_return memcached_set_memory_allocators(memcached_st *ptr, + memcached_malloc_function mem_malloc, + memcached_free_function mem_free, + memcached_realloc_function mem_realloc, + memcached_calloc_function mem_calloc); -#endif /* __WATCHPOINT_H__ */ +void memcached_get_memory_allocators(memcached_st *ptr, + memcached_malloc_function *mem_malloc, + memcached_free_function *mem_free, + memcached_realloc_function *mem_realloc, + memcached_calloc_function *mem_calloc); +void *memcached_get_user_data(memcached_st *ptr); +void *memcached_set_user_data(memcached_st *ptr, void *data); #ifdef __cplusplus } #endif +#include + +#ifdef MEMCACHED_INTERNAL +#include +#endif + #endif /* __MEMCACHED_H__ */