Merge Monty
[m6w6/libmemcached] / libmemcached / server.h
1 /* LibMemcached
2 * Copyright (C) 2006-2009 Brian Aker
3 * All rights reserved.
4 *
5 * Use and distribution licensed under the BSD license. See
6 * the COPYING file in the parent directory for full text.
7 *
8 * Summary: String structure used for libmemcached.
9 *
10 */
11
12 #ifndef __MEMCACHED_SERVER_H__
13 #define __MEMCACHED_SERVER_H__
14
15 #ifdef __cplusplus
16 extern "C" {
17 #endif
18
19 struct memcached_server_st {
20 struct {
21 bool is_allocated:1;
22 bool sockaddr_inited:1;
23 } options;
24 uint32_t number_of_hosts;
25 uint32_t cursor_active;
26 in_port_t port;
27 int cached_errno;
28 int fd;
29 uint32_t io_bytes_sent; /* # bytes sent since last read */
30 uint32_t server_failure_counter;
31 uint32_t weight;
32 uint8_t major_version;
33 uint8_t micro_version;
34 uint8_t minor_version;
35 memcached_connection_t type;
36 char *read_ptr;
37 char *cached_server_error;
38 size_t read_buffer_length;
39 size_t read_data_length;
40 size_t write_buffer_offset;
41 struct addrinfo *address_info;
42 time_t next_retry;
43 memcached_st *root;
44 uint64_t limit_maxbytes;
45 char read_buffer[MEMCACHED_MAX_BUFFER];
46 char write_buffer[MEMCACHED_MAX_BUFFER];
47 char hostname[MEMCACHED_MAX_HOST_LENGTH];
48 };
49
50 // Local Only Inline
51 static inline uint32_t memcached_servers_count(memcached_server_st *servers)
52 {
53 return servers->number_of_hosts;
54 }
55
56 // Local Only Inline
57 static inline uint32_t memcached_servers_set_count(memcached_server_st *servers, uint32_t count)
58 {
59 return servers->number_of_hosts= count;
60 }
61
62
63
64 #define memcached_server_count(A) (A)->number_of_hosts
65 #define memcached_server_name(A,B) (B).hostname
66 #define memcached_server_port(A,B) (B).port
67 #define memcached_server_list(A) (A)->servers
68 #define memcached_server_list_set(A,B) (A)->servers=(B)
69 #define memcached_server_response_count(A) (A)->cursor_active
70
71 LIBMEMCACHED_API
72 memcached_return_t memcached_server_cursor(memcached_st *ptr,
73 memcached_server_fn *callback,
74 void *context,
75 uint32_t number_of_callbacks);
76
77 LIBMEMCACHED_API
78 memcached_server_st *memcached_server_by_key(memcached_st *ptr,
79 const char *key,
80 size_t key_length,
81 memcached_return_t *error);
82
83 LIBMEMCACHED_API
84 const char *memcached_server_error(memcached_server_st *ptr);
85
86 LIBMEMCACHED_API
87 void memcached_server_error_reset(memcached_server_st *ptr);
88
89 /* These should not currently be used by end users */
90 /* TODO: Is the above comment valid? If so, how can we unit test these if they
91 * aren't exported. If not, we should remove the comment */
92 LIBMEMCACHED_LOCAL
93 memcached_server_st *memcached_server_create(memcached_st *memc, memcached_server_st *ptr);
94
95 LIBMEMCACHED_LOCAL
96 memcached_server_st *memcached_server_create_with(memcached_st *memc,
97 memcached_server_st *host,
98 const char *hostname,
99 in_port_t port,
100 uint32_t weight,
101 memcached_connection_t type);
102
103 LIBMEMCACHED_API
104 void memcached_server_free(memcached_server_st *ptr);
105
106 LIBMEMCACHED_LOCAL
107 memcached_server_st *memcached_server_clone(memcached_server_st *clone,
108 memcached_server_st *ptr);
109
110 LIBMEMCACHED_API
111 memcached_return_t memcached_server_remove(memcached_server_st *st_ptr);
112
113 LIBMEMCACHED_API
114 memcached_server_st *memcached_server_get_last_disconnect(memcached_st *ptr);
115
116 #ifdef __cplusplus
117 }
118 #endif
119
120 #endif /* __MEMCACHED_SERVER_H__ */