git.m6w6.name Git - m6w6/libmemcached/blob - 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 #ifndef __LIBMEMCACHED_IO_H__
  40 #define __LIBMEMCACHED_IO_H__
  41
  42 #if defined(BUILDING_LIBMEMCACHED)
  43
  44 #include "libmemcached/memcached.h"
  45
  46 #define MAX_UDP_DATAGRAM_LENGTH 1400
  47 #define UDP_DATAGRAM_HEADER_LENGTH 8
  48 #define UDP_REQUEST_ID_MSG_SIG_DIGITS 10
  49 #define UDP_REQUEST_ID_THREAD_MASK 0xFFFF << UDP_REQUEST_ID_MSG_SIG_DIGITS
  50 #define get_udp_datagram_request_id(A) ntohs((A)->request_id)
  51 #define get_udp_datagram_seq_num(A) ntohs((A)->sequence_number)
  52 #define get_udp_datagram_num_datagrams(A) ntohs((A)->num_datagrams)
  53 #define get_msg_num_from_request_id(A) ( (A) & (~(UDP_REQUEST_ID_THREAD_MASK)) )
  54 #define get_thread_id_from_request_id(A) ( (A) & (UDP_REQUEST_ID_THREAD_MASK) ) >> UDP_REQUEST_ID_MSG_SIG_DIGITS
  55 #define generate_udp_request_thread_id(A) (A) << UDP_REQUEST_ID_MSG_SIG_DIGITS
  56 #define UDP_REQUEST_ID_MAX_THREAD_ID get_thread_id_from_request_id(0xFFFF)
  57
  58 struct udp_datagram_header_st
  59 {
  60   uint16_t request_id;
  61   uint16_t sequence_number;
  62   uint16_t num_datagrams;
  63   uint16_t reserved;
  64 };
  65
  66 struct libmemcached_io_vector_st
  67 {
  68   size_t length;
  69   const void *buffer;
  70 };
  71
  72 #ifdef __cplusplus
  73 extern "C" {
  74 #endif
  75
  76 LIBMEMCACHED_LOCAL
  77 memcached_return_t memcached_io_wait_for_write(memcached_server_write_instance_st ptr);
  78
  79 LIBMEMCACHED_LOCAL
  80 ssize_t memcached_io_writev(memcached_server_write_instance_st ptr,
  81                             const struct libmemcached_io_vector_st *vector,
  82                             size_t number_of, bool with_flush);
  83
  84 LIBMEMCACHED_LOCAL
  85 ssize_t memcached_io_write(memcached_server_write_instance_st ptr,
  86                            const void *buffer, size_t length, bool with_flush);
  87
  88 LIBMEMCACHED_LOCAL
  89 void memcached_io_reset(memcached_server_write_instance_st ptr);
  90
  91 LIBMEMCACHED_LOCAL
  92 memcached_return_t memcached_io_read(memcached_server_write_instance_st ptr,
  93                                      void *buffer, size_t length, ssize_t *nread);
  94
  95 /* Read a line (terminated by '\n') into the buffer */
  96 LIBMEMCACHED_LOCAL
  97 memcached_return_t memcached_io_readline(memcached_server_write_instance_st ptr,
  98                                          char *buffer_ptr,
  99                                          size_t size);
 100
 101 LIBMEMCACHED_LOCAL
 102 memcached_return_t memcached_io_close(memcached_server_write_instance_st ptr);
 103
 104 /* Read n bytes of data from the server and store them in dta */
 105 LIBMEMCACHED_LOCAL
 106 memcached_return_t memcached_safe_read(memcached_server_write_instance_st ptr,
 107                                        void *dta,
 108                                        size_t size);
 109
 110 LIBMEMCACHED_LOCAL
 111 memcached_return_t memcached_io_init_udp_header(memcached_server_write_instance_st ptr,
 112                                                 uint16_t thread_id);
 113
 114 LIBMEMCACHED_LOCAL
 115 memcached_server_write_instance_st memcached_io_get_readable_server(memcached_st *memc);
 116
 117 #ifdef __cplusplus
 118 }
 119 #endif
 120
 121 #endif /* BUILDING_LIBMEMCACHED */
 122
 123 #endif /* __LIBMEMCACHED_IO_H__ */