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 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 #define MEMCACHED_WHEEL_SIZE 1024
  37 #define MEMCACHED_STRIDE 4
  38 #define MEMCACHED_DEFAULT_TIMEOUT INT32_MAX
  39
  40 typedef enum {
  41   MEMCACHED_SUCCESS,
  42   MEMCACHED_FAILURE,
  43   MEMCACHED_HOST_LOOKUP_FAILURE,
  44   MEMCACHED_CONNECTION_FAILURE,
  45   MEMCACHED_CONNECTION_BIND_FAILURE,
  46   MEMCACHED_WRITE_FAILURE,
  47   MEMCACHED_READ_FAILURE,
  48   MEMCACHED_UNKNOWN_READ_FAILURE,
  49   MEMCACHED_PROTOCOL_ERROR,
  50   MEMCACHED_CLIENT_ERROR,
  51   MEMCACHED_SERVER_ERROR,
  52   MEMCACHED_CONNECTION_SOCKET_CREATE_FAILURE,
  53   MEMCACHED_DATA_EXISTS,
  54   MEMCACHED_DATA_DOES_NOT_EXIST,
  55   MEMCACHED_NOTSTORED,
  56   MEMCACHED_STORED,
  57   MEMCACHED_NOTFOUND,
  58   MEMCACHED_MEMORY_ALLOCATION_FAILURE,
  59   MEMCACHED_PARTIAL_READ,
  60   MEMCACHED_SOME_ERRORS,
  61   MEMCACHED_NO_SERVERS,
  62   MEMCACHED_END,
  63   MEMCACHED_DELETED,
  64   MEMCACHED_VALUE,
  65   MEMCACHED_STAT,
  66   MEMCACHED_ERRNO,
  67   MEMCACHED_FAIL_UNIX_SOCKET,
  68   MEMCACHED_NOT_SUPPORTED,
  69   MEMCACHED_NO_KEY_PROVIDED,
  70   MEMCACHED_FETCH_NOTFINISHED,
  71   MEMCACHED_TIMEOUT,
  72   MEMCACHED_BUFFERED,
  73   MEMCACHED_MAXIMUM_RETURN, /* Always add new error code before */
  74 } memcached_return;
  75
  76 typedef enum {
  77   MEMCACHED_DISTRIBUTION_MODULA,
  78   MEMCACHED_DISTRIBUTION_CONSISTENT,
  79 } memcached_server_distribution;
  80
  81 typedef enum {
  82   MEMCACHED_BEHAVIOR_NO_BLOCK,
  83   MEMCACHED_BEHAVIOR_TCP_NODELAY,
  84   MEMCACHED_BEHAVIOR_HASH,
  85   MEMCACHED_BEHAVIOR_KETAMA,
  86   MEMCACHED_BEHAVIOR_SOCKET_SEND_SIZE,
  87   MEMCACHED_BEHAVIOR_SOCKET_RECV_SIZE,
  88   MEMCACHED_BEHAVIOR_CACHE_LOOKUPS,
  89   MEMCACHED_BEHAVIOR_SUPPORT_CAS,
  90   MEMCACHED_BEHAVIOR_POLL_TIMEOUT,
  91   MEMCACHED_BEHAVIOR_DISTRIBUTION,
  92   MEMCACHED_BEHAVIOR_BUFFER_REQUESTS,
  93 } memcached_behavior;
  94
  95 typedef enum {
  96   MEMCACHED_HASH_DEFAULT= 0,
  97   MEMCACHED_HASH_MD5,
  98   MEMCACHED_HASH_CRC,
  99   MEMCACHED_HASH_FNV1_64,
 100   MEMCACHED_HASH_FNV1A_64,
 101   MEMCACHED_HASH_FNV1_32,
 102   MEMCACHED_HASH_FNV1A_32,
 103   MEMCACHED_HASH_KETAMA,
 104   MEMCACHED_HASH_HSIEH,
 105 } memcached_hash;
 106
 107 typedef enum {
 108   MEMCACHED_CONNECTION_UNKNOWN,
 109   MEMCACHED_CONNECTION_TCP,
 110   MEMCACHED_CONNECTION_UDP,
 111   MEMCACHED_CONNECTION_UNIX_SOCKET,
 112 } memcached_connection;
 113
 114 typedef enum {
 115   MEMCACHED_NOT_ALLOCATED,
 116   MEMCACHED_ALLOCATED,
 117   MEMCACHED_USED,
 118 } memcached_allocated;
 119
 120 struct memcached_server_st {
 121   char hostname[MEMCACHED_MAX_HOST_LENGTH];
 122   unsigned int port;
 123   int fd;
 124   unsigned int cursor_active;
 125   char write_buffer[MEMCACHED_MAX_BUFFER];
 126   size_t write_buffer_offset;
 127   char *write_ptr;
 128   char read_buffer[MEMCACHED_MAX_BUFFER];
 129   size_t read_data_length;
 130   size_t read_buffer_length;
 131   char *read_ptr;
 132   memcached_allocated sockaddr_inited;
 133   struct addrinfo *address_info;
 134   memcached_connection type;
 135   uint8_t major_version;
 136   uint8_t minor_version;
 137   uint8_t micro_version;
 138   uint16_t count;
 139 };
 140
 141 struct memcached_stat_st {
 142   uint32_t pid;
 143   uint32_t uptime;
 144   uint32_t threads;
 145   uint32_t time;
 146   uint32_t pointer_size;
 147   uint32_t rusage_user_seconds;
 148   uint32_t rusage_user_microseconds;
 149   uint32_t rusage_system_seconds;
 150   uint32_t rusage_system_microseconds;
 151   uint32_t curr_items;
 152   uint32_t total_items;
 153   uint32_t limit_maxbytes;
 154   uint32_t curr_connections;
 155   uint32_t total_connections;
 156   uint32_t connection_structures;
 157   uint64_t bytes;
 158   uint64_t cmd_get;
 159   uint64_t cmd_set;
 160   uint64_t get_hits;
 161   uint64_t get_misses;
 162   uint64_t evictions;
 163   uint64_t bytes_read;
 164   uint64_t bytes_written;
 165   char version[MEMCACHED_VERSION_STRING];
 166 };
 167
 168 struct memcached_string_st {
 169   memcached_st *root;
 170   memcached_allocated is_allocated;
 171   char *string;
 172   char *end;
 173   size_t current_size;
 174   size_t block_size;
 175 };
 176
 177 struct memcached_result_st {
 178   memcached_allocated is_allocated;
 179   memcached_st *root;
 180   char key[MEMCACHED_MAX_KEY];
 181   size_t key_length;
 182   memcached_string_st value;
 183   uint32_t flags;
 184   uint64_t cas;
 185   /* Add result callback function */
 186 };
 187
 188 struct memcached_st {
 189   memcached_allocated is_allocated;
 190   memcached_server_st *hosts;
 191   unsigned int number_of_hosts;
 192   unsigned int cursor_server;
 193   char connected;
 194   int cached_errno;
 195   unsigned long long flags;
 196   int send_size;
 197   int recv_size;
 198   int32_t poll_timeout;
 199   memcached_result_st result;
 200   memcached_hash hash;
 201   memcached_server_distribution distribution;
 202   unsigned int wheel[MEMCACHED_WHEEL_SIZE];
 203 #ifdef NOT_USED /* Future Use */
 204   uint8_t replicas;
 205   memcached_return warning;
 206 #endif
 207 };
 208
 209 /* Public API */
 210 memcached_st *memcached_create(memcached_st *ptr);
 211 void memcached_free(memcached_st *ptr);
 212 memcached_st *memcached_clone(memcached_st *clone, memcached_st *ptr);
 213
 214 memcached_return memcached_delete(memcached_st *ptr, char *key, size_t key_length,
 215                                   time_t expiration);
 216 memcached_return memcached_increment(memcached_st *ptr,
 217                                      char *key, size_t key_length,
 218                                      uint32_t offset,
 219                                      uint64_t *value);
 220 memcached_return memcached_decrement(memcached_st *ptr,
 221                                      char *key, size_t key_length,
 222                                      uint32_t offset,
 223                                      uint64_t *value);
 224 void memcached_stat_free(memcached_st *, memcached_stat_st *);
 225 memcached_stat_st *memcached_stat(memcached_st *ptr, char *args, memcached_return *error);
 226 memcached_return memcached_stat_servername(memcached_stat_st *stat, char *args,
 227                                            char *hostname, unsigned int port);
 228 memcached_return memcached_flush(memcached_st *ptr, time_t expiration);
 229 memcached_return memcached_verbosity(memcached_st *ptr, unsigned int verbosity);
 230 void memcached_quit(memcached_st *ptr);
 231 char *memcached_strerror(memcached_st *ptr, memcached_return rc);
 232 memcached_return memcached_behavior_set(memcached_st *ptr, memcached_behavior flag, void *data);
 233 unsigned long long memcached_behavior_get(memcached_st *ptr, memcached_behavior flag);
 234
 235 /* All of the functions for adding data to the server */
 236 memcached_return memcached_set(memcached_st *ptr, char *key, size_t key_length,
 237                                char *value, size_t value_length,
 238                                time_t expiration,
 239                                uint32_t  flags);
 240 memcached_return memcached_add(memcached_st *ptr, char *key, size_t key_length,
 241                                char *value, size_t value_length,
 242                                time_t expiration,
 243                                uint32_t  flags);
 244 memcached_return memcached_replace(memcached_st *ptr, char *key, size_t key_length,
 245                                    char *value, size_t value_length,
 246                                    time_t expiration,
 247                                    uint32_t  flags);
 248 memcached_return memcached_append(memcached_st *ptr,
 249                                   char *key, size_t key_length,
 250                                   char *value, size_t value_length,
 251                                   time_t expiration,
 252                                   uint32_t flags);
 253 memcached_return memcached_prepend(memcached_st *ptr,
 254                                    char *key, size_t key_length,
 255                                    char *value, size_t value_length,
 256                                    time_t expiration,
 257                                    uint32_t flags);
 258 memcached_return memcached_cas(memcached_st *ptr,
 259                                char *key, size_t key_length,
 260                                char *value, size_t value_length,
 261                                time_t expiration,
 262                                uint32_t flags,
 263                                uint64_t cas);
 264
 265 /* Get functions */
 266 char *memcached_get(memcached_st *ptr, char *key, size_t key_length,
 267                     size_t *value_length,
 268                     uint32_t *flags,
 269                     memcached_return *error);
 270 memcached_return memcached_mget(memcached_st *ptr,
 271                                 char **keys, size_t *key_length,
 272                                 unsigned int number_of_keys);
 273 char *memcached_fetch(memcached_st *ptr, char *key, size_t *key_length,
 274                       size_t *value_length, uint32_t *flags,
 275                       memcached_return *error);
 276 memcached_result_st *memcached_fetch_result(memcached_st *ptr,
 277                                             memcached_result_st *result,
 278                                             memcached_return *error);
 279
 280 /* Server Public functions */
 281 #define memcached_server_count(A) (A)->number_of_hosts
 282 #define memcached_server_name(A,B) (B).hostname
 283 #define memcached_server_port(A,B) (B).port
 284 #define memcached_server_list(A) (A)->hosts
 285 #define memcached_server_response_count(A,B) (A)->hosts[B].cursor_active
 286
 287 memcached_return memcached_server_add_udp(memcached_st *ptr,
 288                                           char *hostname,
 289                                           unsigned int port);
 290 memcached_return memcached_server_add_unix_socket(memcached_st *ptr,
 291                                                   char *filename);
 292 memcached_return memcached_server_add(memcached_st *ptr, char *hostname,
 293                                       unsigned int port);
 294 void memcached_server_list_free(memcached_server_st *ptr);
 295 memcached_return memcached_server_push(memcached_st *ptr, memcached_server_st *list);
 296
 297 memcached_server_st *memcached_server_list_append(memcached_server_st *ptr,
 298                                              char *hostname, unsigned int port,
 299                                              memcached_return *error);
 300 unsigned int memcached_server_list_count(memcached_server_st *ptr);
 301 memcached_server_st *memcached_servers_parse(char *server_strings);
 302
 303 char *memcached_stat_get_value(memcached_st *ptr, memcached_stat_st *stat,
 304                                char *key, memcached_return *error);
 305 char ** memcached_stat_get_keys(memcached_st *ptr, memcached_stat_st *stat,
 306                                 memcached_return *error);
 307
 308 char *memcached_get_by_key(memcached_st *ptr,
 309                            char *master_key, size_t master_key_length,
 310                            char *key, size_t key_length,
 311                            size_t *value_length,
 312                            uint32_t *flags,
 313                            memcached_return *error);
 314
 315 memcached_return memcached_mget_by_key(memcached_st *ptr,
 316                                        char *master_key, size_t master_key_length,
 317                                        char **keys, size_t *key_length,
 318                                        unsigned int number_of_keys);
 319
 320 memcached_return memcached_set_by_key(memcached_st *ptr,
 321                                       char *master_key, size_t master_key_length,
 322                                       char *key, size_t key_length,
 323                                       char *value, size_t value_length,
 324                                       time_t expiration,
 325                                       uint32_t flags);
 326
 327 memcached_return memcached_add_by_key(memcached_st *ptr,
 328                                       char *master_key, size_t master_key_length,
 329                                       char *key, size_t key_length,
 330                                       char *value, size_t value_length,
 331                                       time_t expiration,
 332                                       uint32_t flags);
 333
 334 memcached_return memcached_replace_by_key(memcached_st *ptr,
 335                                           char *master_key, size_t master_key_length,
 336                                           char *key, size_t key_length,
 337                                           char *value, size_t value_length,
 338                                           time_t expiration,
 339                                           uint32_t flags);
 340
 341 memcached_return memcached_prepend_by_key(memcached_st *ptr,
 342                                           char *master_key, size_t master_key_length,
 343                                           char *key, size_t key_length,
 344                                           char *value, size_t value_length,
 345                                           time_t expiration,
 346                                           uint32_t flags);
 347
 348 memcached_return memcached_append_by_key(memcached_st *ptr,
 349                                          char *master_key, size_t master_key_length,
 350                                          char *key, size_t key_length,
 351                                          char *value, size_t value_length,
 352                                          time_t expiration,
 353                                          uint32_t flags);
 354
 355 memcached_return memcached_cas_by_key(memcached_st *ptr,
 356                                       char *master_key, size_t master_key_length,
 357                                       char *key, size_t key_length,
 358                                       char *value, size_t value_length,
 359                                       time_t expiration,
 360                                       uint32_t flags,
 361                                       uint64_t cas);
 362 memcached_return memcached_delete_by_key(memcached_st *ptr,
 363                                          char *master_key, size_t master_key_length,
 364                                          char *key, size_t key_length,
 365                                          time_t expiration);
 366
 367 memcached_return memcached_mdelete(memcached_st *ptr,
 368                                    char **key, size_t *key_length,
 369                                    unsigned int number_of_keys,
 370                                    time_t expiration);
 371
 372 memcached_return memcached_mdelete_by_key(memcached_st *ptr,
 373                                           char *master_key, size_t master_key_length,
 374                                           char **key, size_t *key_length,
 375                                           unsigned int number_of_keys,
 376                                           time_t expiration);
 377
 378 memcached_return memcached_fetch_execute(memcached_st *ptr,
 379                                              unsigned int (*callback[])(memcached_st *ptr, memcached_result_st *result, void *context),
 380                                              void *context,
 381                                              unsigned int number_of_callbacks
 382                                              );
 383
 384 /* Result Struct */
 385 void memcached_result_free(memcached_result_st *result);
 386 memcached_result_st *memcached_result_create(memcached_st *ptr,
 387                                              memcached_result_st *result);
 388 #define memcached_result_key_value(A) (A)->key
 389 #define memcached_result_key_length(A) (A)->key_length
 390 #ifdef FIX
 391 #define memcached_result_value(A) memcached_string_value((A)->value)
 392 #define memcached_result_length(A) memcached_string_length((A)->value)
 393 #else
 394 char *memcached_result_value(memcached_result_st *ptr);
 395 size_t memcached_result_length(memcached_result_st *ptr);
 396 #endif
 397 #define memcached_result_flags(A) (A)->flags
 398 #define memcached_result_cas(A) (A)->cas
 399
 400
 401 #ifndef __WATCHPOINT_H__
 402 #define __WATCHPOINT_H__
 403 /* Some personal debugging functions */
 404 #ifdef HAVE_DEBUG
 405 #define WATCHPOINT fprintf(stderr, "\nWATCHPOINT %s:%d (%s)\n", __FILE__, __LINE__,__func__);fflush(stdout);
 406 #ifdef __MEMCACHED_H__
 407 #define WATCHPOINT_ERROR(A) fprintf(stderr, "\nWATCHPOINT %s:%d %s\n", __FILE__, __LINE__, memcached_strerror(NULL, A));fflush(stdout);
 408 #define WATCHPOINT_IFERROR(A) if(A != MEMCACHED_SUCCESS)fprintf(stderr, "\nWATCHPOINT %s:%d %s\n", __FILE__, __LINE__, memcached_strerror(NULL, A));fflush(stdout);
 409 #endif
 410 #define WATCHPOINT_STRING(A) fprintf(stderr, "\nWATCHPOINT %s:%d (%s) %s\n", __FILE__, __LINE__,__func__,A);fflush(stdout);
 411 #define WATCHPOINT_STRING_LENGTH(A,B) fprintf(stderr, "\nWATCHPOINT %s:%d (%s) %.*s\n", __FILE__, __LINE__,__func__,(int)B,A);fflush(stdout);
 412 #define WATCHPOINT_NUMBER(A) fprintf(stderr, "\nWATCHPOINT %s:%d (%s) %zu\n", __FILE__, __LINE__,__func__,(size_t)(A));fflush(stdout);
 413 #define WATCHPOINT_ERRNO(A) fprintf(stderr, "\nWATCHPOINT %s:%d (%s) %s\n", __FILE__, __LINE__,__func__, strerror(A));A= 0;fflush(stdout);
 414 #define WATCHPOINT_ASSERT(A) assert((A));
 415 #else
 416 #define WATCHPOINT
 417 #ifdef __MEMCACHED_H__
 418 #define WATCHPOINT_ERROR(A)
 419 #define WATCHPOINT_IFERROR(A)
 420 #endif
 421 #define WATCHPOINT_STRING(A)
 422 #define WATCHPOINT_NUMBER(A)
 423 #define WATCHPOINT_ERRNO(A)
 424 #define WATCHPOINT_ASSERT(A)
 425 #endif
 426
 427 #endif /* __WATCHPOINT_H__ */
 428
 429
 430 #ifdef __cplusplus
 431 }
 432 #endif
 433
 434 #endif /* __MEMCACHED_H__ */