Updating for 1.0.2 release
[awesomized/libmemcached] / libmemcached / io.h
1 /* vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
2 *
3 * LibMemcached
4 *
5 * Copyright (C) 2011 Data Differential, http://datadifferential.com/
6 * Copyright (C) 2006-2009 Brian Aker
7 * All rights reserved.
8 *
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions are
11 * met:
12 *
13 * * Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 *
16 * * Redistributions in binary form must reproduce the above
17 * copyright notice, this list of conditions and the following disclaimer
18 * in the documentation and/or other materials provided with the
19 * distribution.
20 *
21 * * The names of its contributors may not be used to endorse or
22 * promote products derived from this software without specific prior
23 * written permission.
24 *
25 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
26 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
27 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
28 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
29 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
30 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
31 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
32 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
33 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
34 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
35 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 *
37 */
38
39 #pragma once
40
41 #define MAX_UDP_DATAGRAM_LENGTH 1400
42 #define UDP_DATAGRAM_HEADER_LENGTH 8
43 #define UDP_REQUEST_ID_MSG_SIG_DIGITS 10
44 #define UDP_REQUEST_ID_THREAD_MASK 0xFFFF << UDP_REQUEST_ID_MSG_SIG_DIGITS
45 #define get_udp_datagram_request_id(A) ntohs((A)->request_id)
46 #define get_udp_datagram_seq_num(A) ntohs((A)->sequence_number)
47 #define get_udp_datagram_num_datagrams(A) ntohs((A)->num_datagrams)
48 #define get_msg_num_from_request_id(A) ( (A) & (~(UDP_REQUEST_ID_THREAD_MASK)) )
49 #define get_thread_id_from_request_id(A) ( (A) & (UDP_REQUEST_ID_THREAD_MASK) ) >> UDP_REQUEST_ID_MSG_SIG_DIGITS
50 #define generate_udp_request_thread_id(A) (A) << UDP_REQUEST_ID_MSG_SIG_DIGITS
51 #define UDP_REQUEST_ID_MAX_THREAD_ID get_thread_id_from_request_id(0xFFFF)
52
53 struct udp_datagram_header_st
54 {
55 uint16_t request_id;
56 uint16_t sequence_number;
57 uint16_t num_datagrams;
58 uint16_t reserved;
59 };
60
61 struct libmemcached_io_vector_st
62 {
63 const void *buffer;
64 size_t length;
65 };
66
67 #ifdef __cplusplus
68 extern "C" {
69 #endif
70
71 LIBMEMCACHED_LOCAL
72 ssize_t memcached_io_write(memcached_server_write_instance_st ptr,
73 const void *buffer, size_t length, bool with_flush);
74
75 LIBMEMCACHED_LOCAL
76 ssize_t memcached_io_writev(memcached_server_write_instance_st ptr,
77 const struct libmemcached_io_vector_st *vector,
78 size_t number_of, bool with_flush);
79
80 #ifdef __cplusplus
81 }
82 #endif