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