Fix for solaris.
[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 } options;
23 bool sockaddr_inited;
24 uint16_t count;
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 #define memcached_server_count(A) (A)->number_of_hosts
51 #define memcached_server_name(A,B) (B).hostname
52 #define memcached_server_port(A,B) (B).port
53 #define memcached_server_list(A) (A)->hosts
54 #define memcached_server_response_count(A) (A)->cursor_active
55
56 LIBMEMCACHED_API
57 memcached_return_t memcached_server_cursor(memcached_st *ptr,
58 memcached_server_fn *callback,
59 void *context,
60 uint32_t number_of_callbacks);
61
62 LIBMEMCACHED_API
63 memcached_server_st *memcached_server_by_key(memcached_st *ptr,
64 const char *key,
65 size_t key_length,
66 memcached_return_t *error);
67
68 LIBMEMCACHED_API
69 const char *memcached_server_error(memcached_server_st *ptr);
70
71 LIBMEMCACHED_API
72 void memcached_server_error_reset(memcached_server_st *ptr);
73
74 /* These should not currently be used by end users */
75 /* TODO: Is the above comment valid? If so, how can we unit test these if they
76 * aren't exported. If not, we should remove the comment */
77 LIBMEMCACHED_API
78 memcached_server_st *memcached_server_create(memcached_st *memc, memcached_server_st *ptr);
79
80 LIBMEMCACHED_API
81 memcached_server_st *memcached_server_create_with(memcached_st *memc,
82 memcached_server_st *host,
83 const char *hostname,
84 in_port_t port,
85 uint32_t weight,
86 memcached_connection_t type);
87
88 LIBMEMCACHED_API
89 void memcached_server_free(memcached_server_st *ptr);
90
91 LIBMEMCACHED_API
92 memcached_server_st *memcached_server_clone(memcached_server_st *clone,
93 memcached_server_st *ptr);
94
95 LIBMEMCACHED_API
96 memcached_analysis_st *memcached_analyze(memcached_st *memc,
97 memcached_stat_st *memc_stat,
98 memcached_return_t *error);
99
100 LIBMEMCACHED_API
101 memcached_return_t memcached_server_remove(memcached_server_st *st_ptr);
102
103 LIBMEMCACHED_API
104 memcached_server_st *memcached_server_get_last_disconnect(memcached_st *ptr);
105
106 #ifdef __cplusplus
107 }
108 #endif
109
110 #endif /* __MEMCACHED_SERVER_H__ */