git.m6w6.name Git - m6w6/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 <inttypes.h>
  15 #include <sys/types.h>
  16 #include <netinet/in.h>
  17
  18 #ifdef __cplusplus
  19 extern "C" {
  20 #endif
  21
  22 /* These are Private and should not be used by applications */
  23 #define MEMCACHED_VERSION_STRING_LENGTH 12
  24
  25 /* Public defines */
  26 #define MEMCACHED_DEFAULT_PORT 11211
  27 #define MEMCACHED_MAX_KEY 251 /* We add one to have it null terminated */
  28 #define MEMCACHED_MAX_BUFFER 8196
  29 #define MEMCACHED_MAX_HOST_LENGTH 64
  30 #define MEMCACHED_WHEEL_SIZE 1024
  31 #define MEMCACHED_STRIDE 4
  32 #define MEMCACHED_DEFAULT_TIMEOUT INT32_MAX
  33
  34 /* string value */
  35 #define LIBMEMCACHED_VERSION_STRING "0.14"
  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_FETCH_NOTFINISHED,
  68   MEMCACHED_TIMEOUT,
  69   MEMCACHED_BUFFERED,
  70   MEMCACHED_MAXIMUM_RETURN, /* Always add new error code before */
  71 } memcached_return;
  72
  73 typedef struct memcached_st memcached_st;
  74 typedef struct memcached_stat_st memcached_stat_st;
  75 typedef struct memcached_result_st memcached_result_st;
  76 typedef struct memcached_string_st memcached_string_st;
  77 typedef struct memcached_server_st memcached_server_st;
  78 typedef memcached_return (*memcached_clone_func)(memcached_st *parent, memcached_st *clone);
  79 typedef memcached_return (*memcached_cleanup_func)(memcached_st *ptr);
  80 typedef void (*memcached_free_function)(memcached_st *ptr, void *mem);
  81 typedef void *(*memcached_malloc_function)(memcached_st *ptr, const size_t size);
  82 typedef void *(*memcached_realloc_function)(memcached_st *ptr, void *mem, const size_t size);
  83
  84 typedef enum {
  85   MEMCACHED_DISTRIBUTION_MODULA,
  86   MEMCACHED_DISTRIBUTION_CONSISTENT,
  87 } memcached_server_distribution;
  88
  89 typedef enum {
  90   MEMCACHED_BEHAVIOR_NO_BLOCK,
  91   MEMCACHED_BEHAVIOR_TCP_NODELAY,
  92   MEMCACHED_BEHAVIOR_HASH,
  93   MEMCACHED_BEHAVIOR_KETAMA,
  94   MEMCACHED_BEHAVIOR_SOCKET_SEND_SIZE,
  95   MEMCACHED_BEHAVIOR_SOCKET_RECV_SIZE,
  96   MEMCACHED_BEHAVIOR_CACHE_LOOKUPS,
  97   MEMCACHED_BEHAVIOR_SUPPORT_CAS,
  98   MEMCACHED_BEHAVIOR_POLL_TIMEOUT,
  99   MEMCACHED_BEHAVIOR_DISTRIBUTION,
 100   MEMCACHED_BEHAVIOR_BUFFER_REQUESTS,
 101   MEMCACHED_BEHAVIOR_USER_DATA,
 102 } memcached_behavior;
 103
 104 typedef enum {
 105   MEMCACHED_CALLBACK_USER_DATA,
 106   MEMCACHED_CALLBACK_CLEANUP_FUNCTION,
 107   MEMCACHED_CALLBACK_CLONE_FUNCTION,
 108   MEMCACHED_CALLBACK_MALLOC_FUNCTION,
 109   MEMCACHED_CALLBACK_REALLOC_FUNCTION,
 110   MEMCACHED_CALLBACK_FREE_FUNCTION,
 111 } memcached_callback;
 112
 113 typedef enum {
 114   MEMCACHED_HASH_DEFAULT= 0,
 115   MEMCACHED_HASH_MD5,
 116   MEMCACHED_HASH_CRC,
 117   MEMCACHED_HASH_FNV1_64,
 118   MEMCACHED_HASH_FNV1A_64,
 119   MEMCACHED_HASH_FNV1_32,
 120   MEMCACHED_HASH_FNV1A_32,
 121   MEMCACHED_HASH_KETAMA,
 122   MEMCACHED_HASH_HSIEH,
 123 } memcached_hash;
 124
 125 typedef enum {
 126   MEMCACHED_CONNECTION_UNKNOWN,
 127   MEMCACHED_CONNECTION_TCP,
 128   MEMCACHED_CONNECTION_UDP,
 129   MEMCACHED_CONNECTION_UNIX_SOCKET,
 130 } memcached_connection;
 131
 132 typedef enum {
 133   MEMCACHED_NOT_ALLOCATED,
 134   MEMCACHED_ALLOCATED,
 135   MEMCACHED_USED,
 136 } memcached_allocated;
 137
 138 struct memcached_server_st {
 139   char hostname[MEMCACHED_MAX_HOST_LENGTH];
 140   unsigned int port;
 141   int fd;
 142   int cached_errno;
 143   unsigned int cursor_active;
 144   char write_buffer[MEMCACHED_MAX_BUFFER];
 145   size_t write_buffer_offset;
 146   char read_buffer[MEMCACHED_MAX_BUFFER];
 147   size_t read_data_length;
 148   size_t read_buffer_length;
 149   char *read_ptr;
 150   memcached_allocated sockaddr_inited;
 151   struct addrinfo *address_info;
 152   memcached_connection type;
 153   uint8_t major_version;
 154   uint8_t minor_version;
 155   uint8_t micro_version;
 156   uint16_t count;
 157   memcached_st *root;
 158 };
 159
 160 struct memcached_stat_st {
 161   uint32_t pid;
 162   uint32_t uptime;
 163   uint32_t threads;
 164   uint32_t time;
 165   uint32_t pointer_size;
 166   uint32_t rusage_user_seconds;
 167   uint32_t rusage_user_microseconds;
 168   uint32_t rusage_system_seconds;
 169   uint32_t rusage_system_microseconds;
 170   uint32_t curr_items;
 171   uint32_t total_items;
 172   uint32_t limit_maxbytes;
 173   uint32_t curr_connections;
 174   uint32_t total_connections;
 175   uint32_t connection_structures;
 176   uint64_t bytes;
 177   uint64_t cmd_get;
 178   uint64_t cmd_set;
 179   uint64_t get_hits;
 180   uint64_t get_misses;
 181   uint64_t evictions;
 182   uint64_t bytes_read;
 183   uint64_t bytes_written;
 184   char version[MEMCACHED_VERSION_STRING_LENGTH];
 185 };
 186
 187 struct memcached_string_st {
 188   memcached_st *root;
 189   memcached_allocated is_allocated;
 190   char *string;
 191   char *end;
 192   size_t current_size;
 193   size_t block_size;
 194 };
 195
 196 struct memcached_result_st {
 197   memcached_allocated is_allocated;
 198   memcached_st *root;
 199   char key[MEMCACHED_MAX_KEY];
 200   size_t key_length;
 201   memcached_string_st value;
 202   uint32_t flags;
 203   uint64_t cas;
 204   /* Add result callback function */
 205 };
 206
 207 struct memcached_st {
 208   memcached_allocated is_allocated;
 209   memcached_server_st *hosts;
 210   unsigned int number_of_hosts;
 211   unsigned int cursor_server;
 212   int cached_errno;
 213   uint32_t flags;
 214   int send_size;
 215   int recv_size;
 216   int32_t poll_timeout;
 217   memcached_result_st result;
 218   memcached_hash hash;
 219   memcached_server_distribution distribution;
 220   void *user_data;
 221   unsigned int wheel[MEMCACHED_WHEEL_SIZE];
 222   memcached_clone_func on_clone;
 223   memcached_cleanup_func on_cleanup;
 224   memcached_free_function call_free;
 225   memcached_malloc_function call_malloc;
 226   memcached_realloc_function call_realloc;
 227 #ifdef NOT_USED /* Future Use */
 228   uint8_t replicas;
 229   memcached_return warning;
 230 #endif
 231 };
 232
 233 /* Public API */
 234 const char * memcached_lib_version(void);
 235
 236 memcached_st *memcached_create(memcached_st *ptr);
 237 void memcached_free(memcached_st *ptr);
 238 memcached_st *memcached_clone(memcached_st *clone, memcached_st *ptr);
 239
 240 memcached_return memcached_delete(memcached_st *ptr, char *key, size_t key_length,
 241                                   time_t expiration);
 242 memcached_return memcached_increment(memcached_st *ptr,
 243                                      char *key, size_t key_length,
 244                                      uint32_t offset,
 245                                      uint64_t *value);
 246 memcached_return memcached_decrement(memcached_st *ptr,
 247                                      char *key, size_t key_length,
 248                                      uint32_t offset,
 249                                      uint64_t *value);
 250 void memcached_stat_free(memcached_st *, memcached_stat_st *);
 251 memcached_stat_st *memcached_stat(memcached_st *ptr, char *args, memcached_return *error);
 252 memcached_return memcached_stat_servername(memcached_stat_st *stat, char *args,
 253                                            char *hostname, unsigned int port);
 254 memcached_return memcached_flush(memcached_st *ptr, time_t expiration);
 255 memcached_return memcached_verbosity(memcached_st *ptr, unsigned int verbosity);
 256 void memcached_quit(memcached_st *ptr);
 257 char *memcached_strerror(memcached_st *ptr, memcached_return rc);
 258 memcached_return memcached_behavior_set(memcached_st *ptr, memcached_behavior flag, void *data);
 259 unsigned long long memcached_behavior_get(memcached_st *ptr, memcached_behavior flag);
 260
 261 /* All of the functions for adding data to the server */
 262 memcached_return memcached_set(memcached_st *ptr, char *key, size_t key_length,
 263                                char *value, size_t value_length,
 264                                time_t expiration,
 265                                uint32_t  flags);
 266 memcached_return memcached_add(memcached_st *ptr, char *key, size_t key_length,
 267                                char *value, size_t value_length,
 268                                time_t expiration,
 269                                uint32_t  flags);
 270 memcached_return memcached_replace(memcached_st *ptr, char *key, size_t key_length,
 271                                    char *value, size_t value_length,
 272                                    time_t expiration,
 273                                    uint32_t  flags);
 274 memcached_return memcached_append(memcached_st *ptr,
 275                                   char *key, size_t key_length,
 276                                   char *value, size_t value_length,
 277                                   time_t expiration,
 278                                   uint32_t flags);
 279 memcached_return memcached_prepend(memcached_st *ptr,
 280                                    char *key, size_t key_length,
 281                                    char *value, size_t value_length,
 282                                    time_t expiration,
 283                                    uint32_t flags);
 284 memcached_return memcached_cas(memcached_st *ptr,
 285                                char *key, size_t key_length,
 286                                char *value, size_t value_length,
 287                                time_t expiration,
 288                                uint32_t flags,
 289                                uint64_t cas);
 290
 291 /* Get functions */
 292 char *memcached_get(memcached_st *ptr, char *key, size_t key_length,
 293                     size_t *value_length,
 294                     uint32_t *flags,
 295                     memcached_return *error);
 296 memcached_return memcached_mget(memcached_st *ptr,
 297                                 char **keys, size_t *key_length,
 298                                 unsigned int number_of_keys);
 299 char *memcached_fetch(memcached_st *ptr, char *key, size_t *key_length,
 300                       size_t *value_length, uint32_t *flags,
 301                       memcached_return *error);
 302 memcached_result_st *memcached_fetch_result(memcached_st *ptr,
 303                                             memcached_result_st *result,
 304                                             memcached_return *error);
 305
 306 /* Server Public functions */
 307 #define memcached_server_count(A) (A)->number_of_hosts
 308 #define memcached_server_name(A,B) (B).hostname
 309 #define memcached_server_port(A,B) (B).port
 310 #define memcached_server_list(A) (A)->hosts
 311 #define memcached_server_response_count(A) (A)->cursor_active
 312
 313
 314 memcached_return memcached_server_add_udp(memcached_st *ptr,
 315                                           char *hostname,
 316                                           unsigned int port);
 317 memcached_return memcached_server_add_unix_socket(memcached_st *ptr,
 318                                                   char *filename);
 319 memcached_return memcached_server_add(memcached_st *ptr, char *hostname,
 320                                       unsigned int port);
 321 void memcached_server_list_free(memcached_server_st *ptr);
 322 memcached_return memcached_server_push(memcached_st *ptr, memcached_server_st *list);
 323
 324 memcached_server_st *memcached_server_list_append(memcached_server_st *ptr,
 325                                              char *hostname, unsigned int port,
 326                                              memcached_return *error);
 327 unsigned int memcached_server_list_count(memcached_server_st *ptr);
 328 memcached_server_st *memcached_servers_parse(char *server_strings);
 329
 330 char *memcached_stat_get_value(memcached_st *ptr, memcached_stat_st *stat,
 331                                char *key, memcached_return *error);
 332 char ** memcached_stat_get_keys(memcached_st *ptr, memcached_stat_st *stat,
 333                                 memcached_return *error);
 334
 335 char *memcached_get_by_key(memcached_st *ptr,
 336                            char *master_key, size_t master_key_length,
 337                            char *key, size_t key_length,
 338                            size_t *value_length,
 339                            uint32_t *flags,
 340                            memcached_return *error);
 341
 342 memcached_return memcached_mget_by_key(memcached_st *ptr,
 343                                        char *master_key, size_t master_key_length,
 344                                        char **keys, size_t *key_length,
 345                                        unsigned int number_of_keys);
 346
 347 memcached_return memcached_set_by_key(memcached_st *ptr,
 348                                       char *master_key, size_t master_key_length,
 349                                       char *key, size_t key_length,
 350                                       char *value, size_t value_length,
 351                                       time_t expiration,
 352                                       uint32_t flags);
 353
 354 memcached_return memcached_add_by_key(memcached_st *ptr,
 355                                       char *master_key, size_t master_key_length,
 356                                       char *key, size_t key_length,
 357                                       char *value, size_t value_length,
 358                                       time_t expiration,
 359                                       uint32_t flags);
 360
 361 memcached_return memcached_replace_by_key(memcached_st *ptr,
 362                                           char *master_key, size_t master_key_length,
 363                                           char *key, size_t key_length,
 364                                           char *value, size_t value_length,
 365                                           time_t expiration,
 366                                           uint32_t flags);
 367
 368 memcached_return memcached_prepend_by_key(memcached_st *ptr,
 369                                           char *master_key, size_t master_key_length,
 370                                           char *key, size_t key_length,
 371                                           char *value, size_t value_length,
 372                                           time_t expiration,
 373                                           uint32_t flags);
 374
 375 memcached_return memcached_append_by_key(memcached_st *ptr,
 376                                          char *master_key, size_t master_key_length,
 377                                          char *key, size_t key_length,
 378                                          char *value, size_t value_length,
 379                                          time_t expiration,
 380                                          uint32_t flags);
 381
 382 memcached_return memcached_cas_by_key(memcached_st *ptr,
 383                                       char *master_key, size_t master_key_length,
 384                                       char *key, size_t key_length,
 385                                       char *value, size_t value_length,
 386                                       time_t expiration,
 387                                       uint32_t flags,
 388                                       uint64_t cas);
 389 memcached_return memcached_delete_by_key(memcached_st *ptr,
 390                                          char *master_key, size_t master_key_length,
 391                                          char *key, size_t key_length,
 392                                          time_t expiration);
 393
 394 memcached_return memcached_fetch_execute(memcached_st *ptr,
 395                                              unsigned int (*callback[])(memcached_st *ptr, memcached_result_st *result, void *context),
 396                                              void *context,
 397                                              unsigned int number_of_callbacks
 398                                              );
 399
 400 memcached_return memcached_callback_set(memcached_st *ptr,
 401                                         memcached_callback flag,
 402                                         void *data);
 403 void *memcached_callback_get(memcached_st *ptr,
 404                              memcached_callback flag,
 405                              memcached_return *error);
 406
 407 /* Result Struct */
 408 void memcached_result_free(memcached_result_st *result);
 409 memcached_result_st *memcached_result_create(memcached_st *ptr,
 410                                              memcached_result_st *result);
 411 #define memcached_result_key_value(A) (A)->key
 412 #define memcached_result_key_length(A) (A)->key_length
 413 #ifdef FIX
 414 #define memcached_result_value(A) memcached_string_value((A)->value)
 415 #define memcached_result_length(A) memcached_string_length((A)->value)
 416 #else
 417 char *memcached_result_value(memcached_result_st *ptr);
 418 size_t memcached_result_length(memcached_result_st *ptr);
 419 #endif
 420 #define memcached_result_flags(A) (A)->flags
 421 #define memcached_result_cas(A) (A)->cas
 422
 423
 424 #ifndef __WATCHPOINT_H__
 425 #define __WATCHPOINT_H__
 426 /* Some personal debugging functions */
 427 #ifdef HAVE_DEBUG
 428 #define WATCHPOINT fprintf(stderr, "\nWATCHPOINT %s:%d (%s)\n", __FILE__, __LINE__,__func__);fflush(stdout);
 429 #ifdef __MEMCACHED_H__
 430 #define WATCHPOINT_ERROR(A) fprintf(stderr, "\nWATCHPOINT %s:%d %s\n", __FILE__, __LINE__, memcached_strerror(NULL, A));fflush(stdout);
 431 #define WATCHPOINT_IFERROR(A) if(A != MEMCACHED_SUCCESS)fprintf(stderr, "\nWATCHPOINT %s:%d %s\n", __FILE__, __LINE__, memcached_strerror(NULL, A));fflush(stdout);
 432 #endif
 433 #define WATCHPOINT_STRING(A) fprintf(stderr, "\nWATCHPOINT %s:%d (%s) %s\n", __FILE__, __LINE__,__func__,A);fflush(stdout);
 434 #define WATCHPOINT_STRING_LENGTH(A,B) fprintf(stderr, "\nWATCHPOINT %s:%d (%s) %.*s\n", __FILE__, __LINE__,__func__,(int)B,A);fflush(stdout);
 435 #define WATCHPOINT_NUMBER(A) fprintf(stderr, "\nWATCHPOINT %s:%d (%s) %zu\n", __FILE__, __LINE__,__func__,(size_t)(A));fflush(stdout);
 436 #define WATCHPOINT_ERRNO(A) fprintf(stderr, "\nWATCHPOINT %s:%d (%s) %s\n", __FILE__, __LINE__,__func__, strerror(A));fflush(stdout);
 437 #define WATCHPOINT_ASSERT(A) assert((A));
 438 #else
 439 #define WATCHPOINT
 440 #ifdef __MEMCACHED_H__
 441 #define WATCHPOINT_ERROR(A)
 442 #define WATCHPOINT_IFERROR(A)
 443 #endif
 444 #define WATCHPOINT_STRING(A)
 445 #define WATCHPOINT_NUMBER(A)
 446 #define WATCHPOINT_ERRNO(A)
 447 #define WATCHPOINT_ASSERT(A)
 448 #endif
 449
 450 #endif /* __WATCHPOINT_H__ */
 451
 452
 453 #ifdef __cplusplus
 454 }
 455 #endif
 456
 457 #endif /* __MEMCACHED_H__ */