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