memcached_behavior_set() can now modify the poll timeout
[awesomized/libmemcached] / include / memcached.h
index e2b026df9581b7da8d24160d74224f2ca601e636..54f529528c7879b8a6507c68617ec2b90dcb4230 100644 (file)
@@ -13,6 +13,7 @@
 #include <stdlib.h>
 #include <stdint.h>
 #include <sys/types.h>
+#include <netinet/in.h>
 
 #ifdef __cplusplus
 extern "C" {
@@ -20,21 +21,22 @@ extern "C" {
 
 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;
 
+#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 MEMCACHED_MAX_BUFFER 8196
 #define MEMCACHED_MAX_BUFFER HUGE_STRING_LEN
 
 typedef enum {
   MEMCACHED_SUCCESS,
   MEMCACHED_FAILURE,
-  MEMCACHED_HOST_LOCKUP_FAILURE,
+  MEMCACHED_HOST_LOOKUP_FAILURE,
   MEMCACHED_CONNECTION_FAILURE,
   MEMCACHED_CONNECTION_BIND_FAILURE,
   MEMCACHED_WRITE_FAILURE,
@@ -60,19 +62,33 @@ typedef enum {
   MEMCACHED_ERRNO,
   MEMCACHED_FAIL_UNIX_SOCKET,
   MEMCACHED_NOT_SUPPORTED,
+  MEMCACHED_NO_KEY_PROVIDED,
   MEMCACHED_MAXIMUM_RETURN, /* Always add new error code before */
 } memcached_return;
 
 typedef enum {
   MEMCACHED_BEHAVIOR_NO_BLOCK,
   MEMCACHED_BEHAVIOR_TCP_NODELAY,
-  MEMCACHED_BEHAVIOR_MD5_HASHING,
-  MEMCACHED_BEHAVIOR_CRC_HASHING,
+  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;
 
+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;
+
 typedef enum {
   MEMCACHED_CONNECTION_UNKNOWN,
   MEMCACHED_CONNECTION_TCP,
@@ -81,8 +97,8 @@ typedef enum {
 } memcached_connection;
 
 typedef enum {
-  MEMCACHED_NOT_ALLOCATED= 0,
-  MEMCACHED_ALLOCATED= 1,
+  MEMCACHED_NOT_ALLOCATED,
+  MEMCACHED_ALLOCATED,
 } memcached_allocated;
 
 struct memcached_server_st {
@@ -91,7 +107,18 @@ struct memcached_server_st {
   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_buffer_length;
+  char *read_ptr;
+  memcached_allocated sockaddr_inited;
+  struct sockaddr_in servAddr;
   memcached_connection type;
+  uint8_t major_version;
+  uint8_t minor_version;
+  uint8_t micro_version;
 };
 
 struct memcached_stat_st {
@@ -99,7 +126,7 @@ struct memcached_stat_st {
   unsigned int uptime;
   unsigned int threads;
   time_t time;
-  char version[8];
+  char version[MEMCACHED_VERSION_STRING];
   unsigned int pointer_size;
   unsigned int rusage_user;
   unsigned int rusage_system;
@@ -124,27 +151,37 @@ struct memcached_stat_st {
 };
 
 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;
+  uint16_t flags;
+  uint64_t cas;
+};
+
 struct memcached_st {
   memcached_allocated is_allocated;
   memcached_server_st *hosts;
   unsigned int number_of_hosts;
   unsigned int cursor_server;
-  char read_buffer[MEMCACHED_MAX_BUFFER];
-  size_t read_buffer_length;
-  char *read_ptr;
-  char write_buffer[MEMCACHED_MAX_BUFFER];
-  size_t write_buffer_offset;
   char connected;
-  int my_errno;
+  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_return warning; /* Future Use */
 };
 
@@ -157,12 +194,13 @@ 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,
-                                     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_servername(memcached_stat_st *stat, char *args, 
                                            char *hostname, unsigned int port);
@@ -186,6 +224,22 @@ memcached_return memcached_replace(memcached_st *ptr, char *key, size_t key_leng
                                    char *value, size_t value_length, 
                                    time_t expiration,
                                    uint16_t  flags);
+memcached_return memcached_append(memcached_st *ptr, 
+                                  char *key, size_t key_length,
+                                  char *value, size_t value_length, 
+                                  time_t expiration,
+                                  uint16_t flags);
+memcached_return memcached_prepend(memcached_st *ptr, 
+                                   char *key, size_t key_length,
+                                   char *value, size_t value_length, 
+                                   time_t expiration,
+                                   uint16_t flags);
+memcached_return memcached_cas(memcached_st *ptr, 
+                               char *key, size_t key_length,
+                               char *value, size_t value_length, 
+                               time_t expiration,
+                               uint16_t flags,
+                               uint64_t cas);
 
 /* Get functions */
 char *memcached_get(memcached_st *ptr, char *key, size_t key_length,
@@ -198,6 +252,9 @@ memcached_return memcached_mget(memcached_st *ptr,
 char *memcached_fetch(memcached_st *ptr, char *key, size_t *key_length, 
                       size_t *value_length, uint16_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
@@ -206,6 +263,9 @@ char *memcached_fetch(memcached_st *ptr, char *key, size_t *key_length,
 #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, 
@@ -224,10 +284,31 @@ 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);
 
+/* 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);
+#endif
 #define WATCHPOINT_STRING(A) fprintf(stderr, "\nWATCHPOINT %s:%d (%s) %s\n", __FILE__, __LINE__,__func__,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);
@@ -242,13 +323,17 @@ char ** memcached_stat_get_keys(memcached_st *ptr, memcached_stat_st *stat,
 #define WATCHPOINT_ASSERT(A) { 1; };
 */
 #define WATCHPOINT
+#ifdef __MEMCACHED_H__
 #define WATCHPOINT_ERROR(A)
+#endif
 #define WATCHPOINT_STRING(A)
 #define WATCHPOINT_NUMBER(A)
 #define WATCHPOINT_ERRNO(A)
 #define WATCHPOINT_ASSERT(A)
 #endif
 
+#endif /* __WATCHPOINT_H__ */
+
 
 #ifdef __cplusplus
 }