ff54fe5738179c1a066ded2f826e4360698bee73
[awesomized/libmemcached] / lib / common.h
1 /*
2 Common include file for libmemached
3 */
4
5 #ifndef __COMMON_H__
6 #define __COMMON_H__
7
8 #include <stdio.h>
9 #include <stdlib.h>
10 #include <string.h>
11 #include <ctype.h>
12 #include <sys/types.h>
13 #include <sys/socket.h>
14 #include <netinet/in.h>
15 #include <arpa/inet.h>
16 #include <netdb.h>
17 #include <unistd.h>
18 #include <limits.h>
19 #include <assert.h>
20 #include <errno.h>
21 #include <fcntl.h>
22 #include <sys/un.h>
23 #include <netinet/tcp.h>
24 #include <libmemcached_config.h>
25
26 #if TIME_WITH_SYS_TIME
27 # include <sys/time.h>
28 # include <time.h>
29 #else
30 # if HAVE_SYS_TIME_H
31 # include <sys/time.h>
32 # else
33 # include <time.h>
34 # endif
35 #endif
36
37
38
39 #include <memcached.h>
40 #include "memcached_io.h"
41
42 #include <libmemcached_config.h>
43
44 #ifdef HAVE_DTRACE
45 #define _DTRACE_VERSION 1
46 #else
47 #undef _DTRACE_VERSION
48 #endif
49
50 #include "libmemcached_probes.h"
51
52 #define MEMCACHED_BLOCK_SIZE 1024
53 #define MEMCACHED_DEFAULT_COMMAND_SIZE 350
54 #define SMALL_STRING_LEN 1024
55 #define HUGE_STRING_LEN 8196
56
57
58 typedef enum {
59 MEM_NO_BLOCK= (1 << 0),
60 MEM_TCP_NODELAY= (1 << 1),
61 MEM_REUSE_MEMORY= (1 << 2),
62 MEM_USE_MD5= (1 << 3),
63 MEM_USE_KETAMA= (1 << 4),
64 MEM_USE_CRC= (1 << 5),
65 MEM_USE_CACHE_LOOKUPS= (1 << 6),
66 MEM_SUPPORT_CAS= (1 << 7),
67 MEM_BUFFER_REQUESTS= (1 << 8),
68 MEM_USE_SORT_HOSTS= (1 << 9),
69 } memcached_flags;
70
71 /* Hashing algo */
72 void md5_signature(unsigned char *key, unsigned int length, unsigned char *result);
73 uint32_t hash_crc32(const char *data,
74 size_t data_len);
75 uint32_t hsieh_hash(char *key, size_t key_length);
76
77 memcached_return memcached_connect(memcached_server_st *ptr);
78 memcached_return memcached_response(memcached_server_st *ptr,
79 char *buffer, size_t buffer_length,
80 memcached_result_st *result);
81 unsigned int memcached_generate_hash(memcached_st *ptr, char *key, size_t key_length);
82 void memcached_quit_server(memcached_server_st *ptr, uint8_t io_death);
83
84 #define memcached_server_response_increment(A) (A)->cursor_active++
85 #define memcached_server_response_decrement(A) (A)->cursor_active--
86 #define memcached_server_response_reset(A) (A)->cursor_active=0
87
88 /* String Struct */
89 #define memcached_string_length(A) (size_t)((A)->end - (A)->string)
90 #define memcached_string_set_length(A, B) (A)->end= (A)->string + B
91 #define memcached_string_size(A) (A)->current_size
92 #define memcached_string_value(A) (A)->string
93
94 memcached_string_st *memcached_string_create(memcached_st *ptr,
95 memcached_string_st *string,
96 size_t initial_size);
97 memcached_return memcached_string_check(memcached_string_st *string, size_t need);
98 char *memcached_string_c_copy(memcached_string_st *string);
99 memcached_return memcached_string_append_character(memcached_string_st *string,
100 char character);
101 memcached_return memcached_string_append(memcached_string_st *string,
102 char *value, size_t length);
103 size_t memcached_string_backspace(memcached_string_st *string, size_t remove);
104 memcached_return memcached_string_reset(memcached_string_st *string);
105 void memcached_string_free(memcached_string_st *string);
106 memcached_return memcached_do(memcached_server_st *ptr, char *commmand,
107 size_t command_length, uint8_t with_flush);
108 memcached_return memcached_version(memcached_st *ptr);
109 memcached_return value_fetch(memcached_server_st *ptr,
110 char *buffer,
111 memcached_result_st *result);
112 void server_list_free(memcached_st *ptr, memcached_server_st *servers);
113
114 memcached_return key_proof(char **keys, size_t *key_length,
115 unsigned int number_of_keys);
116
117 #ifdef HAVE_DEBUG
118 #define key_test(A,B,C) key_proof(A,B,C)
119 #else
120 #define key_test(A,B,C) MEMCACHED_SUCCESS
121 #endif
122
123 #endif /* __COMMON_H__ */