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 <stdio.h>
  14 #include <stdlib.h>
  15 #include <string.h>
  16 #include <sys/types.h>
  17 #include <sys/socket.h>
  18 #include <netinet/in.h>
  19 #include <arpa/inet.h>
  20 #include <netdb.h>
  21 #include <unistd.h>
  22 #include <limits.h>
  23 #include <assert.h>
  24 #include <time.h>
  25 #include <errno.h>
  26
  27 #ifdef __cplusplus
  28 extern "C" {
  29 #endif
  30
  31 typedef struct memcached_st memcached_st;
  32 typedef struct memcached_stat_st memcached_stat_st;
  33 typedef struct memcached_string_st memcached_string_st;
  34 typedef struct memcached_server_st memcached_server_st;
  35
  36 #define MEMCACHED_DEFAULT_PORT 11211
  37 #define MEMCACHED_DEFAULT_COMMAND_SIZE 350
  38 #define SMALL_STRING_LEN 1024
  39 #define HUGE_STRING_LEN 8196
  40 #define MEMCACHED_MAX_KEY 251 /* We add one to have it null terminated */
  41 //#define MEMCACHED_MAX_BUFFER 8196
  42 #define MEMCACHED_MAX_BUFFER 8196
  43
  44 typedef enum {
  45   MEMCACHED_SUCCESS,
  46   MEMCACHED_FAILURE,
  47   MEMCACHED_HOST_LOCKUP_FAILURE,
  48   MEMCACHED_CONNECTION_FAILURE,
  49   MEMCACHED_CONNECTION_BIND_FAILURE,
  50   MEMCACHED_WRITE_FAILURE,
  51   MEMCACHED_READ_FAILURE,
  52   MEMCACHED_UNKNOWN_READ_FAILURE,
  53   MEMCACHED_PROTOCOL_ERROR,
  54   MEMCACHED_CLIENT_ERROR,
  55   MEMCACHED_SERVER_ERROR,
  56   MEMCACHED_CONNECTION_SOCKET_CREATE_FAILURE,
  57   MEMCACHED_DATA_EXISTS,
  58   MEMCACHED_DATA_DOES_NOT_EXIST,
  59   MEMCACHED_NOTSTORED,
  60   MEMCACHED_NOTFOUND,
  61   MEMCACHED_MEMORY_ALLOCATION_FAILURE,
  62   MEMCACHED_PARTIAL_READ,
  63   MEMCACHED_SOME_ERRORS,
  64   MEMCACHED_NO_SERVERS,
  65   MEMCACHED_END,
  66   MEMCACHED_DELETED,
  67   MEMCACHED_VALUE,
  68   MEMCACHED_MAXIMUM_RETURN, /* Always add new error code before */
  69 } memcached_return;
  70
  71 typedef enum {
  72   MEMCACHED_NOT_ALLOCATED= 0,
  73   MEMCACHED_ALLOCATED= 1,
  74 } memcached_allocated;
  75
  76 struct memcached_server_st {
  77   char *hostname;
  78   unsigned int port;
  79   int fd;
  80 };
  81
  82 struct memcached_stat_st {
  83   unsigned int pid;
  84   unsigned int uptime;
  85   unsigned int threads;
  86   time_t time;
  87   char version[8];
  88   unsigned int pointer_size;
  89   unsigned int rusage_user;
  90   unsigned int rusage_system;
  91   unsigned int rusage_user_seconds;
  92   unsigned int rusage_user_microseconds;
  93   unsigned int rusage_system_seconds;
  94   unsigned int rusage_system_microseconds;
  95   unsigned int curr_items;
  96   unsigned int total_items;
  97   unsigned long long bytes;
  98   unsigned int curr_connections;
  99   unsigned int total_connections;
 100   unsigned int connection_structures;
 101   unsigned long long cmd_get;
 102   unsigned long long cmd_set;
 103   unsigned long long get_hits;
 104   unsigned long long get_misses;
 105   unsigned long long evictions;
 106   unsigned long long bytes_read;
 107   unsigned long long bytes_written;
 108   unsigned int limit_maxbytes;
 109 };
 110
 111 struct memcached_string_st {
 112   char *string;
 113   char *end;
 114   size_t current_size;
 115   size_t block_size;
 116 };
 117
 118 struct memcached_st {
 119   memcached_allocated is_allocated;
 120   memcached_server_st *hosts;
 121   unsigned int number_of_hosts;
 122   unsigned int cursor_server;
 123   char read_buffer[MEMCACHED_MAX_BUFFER];
 124   size_t read_buffer_length;
 125   char *read_ptr;
 126   char write_buffer[MEMCACHED_MAX_BUFFER];
 127   size_t write_buffer_offset;
 128   size_t write_between_flush;
 129   char connected;
 130 };
 131
 132 /* Public API */
 133 memcached_st *memcached_create(memcached_st *ptr);
 134 void memcached_free(memcached_st *ptr);
 135
 136 memcached_return memcached_delete(memcached_st *ptr, char *key, size_t key_length,
 137                                   time_t expiration);
 138 memcached_return memcached_increment(memcached_st *ptr,
 139                                      char *key, size_t key_length,
 140                                      unsigned int offset,
 141                                      unsigned int *value);
 142 memcached_return memcached_decrement(memcached_st *ptr,
 143                                      char *key, size_t key_length,
 144                                      unsigned int offset,
 145                                      unsigned int *value);
 146 memcached_stat_st *memcached_stat(memcached_st *ptr, char *args, memcached_return *error);
 147 memcached_return memcached_stat_servername(memcached_stat_st *stat, char *args,
 148                                            char *hostname, unsigned int port);
 149 memcached_return memcached_flush(memcached_st *ptr, time_t expiration);
 150 memcached_return memcached_verbosity(memcached_st *ptr, unsigned int verbosity);
 151 void memcached_quit(memcached_st *ptr);
 152 char *memcached_strerror(memcached_st *ptr, memcached_return rc);
 153
 154 /* All of the functions for adding data to the server */
 155 memcached_return memcached_set(memcached_st *ptr, char *key, size_t key_length,
 156                                char *value, size_t value_length,
 157                                time_t expiration,
 158                                uint16_t  flags);
 159 memcached_return memcached_add(memcached_st *ptr, char *key, size_t key_length,
 160                                char *value, size_t value_length,
 161                                time_t expiration,
 162                                uint16_t  flags);
 163 memcached_return memcached_replace(memcached_st *ptr, char *key, size_t key_length,
 164                                    char *value, size_t value_length,
 165                                    time_t expiration,
 166                                    uint16_t  flags);
 167
 168 /* Get functions */
 169 char *memcached_get(memcached_st *ptr, char *key, size_t key_length,
 170                     size_t *value_length,
 171                     uint16_t *flags,
 172                     memcached_return *error);
 173 memcached_return memcached_mget(memcached_st *ptr,
 174                                 char **keys, size_t *key_length,
 175                                 unsigned int number_of_keys);
 176 char *memcached_fetch(memcached_st *ptr, char *key, size_t *key_length,
 177                       size_t *value_length, uint16_t *flags,
 178                       memcached_return *error);
 179
 180 /* Server Public functions */
 181 #define memcached_server_count(A) A->number_of_hosts
 182 #define memcached_server_name(A,B) B.hostname
 183 #define memcached_server_port(A,B) B.port
 184 #define memcached_server_list(A) A->hosts
 185
 186 memcached_return memcached_server_add(memcached_st *ptr, char *hostname,
 187                                       unsigned int port);
 188
 189 memcached_server_st *memcached_server_list_append(memcached_server_st *ptr,
 190                                              char *hostname, unsigned int port,
 191                                              memcached_return *error);
 192 void memcached_server_list_free(memcached_server_st *ptr);
 193 memcached_return memcached_server_push(memcached_st *ptr, memcached_server_st *list);
 194 unsigned int memcached_server_list_count(memcached_server_st *ptr);
 195
 196 /* These are all private, do not use. */
 197 memcached_return memcached_connect(memcached_st *ptr);
 198 memcached_return memcached_response(memcached_st *ptr,
 199                                     char *buffer, size_t buffer_length,
 200                                     unsigned int server_key);
 201 unsigned int memcached_generate_hash(char *key, size_t key_length);
 202 char *memcached_stat_get_value(memcached_st *ptr, memcached_stat_st *stat,
 203                                char *key, memcached_return *error);
 204 char ** memcached_stat_get_keys(memcached_st *ptr, memcached_stat_st *stat,
 205                                 memcached_return *error);
 206
 207
 208 /* String Struct */
 209 #define memcached_string_length(A, B) (size_t)(B->end - B->string)
 210 #define memcached_string_size(A, B) B->current_size
 211 #define memcached_string_value(A, B) B->string
 212
 213 memcached_string_st *memcached_string_create(memcached_st *ptr, size_t initial_size);
 214 memcached_return memcached_string_append_character(memcached_st *ptr,
 215                                                    memcached_string_st *string,
 216                                                    char character);
 217 memcached_return memcached_string_append(memcached_st *ptr, memcached_string_st *string,
 218                                          char *value, size_t length);
 219 size_t memcached_string_backspace(memcached_st *ptr, memcached_string_st *string, size_t remove);
 220 memcached_return memcached_string_reset(memcached_st *ptr, memcached_string_st *string);
 221 void memcached_string_free(memcached_st *ptr, memcached_string_st *string);
 222
 223 /* Some personal debugging functions */
 224 #define WATCHPOINT printf("WATCHPOINT %s:%d\n", __FILE__, __LINE__);fflush(stdout);
 225 #define WATCHPOINT_ERROR(A) printf("WATCHPOINT %s:%d %s\n", __FILE__, __LINE__, memcached_strerror(NULL, A));fflush(stdout);
 226 #define WATCHPOINT_STRING(A) printf("WATCHPOINT %s:%d %s\n", __FILE__, __LINE__, A);fflush(stdout);
 227 #define WATCHPOINT_NUMBER(A) printf("WATCHPOINT %s:%d %d\n", __FILE__, __LINE__, A);fflush(stdout);
 228
 229
 230 #ifdef __cplusplus
 231 }
 232 #endif
 233
 234 #endif /* __MEMCACHED_H__ */