X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=include%2Fmemcached.h;h=315c284ba3742452199c3660e0f3de8c6c66af73;hb=6f50a6acc95303396a8a073c3746cdff83df2301;hp=a9c64359f2ca83bc7bbaaa7d5e4db6f646420ffb;hpb=f4ff3ba0a9f212ac1323fc056d61fefd3782093c;p=awesomized%2Flibmemcached diff --git a/include/memcached.h b/include/memcached.h index a9c64359..315c284b 100644 --- a/include/memcached.h +++ b/include/memcached.h @@ -10,19 +10,10 @@ #ifndef __MEMCACHED_H__ #define __MEMCACHED_H__ -#include #include -#include +#include #include -#include #include -#include -#include -#include -#include -#include -#include -#include #ifdef __cplusplus extern "C" { @@ -30,19 +21,26 @@ extern "C" { typedef struct memcached_st memcached_st; typedef struct memcached_stat_st memcached_stat_st; -typedef struct memcached_host_st memcached_host_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; +#define MEMCACHED_VERSION_STRING 12 #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 WATCHPOINT printf("WATCHPOINT %s:%d\n", __FILE__, __LINE__);fflush(stdout); +#define MEMCACHED_MAX_BUFFER HUGE_STRING_LEN +#define MEMCACHED_MAX_HOST_LENGTH 64 +#define MEMCACHED_WHEEL_SIZE 1024 +#define MEMCACHED_STRIDE 4 +#define MEMCACHED_DEFAULT_TIMEOUT INT32_MAX typedef enum { MEMCACHED_SUCCESS, MEMCACHED_FAILURE, - MEMCACHED_HOST_LOCKUP_FAILURE, + MEMCACHED_HOST_LOOKUP_FAILURE, MEMCACHED_CONNECTION_FAILURE, MEMCACHED_CONNECTION_BIND_FAILURE, MEMCACHED_WRITE_FAILURE, @@ -55,112 +53,358 @@ typedef enum { 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_MAXIMUM_RETURN, /* Always add new error code before */ } memcached_return; typedef enum { - MEMCACHED_NOT_ALLOCATED= 0, - MEMCACHED_ALLOCATED= 1, + 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; + +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; + +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_host_st { - char *hostname; +struct memcached_server_st { + char hostname[MEMCACHED_MAX_HOST_LENGTH]; unsigned int port; int fd; + unsigned int stack_responses; + unsigned int cursor_active; + char write_buffer[MEMCACHED_MAX_BUFFER]; + size_t write_buffer_offset; + char *write_ptr; + 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; }; 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; + uint32_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]; +}; + +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; }; struct memcached_st { memcached_allocated is_allocated; - memcached_host_st *hosts; + memcached_server_st *hosts; unsigned int number_of_hosts; unsigned int cursor_server; char connected; + int cached_errno; + unsigned long long flags; + int send_size; + int recv_size; + int32_t poll_timeout; + memcached_string_st result_buffer; + memcached_hash hash; + memcached_server_distribution distribution; + unsigned int wheel[MEMCACHED_WHEEL_SIZE]; + uint8_t replicas; + memcached_return warning; /* Future Use */ }; /* Public API */ -memcached_st *memcached_init(memcached_st *ptr); -void memcached_deinit(memcached_st *ptr); +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_set(memcached_st *ptr, char *key, size_t key_length, - char *value, size_t value_length, - time_t expiration, - uint16_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); -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); memcached_return memcached_delete(memcached_st *ptr, char *key, size_t key_length, time_t expiration); memcached_return memcached_increment(memcached_st *ptr, char *key, size_t key_length, - unsigned int offset, - unsigned int *value); + uint32_t offset, + uint64_t *value); memcached_return memcached_decrement(memcached_st *ptr, char *key, size_t key_length, - unsigned int offset, - unsigned int *value); + 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); -memcached_return memcached_stat_hostname(memcached_stat_st *stat, char *args, - char *hostname, unsigned int port); +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); 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, void *data); +unsigned long long 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, - 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 + +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); -char *memcached_strerror(memcached_st *ptr, memcached_return rc); +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); +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); + +/* 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));A= 0;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 + +#endif /* __WATCHPOINT_H__ */ -/* These are all private, do not use. */ -memcached_return memcached_connect(memcached_st *ptr); -memcached_return memcached_response(memcached_st *ptr, - char *buffer, size_t buffer_length, - unsigned int server_key); -unsigned int memcached_generate_hash(char *key, size_t key_length); #ifdef __cplusplus }