X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=include%2Fmemcached.h;h=7fd94e7d70abb674b33b5556ed0680b59e32260e;hb=013715211f094bb98ab7ed830b6cd24328641eba;hp=29195de09076ca69fe9bcc2a658a3f0383dc3902;hpb=3bcf5c0efffbf64b6b6eccf140f057d2373fa974;p=awesomized%2Flibmemcached diff --git a/include/memcached.h b/include/memcached.h index 29195de0..7fd94e7d 100644 --- a/include/memcached.h +++ b/include/memcached.h @@ -11,7 +11,7 @@ #define __MEMCACHED_H__ #include -#include +#include #include #include @@ -19,23 +19,25 @@ extern "C" { #endif -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; +/* 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_DEFAULT_COMMAND_SIZE 350 -#define SMALL_STRING_LEN 1024 -#define HUGE_STRING_LEN 8196 #define MEMCACHED_MAX_KEY 251 /* We add one to have it null terminated */ -#define MEMCACHED_MAX_BUFFER HUGE_STRING_LEN +#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.17" typedef enum { MEMCACHED_SUCCESS, MEMCACHED_FAILURE, - MEMCACHED_HOST_LOCKUP_FAILURE, + MEMCACHED_HOST_LOOKUP_FAILURE, MEMCACHED_CONNECTION_FAILURE, MEMCACHED_CONNECTION_BIND_FAILURE, MEMCACHED_WRITE_FAILURE, @@ -62,9 +64,31 @@ typedef enum { 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, @@ -72,8 +96,26 @@ typedef enum { 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; +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, @@ -83,6 +125,8 @@ typedef enum { MEMCACHED_HASH_FNV1_32, MEMCACHED_HASH_FNV1A_32, MEMCACHED_HASH_KETAMA, + MEMCACHED_HASH_HSIEH, + MEMCACHED_HASH_MURMUR, } memcached_hash; typedef enum { @@ -95,50 +139,56 @@ typedef enum { typedef enum { MEMCACHED_NOT_ALLOCATED, MEMCACHED_ALLOCATED, + MEMCACHED_USED, } memcached_allocated; struct memcached_server_st { - char *hostname; + char hostname[MEMCACHED_MAX_HOST_LENGTH]; unsigned int port; int fd; - unsigned int stack_responses; + 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; - struct sockaddr_in servAddr; + 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; + memcached_st *root; }; struct memcached_stat_st { - unsigned int pid; - unsigned int uptime; - unsigned int threads; - time_t time; - char version[8]; - unsigned int pointer_size; - unsigned int rusage_user; - unsigned int rusage_system; - unsigned int rusage_user_seconds; - unsigned int rusage_user_microseconds; - unsigned int rusage_system_seconds; - unsigned int rusage_system_microseconds; - unsigned int curr_items; - unsigned int total_items; - unsigned long long bytes; - unsigned int curr_connections; - unsigned int total_connections; - unsigned int connection_structures; - unsigned long long cmd_get; - unsigned long long cmd_set; - unsigned long long get_hits; - unsigned long long get_misses; - unsigned long long evictions; - unsigned long long bytes_read; - unsigned long long bytes_written; - unsigned int limit_maxbytes; + 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 total_connections; + uint32_t connection_structures; + uint64_t bytes; + uint64_t cmd_get; + uint64_t cmd_set; + uint64_t get_hits; + uint64_t get_misses; + uint64_t evictions; + uint64_t bytes_read; + uint64_t bytes_written; + char version[MEMCACHED_VERSION_STRING_LENGTH]; }; struct memcached_string_st { @@ -156,8 +206,9 @@ struct memcached_result_st { char key[MEMCACHED_MAX_KEY]; size_t key_length; memcached_string_st value; - uint16_t flags; + uint32_t flags; uint64_t cas; + /* Add result callback function */ }; struct memcached_st { @@ -165,17 +216,31 @@ struct memcached_st { memcached_server_st *hosts; unsigned int number_of_hosts; unsigned int cursor_server; - char connected; int cached_errno; - unsigned long long flags; + uint32_t flags; int send_size; int recv_size; - memcached_string_st result_buffer; + int32_t poll_timeout; + int32_t connect_timeout; + memcached_result_st result; memcached_hash hash; - memcached_return warning; /* Future Use */ + memcached_server_distribution distribution; + 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; +#ifdef NOT_USED /* Future Use */ + uint8_t replicas; + memcached_return warning; +#endif }; /* Public API */ +const char * memcached_lib_version(void); + memcached_st *memcached_create(memcached_st *ptr); void memcached_free(memcached_st *ptr); memcached_st *memcached_clone(memcached_st *clone, memcached_st *ptr); @@ -184,11 +249,11 @@ memcached_return memcached_delete(memcached_st *ptr, char *key, size_t key_lengt time_t expiration); memcached_return memcached_increment(memcached_st *ptr, char *key, size_t key_length, - unsigned int offset, + uint32_t offset, uint64_t *value); memcached_return memcached_decrement(memcached_st *ptr, char *key, size_t key_length, - unsigned int offset, + uint32_t offset, 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); @@ -205,37 +270,54 @@ unsigned long long memcached_behavior_get(memcached_st *ptr, memcached_behavior memcached_return memcached_set(memcached_st *ptr, char *key, size_t key_length, char *value, size_t value_length, time_t expiration, - uint16_t flags); + 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, - uint16_t flags); + 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, - uint16_t flags); + 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, - uint16_t *flags, + 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, uint16_t *flags, + 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); /* 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,B) A->hosts[B].stack_responses +#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_server_add_udp(memcached_st *ptr, char *hostname, @@ -258,21 +340,98 @@ char *memcached_stat_get_value(memcached_st *ptr, memcached_stat_st *stat, 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); + /* 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 +#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) +#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 +#define memcached_result_flags(A) (A)->flags +#define memcached_result_cas(A) (A)->cas #ifndef __WATCHPOINT_H__ @@ -282,23 +441,18 @@ size_t memcached_result_length(memcached_result_st *ptr); #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));A= 0;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 { 1; }; -#define WATCHPOINT_ERROR(A) { 1; }; -#define WATCHPOINT_STRING(A) { 1; }; -#define WATCHPOINT_NUMBER(A) { 1; }; -#define WATCHPOINT_ERRNO(A) { 1; }; -#define WATCHPOINT_ASSERT(A) { 1; }; -*/ #define WATCHPOINT #ifdef __MEMCACHED_H__ #define WATCHPOINT_ERROR(A) +#define WATCHPOINT_IFERROR(A) #endif #define WATCHPOINT_STRING(A) #define WATCHPOINT_NUMBER(A)