Mass rename to simplify names.
[m6w6/libmemcached] / libmemcached / io.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: Server IO, Not public!
9 *
10 */
11
12 #ifndef LIBMEMCACHED_MEMCACHED_IO_H
13 #define LIBMEMCACHED_MEMCACHED_IO_H
14
15 #ifdef __cplusplus
16 extern "C" {
17 #endif
18
19 #if defined(BUILDING_LIBMEMCACHED)
20
21 #include "libmemcached/memcached.h"
22
23 #define MAX_UDP_DATAGRAM_LENGTH 1400
24 #define UDP_DATAGRAM_HEADER_LENGTH 8
25 #define UDP_REQUEST_ID_MSG_SIG_DIGITS 10
26 #define UDP_REQUEST_ID_THREAD_MASK 0xFFFF << UDP_REQUEST_ID_MSG_SIG_DIGITS
27 #define get_udp_datagram_request_id(A) ntohs((A)->request_id)
28 #define get_udp_datagram_seq_num(A) ntohs((A)->sequence_number)
29 #define get_udp_datagram_num_datagrams(A) ntohs((A)->num_datagrams)
30 #define get_msg_num_from_request_id(A) ( (A) & (~(UDP_REQUEST_ID_THREAD_MASK)) )
31 #define get_thread_id_from_request_id(A) ( (A) & (UDP_REQUEST_ID_THREAD_MASK) ) >> UDP_REQUEST_ID_MSG_SIG_DIGITS
32 #define generate_udp_request_thread_id(A) (A) << UDP_REQUEST_ID_MSG_SIG_DIGITS
33 #define UDP_REQUEST_ID_MAX_THREAD_ID get_thread_id_from_request_id(0xFFFF)
34
35 struct udp_datagram_header_st {
36 uint16_t request_id;
37 uint16_t sequence_number;
38 uint16_t num_datagrams;
39 uint16_t reserved;
40 };
41
42 ssize_t memcached_io_write(memcached_server_st *ptr,
43 const void *buffer, size_t length, char with_flush);
44 void memcached_io_reset(memcached_server_st *ptr);
45 memcached_return_t memcached_io_read(memcached_server_st *ptr,
46 void *buffer, size_t length, ssize_t *nread);
47 /* Read a line (terminated by '\n') into the buffer */
48 memcached_return_t memcached_io_readline(memcached_server_st *ptr,
49 char *buffer_ptr,
50 size_t size);
51 memcached_return_t memcached_io_close(memcached_server_st *ptr);
52 /* Read n bytes of data from the server and store them in dta */
53 memcached_return_t memcached_safe_read(memcached_server_st *ptr,
54 void *dta,
55 size_t size);
56 /* Read a single response from the server */
57 memcached_return_t memcached_read_one_response(memcached_server_st *ptr,
58 char *buffer, size_t buffer_length,
59 memcached_result_st *result);
60 memcached_return_t memcached_io_init_udp_header(memcached_server_st *ptr,
61 uint16_t thread_id);
62
63 memcached_server_st *memcached_io_get_readable_server(memcached_st *memc);
64
65 #endif /* BUILDING_LIBMEMCACHED */
66
67 #ifdef __cplusplus
68 }
69 #endif
70
71 #endif /* LIBMEMCACHED_MEMCACHED_IO_H */