git.m6w6.name Git - awesomized/libmemcached/blob - include/memcached.h

   1 /*
   2  * Summary: interface for memcached server
   3  * Description: main include file for libmemcached
   4  *
   5  * Copy: See Copyright for the status of this software.
   6  *
   7  * Author: Brian Aker
   8  */
   9
  10 #ifndef __MEMCACHED_H__
  11 #define __MEMCACHED_H__
  12
  13 #include <stdlib.h>
  14 #include <stdint.h>
  15 #include <sys/types.h>
  16 #include <netinet/in.h>
  17
  18 #ifdef __cplusplus
  19 extern "C" {
  20 #endif
  21
  22 typedef struct memcached_st memcached_st;
  23 typedef struct memcached_stat_st memcached_stat_st;
  24 typedef struct memcached_result_st memcached_result_st;
  25 typedef struct memcached_string_st memcached_string_st;
  26 typedef struct memcached_server_st memcached_server_st;
  27
  28 #define MEMCACHED_VERSION_STRING 12
  29 #define MEMCACHED_DEFAULT_PORT 11211
  30 #define MEMCACHED_DEFAULT_COMMAND_SIZE 350
  31 #define SMALL_STRING_LEN 1024
  32 #define HUGE_STRING_LEN 8196
  33 #define MEMCACHED_MAX_KEY 251 /* We add one to have it null terminated */
  34 #define MEMCACHED_MAX_BUFFER HUGE_STRING_LEN
  35 #define MEMCACHED_MAX_HOST_LENGTH 64
  36
  37 typedef enum {
  38   MEMCACHED_SUCCESS,
  39   MEMCACHED_FAILURE,
  40   MEMCACHED_HOST_LOOKUP_FAILURE,
  41   MEMCACHED_CONNECTION_FAILURE,
  42   MEMCACHED_CONNECTION_BIND_FAILURE,
  43   MEMCACHED_WRITE_FAILURE,
  44   MEMCACHED_READ_FAILURE,
  45   MEMCACHED_UNKNOWN_READ_FAILURE,
  46   MEMCACHED_PROTOCOL_ERROR,
  47   MEMCACHED_CLIENT_ERROR,
  48   MEMCACHED_SERVER_ERROR,
  49   MEMCACHED_CONNECTION_SOCKET_CREATE_FAILURE,
  50   MEMCACHED_DATA_EXISTS,
  51   MEMCACHED_DATA_DOES_NOT_EXIST,
  52   MEMCACHED_NOTSTORED,
  53   MEMCACHED_STORED,
  54   MEMCACHED_NOTFOUND,
  55   MEMCACHED_MEMORY_ALLOCATION_FAILURE,
  56   MEMCACHED_PARTIAL_READ,
  57   MEMCACHED_SOME_ERRORS,
  58   MEMCACHED_NO_SERVERS,
  59   MEMCACHED_END,
  60   MEMCACHED_DELETED,
  61   MEMCACHED_VALUE,
  62   MEMCACHED_STAT,
  63   MEMCACHED_ERRNO,
  64   MEMCACHED_FAIL_UNIX_SOCKET,
  65   MEMCACHED_NOT_SUPPORTED,
  66   MEMCACHED_NO_KEY_PROVIDED,
  67   MEMCACHED_MAXIMUM_RETURN, /* Always add new error code before */
  68 } memcached_return;
  69
  70 typedef enum {
  71   MEMCACHED_BEHAVIOR_NO_BLOCK,
  72   MEMCACHED_BEHAVIOR_TCP_NODELAY,
  73   MEMCACHED_BEHAVIOR_HASH,
  74   MEMCACHED_BEHAVIOR_KETAMA,
  75   MEMCACHED_BEHAVIOR_SOCKET_SEND_SIZE,
  76   MEMCACHED_BEHAVIOR_SOCKET_RECV_SIZE,
  77   MEMCACHED_BEHAVIOR_CACHE_LOOKUPS,
  78   MEMCACHED_BEHAVIOR_SUPPORT_CAS,
  79   MEMCACHED_BEHAVIOR_POLL_TIMEOUT,
  80 } memcached_behavior;
  81
  82 typedef enum {
  83   MEMCACHED_HASH_DEFAULT= 0,
  84   MEMCACHED_HASH_MD5,
  85   MEMCACHED_HASH_CRC,
  86   MEMCACHED_HASH_FNV1_64,
  87   MEMCACHED_HASH_FNV1A_64,
  88   MEMCACHED_HASH_FNV1_32,
  89   MEMCACHED_HASH_FNV1A_32,
  90   MEMCACHED_HASH_KETAMA,
  91   MEMCACHED_HASH_HSIEH,
  92 } memcached_hash;
  93
  94 typedef enum {
  95   MEMCACHED_CONNECTION_UNKNOWN,
  96   MEMCACHED_CONNECTION_TCP,
  97   MEMCACHED_CONNECTION_UDP,
  98   MEMCACHED_CONNECTION_UNIX_SOCKET,
  99 } memcached_connection;
 100
 101 typedef enum {
 102   MEMCACHED_NOT_ALLOCATED,
 103   MEMCACHED_ALLOCATED,
 104   MEMCACHED_USED,
 105 } memcached_allocated;
 106
 107 struct memcached_server_st {
 108   char hostname[MEMCACHED_MAX_HOST_LENGTH];
 109   unsigned int port;
 110   int fd;
 111   unsigned int stack_responses;
 112   unsigned int cursor_active;
 113   char write_buffer[MEMCACHED_MAX_BUFFER];
 114   size_t write_buffer_offset;
 115   char *write_ptr;
 116   char read_buffer[MEMCACHED_MAX_BUFFER];
 117   size_t read_buffer_length;
 118   char *read_ptr;
 119   memcached_allocated sockaddr_inited;
 120   struct sockaddr_in servAddr;
 121   memcached_connection type;
 122   uint8_t major_version;
 123   uint8_t minor_version;
 124   uint8_t micro_version;
 125   uint16_t count;
 126 };
 127
 128 struct memcached_stat_st {
 129   uint32_t pid;
 130   uint32_t uptime;
 131   uint32_t threads;
 132   uint32_t time;
 133   uint32_t pointer_size;
 134   uint32_t rusage_user_seconds;
 135   uint32_t rusage_user_microseconds;
 136   uint32_t rusage_system_seconds;
 137   uint32_t rusage_system_microseconds;
 138   uint32_t curr_items;
 139   uint32_t total_items;
 140   uint32_t limit_maxbytes;
 141   uint32_t curr_connections;
 142   uint32_t total_connections;
 143   uint32_t connection_structures;
 144   uint64_t bytes;
 145   uint64_t cmd_get;
 146   uint64_t cmd_set;
 147   uint64_t get_hits;
 148   uint64_t get_misses;
 149   uint64_t evictions;
 150   uint64_t bytes_read;
 151   uint64_t bytes_written;
 152   char version[MEMCACHED_VERSION_STRING];
 153 };
 154
 155 struct memcached_string_st {
 156   memcached_st *root;
 157   memcached_allocated is_allocated;
 158   char *string;
 159   char *end;
 160   size_t current_size;
 161   size_t block_size;
 162 };
 163
 164 struct memcached_result_st {
 165   memcached_allocated is_allocated;
 166   memcached_st *root;
 167   char key[MEMCACHED_MAX_KEY];
 168   size_t key_length;
 169   memcached_string_st value;
 170   uint16_t flags;
 171   uint64_t cas;
 172 };
 173
 174 struct memcached_st {
 175   memcached_allocated is_allocated;
 176   memcached_server_st *hosts;
 177   unsigned int number_of_hosts;
 178   unsigned int cursor_server;
 179   char connected;
 180   int cached_errno;
 181   unsigned long long flags;
 182   int send_size;
 183   int recv_size;
 184   int32_t poll_timeout;
 185   memcached_string_st result_buffer;
 186   memcached_hash hash;
 187   memcached_return warning; /* Future Use */
 188 };
 189
 190 /* Public API */
 191 memcached_st *memcached_create(memcached_st *ptr);
 192 void memcached_free(memcached_st *ptr);
 193 memcached_st *memcached_clone(memcached_st *clone, memcached_st *ptr);
 194
 195 memcached_return memcached_delete(memcached_st *ptr, char *key, size_t key_length,
 196                                   time_t expiration);
 197 memcached_return memcached_increment(memcached_st *ptr,
 198                                      char *key, size_t key_length,
 199                                      uint32_t offset,
 200                                      uint64_t *value);
 201 memcached_return memcached_decrement(memcached_st *ptr,
 202                                      char *key, size_t key_length,
 203                                      uint32_t offset,
 204                                      uint64_t *value);
 205 void memcached_stat_free(memcached_st *, memcached_stat_st *);
 206 memcached_stat_st *memcached_stat(memcached_st *ptr, char *args, memcached_return *error);
 207 memcached_return memcached_stat_servername(memcached_stat_st *stat, char *args,
 208                                            char *hostname, unsigned int port);
 209 memcached_return memcached_flush(memcached_st *ptr, time_t expiration);
 210 memcached_return memcached_verbosity(memcached_st *ptr, unsigned int verbosity);
 211 void memcached_quit(memcached_st *ptr);
 212 char *memcached_strerror(memcached_st *ptr, memcached_return rc);
 213 memcached_return memcached_behavior_set(memcached_st *ptr, memcached_behavior flag, void *data);
 214 unsigned long long memcached_behavior_get(memcached_st *ptr, memcached_behavior flag);
 215
 216 /* All of the functions for adding data to the server */
 217 memcached_return memcached_set(memcached_st *ptr, char *key, size_t key_length,
 218                                char *value, size_t value_length,
 219                                time_t expiration,
 220                                uint16_t  flags);
 221 memcached_return memcached_add(memcached_st *ptr, char *key, size_t key_length,
 222                                char *value, size_t value_length,
 223                                time_t expiration,
 224                                uint16_t  flags);
 225 memcached_return memcached_replace(memcached_st *ptr, char *key, size_t key_length,
 226                                    char *value, size_t value_length,
 227                                    time_t expiration,
 228                                    uint16_t  flags);
 229 memcached_return memcached_append(memcached_st *ptr,
 230                                   char *key, size_t key_length,
 231                                   char *value, size_t value_length,
 232                                   time_t expiration,
 233                                   uint16_t flags);
 234 memcached_return memcached_prepend(memcached_st *ptr,
 235                                    char *key, size_t key_length,
 236                                    char *value, size_t value_length,
 237                                    time_t expiration,
 238                                    uint16_t flags);
 239 memcached_return memcached_cas(memcached_st *ptr,
 240                                char *key, size_t key_length,
 241                                char *value, size_t value_length,
 242                                time_t expiration,
 243                                uint16_t flags,
 244                                uint64_t cas);
 245
 246 /* Get functions */
 247 char *memcached_get(memcached_st *ptr, char *key, size_t key_length,
 248                     size_t *value_length,
 249                     uint16_t *flags,
 250                     memcached_return *error);
 251 memcached_return memcached_mget(memcached_st *ptr,
 252                                 char **keys, size_t *key_length,
 253                                 unsigned int number_of_keys);
 254 char *memcached_fetch(memcached_st *ptr, char *key, size_t *key_length,
 255                       size_t *value_length, uint16_t *flags,
 256                       memcached_return *error);
 257 memcached_result_st *memcached_fetch_result(memcached_st *ptr,
 258                                             memcached_result_st *result,
 259                                             memcached_return *error);
 260
 261 /* Server Public functions */
 262 #define memcached_server_count(A) (A)->number_of_hosts
 263 #define memcached_server_name(A,B) (B).hostname
 264 #define memcached_server_port(A,B) (B).port
 265 #define memcached_server_list(A) (A)->hosts
 266 #define memcached_server_response_count(A,B) (A)->hosts[B].stack_responses
 267
 268 memcached_return memcached_server_add_udp(memcached_st *ptr,
 269                                           char *hostname,
 270                                           unsigned int port);
 271 memcached_return memcached_server_add_unix_socket(memcached_st *ptr,
 272                                                   char *filename);
 273 memcached_return memcached_server_add(memcached_st *ptr, char *hostname,
 274                                       unsigned int port);
 275 void memcached_server_list_free(memcached_server_st *ptr);
 276 memcached_return memcached_server_push(memcached_st *ptr, memcached_server_st *list);
 277
 278 memcached_server_st *memcached_server_list_append(memcached_server_st *ptr,
 279                                              char *hostname, unsigned int port,
 280                                              memcached_return *error);
 281 unsigned int memcached_server_list_count(memcached_server_st *ptr);
 282 memcached_server_st *memcached_servers_parse(char *server_strings);
 283
 284 char *memcached_stat_get_value(memcached_st *ptr, memcached_stat_st *stat,
 285                                char *key, memcached_return *error);
 286 char ** memcached_stat_get_keys(memcached_st *ptr, memcached_stat_st *stat,
 287                                 memcached_return *error);
 288
 289 /* Result Struct */
 290 void memcached_result_free(memcached_result_st *result);
 291 memcached_result_st *memcached_result_create(memcached_st *ptr,
 292                                              memcached_result_st *result);
 293 #define memcached_result_key_value(A) A->key
 294 #define memcached_result_key_length(A) A->key_length
 295 #ifdef FIX
 296 #define memcached_result_value(A) memcached_string_value(A->value)
 297 #define memcached_result_length(A) memcached_string_length(A->value)
 298 #else
 299 char *memcached_result_value(memcached_result_st *ptr);
 300 size_t memcached_result_length(memcached_result_st *ptr);
 301 #endif
 302 #define memcached_result_flags(A) A->flags
 303 #define memcached_result_cas(A) A->cas
 304
 305
 306 #ifndef __WATCHPOINT_H__
 307 #define __WATCHPOINT_H__
 308 /* Some personal debugging functions */
 309 #ifdef HAVE_DEBUG
 310 #define WATCHPOINT fprintf(stderr, "\nWATCHPOINT %s:%d (%s)\n", __FILE__, __LINE__,__func__);fflush(stdout);
 311 #ifdef __MEMCACHED_H__
 312 #define WATCHPOINT_ERROR(A) fprintf(stderr, "\nWATCHPOINT %s:%d %s\n", __FILE__, __LINE__, memcached_strerror(NULL, A));fflush(stdout);
 313 #endif
 314 #define WATCHPOINT_STRING(A) fprintf(stderr, "\nWATCHPOINT %s:%d (%s) %s\n", __FILE__, __LINE__,__func__,A);fflush(stdout);
 315 #define WATCHPOINT_NUMBER(A) fprintf(stderr, "\nWATCHPOINT %s:%d (%s) %zu\n", __FILE__, __LINE__,__func__,(size_t)(A));fflush(stdout);
 316 #define WATCHPOINT_ERRNO(A) fprintf(stderr, "\nWATCHPOINT %s:%d (%s) %s\n", __FILE__, __LINE__,__func__, strerror(A));A= 0;fflush(stdout);
 317 #define WATCHPOINT_ASSERT(A) assert((A));
 318 #else
 319 /*
 320 #define WATCHPOINT { 1; };
 321 #define WATCHPOINT_ERROR(A) { 1; };
 322 #define WATCHPOINT_STRING(A) { 1; };
 323 #define WATCHPOINT_NUMBER(A) { 1; };
 324 #define WATCHPOINT_ERRNO(A) { 1; };
 325 #define WATCHPOINT_ASSERT(A) { 1; };
 326 */
 327 #define WATCHPOINT
 328 #ifdef __MEMCACHED_H__
 329 #define WATCHPOINT_ERROR(A)
 330 #endif
 331 #define WATCHPOINT_STRING(A)
 332 #define WATCHPOINT_NUMBER(A)
 333 #define WATCHPOINT_ERRNO(A)
 334 #define WATCHPOINT_ASSERT(A)
 335 #endif
 336
 337 #endif /* __WATCHPOINT_H__ */
 338
 339
 340 #ifdef __cplusplus
 341 }
 342 #endif
 343
 344 #endif /* __MEMCACHED_H__ */