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