2 * Copyright (C) 2006-2009 Brian Aker
5 * Use and distribution licensed under the BSD license. See
6 * the COPYING file in the parent directory for full text.
8 * Summary: String structure used for libmemcached.
12 #ifndef __LIBMEMCACHED_SERVER_H__
13 #define __LIBMEMCACHED_SERVER_H__
16 struct memcached_server_st
{
18 bool is_allocated MEMCACHED_BITFIELD
;
19 bool is_initialized MEMCACHED_BITFIELD
;
20 bool sockaddr_inited MEMCACHED_BITFIELD
;
21 bool is_shutting_down MEMCACHED_BITFIELD
;
23 uint32_t number_of_hosts
;
24 uint32_t cursor_active
;
28 uint32_t io_bytes_sent
; /* # bytes sent since last read */
29 uint32_t server_failure_counter
;
31 struct { // Place any "state" sort variables in here.
34 uint8_t major_version
;
35 uint8_t micro_version
;
36 uint8_t minor_version
;
37 memcached_connection_t type
;
39 char *cached_server_error
;
40 size_t read_buffer_length
;
41 size_t read_data_length
;
42 size_t write_buffer_offset
;
43 struct addrinfo
*address_info
;
45 const memcached_st
*root
;
46 uint64_t limit_maxbytes
;
47 char read_buffer
[MEMCACHED_MAX_BUFFER
];
48 char write_buffer
[MEMCACHED_MAX_BUFFER
];
49 char hostname
[NI_MAXHOST
];
58 memcached_return_t
memcached_server_cursor(memcached_st
*ptr
,
59 memcached_server_fn
*callback
,
61 uint32_t number_of_callbacks
);
64 memcached_server_st
*memcached_server_by_key(memcached_st
*ptr
,
67 memcached_return_t
*error
);
70 const char *memcached_server_error(memcached_server_st
*ptr
);
73 void memcached_server_error_reset(memcached_server_st
*ptr
);
75 /* These should not currently be used by end users */
76 /* TODO: Is the above comment valid? If so, how can we unit test these if they
77 * aren't exported. If not, we should remove the comment */
80 memcached_server_st
*memcached_server_create_with(const memcached_st
*memc
,
81 memcached_server_st
*host
,
85 memcached_connection_t type
);
88 void memcached_server_free(memcached_server_st
*ptr
);
91 memcached_server_st
*memcached_server_clone(memcached_server_st
*destination
,
92 const memcached_server_st
*source
);
95 memcached_return_t
memcached_server_remove(memcached_server_st
*st_ptr
);
98 memcached_server_st
*memcached_server_get_last_disconnect(memcached_st
*ptr
);
102 memcached_return_t
memcached_server_add_udp(memcached_st
*ptr
,
103 const char *hostname
,
106 memcached_return_t
memcached_server_add_unix_socket(memcached_st
*ptr
,
107 const char *filename
);
109 memcached_return_t
memcached_server_add(memcached_st
*ptr
,
110 const char *hostname
, in_port_t port
);
113 memcached_return_t
memcached_server_add_udp_with_weight(memcached_st
*ptr
,
114 const char *hostname
,
118 memcached_return_t
memcached_server_add_unix_socket_with_weight(memcached_st
*ptr
,
119 const char *filename
,
122 memcached_return_t
memcached_server_add_with_weight(memcached_st
*ptr
, const char *hostname
,
125 /* Server List Public functions */
128 void memcached_server_list_free(memcached_server_st
*ptr
);
132 memcached_return_t
memcached_server_push(memcached_st
*ptr
, memcached_server_st
*list
);
135 memcached_server_st
*memcached_server_list_append(memcached_server_st
*ptr
,
136 const char *hostname
,
138 memcached_return_t
*error
);
140 memcached_server_st
*memcached_server_list_append_with_weight(memcached_server_st
*ptr
,
141 const char *hostname
,
144 memcached_return_t
*error
);
146 unsigned int memcached_server_list_count(memcached_server_st
*ptr
);
149 static inline uint32_t memcached_servers_count(memcached_server_st
*servers
)
151 return servers
->number_of_hosts
;
155 static inline uint32_t memcached_servers_set_count(memcached_server_st
*servers
, uint32_t count
)
157 return servers
->number_of_hosts
= count
;
161 #define memcached_server_count(A) (A)->number_of_hosts
162 #define memcached_server_name(A,B) (B).hostname
163 #define memcached_server_port(A,B) (B).port
164 #define memcached_server_list(A) (A)->servers
165 #define memcached_server_list_set(A,B) (A)->servers=(B)
166 #define memcached_server_response_count(A) (A)->cursor_active
172 #endif /* __LIBMEMCACHED_SERVER_H__ */