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