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_host_st memcached_host_st;
  34
  35 #define MEMCACHED_DEFAULT_PORT 11211
  36 #define MEMCACHED_DEFAULT_COMMAND_SIZE 350
  37 #define HUGE_STRING_LEN 8196
  38
  39 typedef enum {
  40   MEMCACHED_SUCCESS,
  41   MEMCACHED_FAILURE,
  42   MEMCACHED_HOST_LOCKUP_FAILURE,
  43   MEMCACHED_CONNECTION_FAILURE,
  44   MEMCACHED_CONNECTION_BIND_FAILURE,
  45   MEMCACHED_WRITE_FAILURE,
  46   MEMCACHED_READ_FAILURE,
  47   MEMCACHED_UNKNOWN_READ_FAILURE,
  48   MEMCACHED_PROTOCOL_ERROR,
  49   MEMCACHED_CLIENT_ERROR,
  50   MEMCACHED_SERVER_ERROR,
  51   MEMCACHED_CONNECTION_SOCKET_CREATE_FAILURE,
  52   MEMCACHED_DATA_EXISTS,
  53   MEMCACHED_DATA_DOES_NOT_EXIST,
  54   MEMCACHED_NOTSTORED,
  55   MEMCACHED_NOTFOUND,
  56   MEMCACHED_MEMORY_ALLOCATION_FAILURE,
  57   MEMCACHED_PARTIAL_READ,
  58 } memcached_return;
  59
  60 typedef enum {
  61   MEMCACHED_NOT_ALLOCATED= 0,
  62   MEMCACHED_ALLOCATED= 1,
  63 } memcached_allocated;
  64
  65 struct memcached_host_st {
  66   char *hostname;
  67   unsigned int port;
  68   memcached_host_st *next;
  69 };
  70
  71 struct memcached_stat_st {
  72   unsigned int pid;
  73   unsigned int uptime;
  74   unsigned int threads;
  75   time_t time;
  76   char version[8];
  77   unsigned int pointer_size;
  78   unsigned int rusage_user;
  79   unsigned int rusage_system;
  80   unsigned int rusage_user_seconds;
  81   unsigned int rusage_user_microseconds;
  82   unsigned int rusage_system_seconds;
  83   unsigned int rusage_system_microseconds;
  84   unsigned int curr_items;
  85   unsigned int total_items;
  86   unsigned long long bytes;
  87   unsigned int curr_connections;
  88   unsigned int total_connections;
  89   unsigned int connection_structures;
  90   unsigned long long cmd_get;
  91   unsigned long long cmd_set;
  92   unsigned long long get_hits;
  93   unsigned long long get_misses;
  94   unsigned long long evictions;
  95   unsigned long long bytes_read;
  96   unsigned long long bytes_written;
  97   unsigned int limit_maxbytes;
  98 };
  99
 100 struct memcached_st {
 101   memcached_allocated is_allocated;
 102   int fd;
 103   char connected;
 104   memcached_host_st *hosts;
 105 };
 106
 107 /* Public API */
 108 memcached_st *memcached_init(memcached_st *ptr);
 109 void memcached_deinit(memcached_st *ptr);
 110
 111 memcached_return memcached_set(memcached_st *ptr, char *key, size_t key_length,
 112                                char *value, size_t value_length,
 113                                time_t expiration,
 114                                uint16_t  flags);
 115 memcached_return memcached_add(memcached_st *ptr, char *key, size_t key_length,
 116                                char *value, size_t value_length,
 117                                time_t expiration,
 118                                uint16_t  flags);
 119 memcached_return memcached_replace(memcached_st *ptr, char *key, size_t key_length,
 120                                    char *value, size_t value_length,
 121                                    time_t expiration,
 122                                    uint16_t  flags);
 123 memcached_return memcached_delete(memcached_st *ptr, char *key, size_t key_length,
 124                                   time_t expiration);
 125 memcached_return memcached_increment(memcached_st *ptr, char *key, size_t key_length,
 126                                      unsigned int count);
 127 memcached_return memcached_decrement(memcached_st *ptr, char *key, size_t key_length,
 128                                      unsigned int count);
 129 memcached_stat_st **memcached_stat(memcached_st *ptr, memcached_return *error);
 130 memcached_return memcached_stat_hostname(memcached_stat_st *stat, char *args,
 131                                          char *hostname, unsigned int port);
 132 memcached_return memcached_flush(memcached_st *ptr, time_t expiration);
 133 char *memcached_version(memcached_st *ptr, memcached_return *error);
 134 memcached_return memcached_verbosity(memcached_st *ptr, unsigned int verbosity);
 135 memcached_return memcached_quit(memcached_st *ptr);
 136 char *memcached_get(memcached_st *ptr, char *key, size_t key_length,
 137                     size_t *value_length,
 138                     uint16_t *flags,
 139                     memcached_return *error);
 140 memcached_return memcached_server_add(memcached_st *ptr, char *hostname, unsigned int port);
 141 char *memcached_strerror(memcached_st *ptr, memcached_return rc);
 142
 143 /* These are all private, do not use. */
 144 memcached_return memcached_connect(memcached_st *ptr);
 145 memcached_return memcached_response(memcached_st *ptr,
 146                                     char *buffer,
 147                                     size_t buffer_length);
 148
 149 #ifdef __cplusplus
 150 }
 151 #endif
 152
 153 #endif /* __MEMCACHED_H__ */