git.m6w6.name Git - awesomized/libmemcached/blob - 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_IO_H__
  13 #define __LIBMEMCACHED_IO_H__
  14
  15 #if defined(BUILDING_LIBMEMCACHED)
  16
  17 #include "libmemcached/memcached.h"
  18
  19 #define MAX_UDP_DATAGRAM_LENGTH 1400
  20 #define UDP_DATAGRAM_HEADER_LENGTH 8
  21 #define UDP_REQUEST_ID_MSG_SIG_DIGITS 10
  22 #define UDP_REQUEST_ID_THREAD_MASK 0xFFFF << UDP_REQUEST_ID_MSG_SIG_DIGITS
  23 #define get_udp_datagram_request_id(A) ntohs((A)->request_id)
  24 #define get_udp_datagram_seq_num(A) ntohs((A)->sequence_number)
  25 #define get_udp_datagram_num_datagrams(A) ntohs((A)->num_datagrams)
  26 #define get_msg_num_from_request_id(A) ( (A) & (~(UDP_REQUEST_ID_THREAD_MASK)) )
  27 #define get_thread_id_from_request_id(A) ( (A) & (UDP_REQUEST_ID_THREAD_MASK) ) >> UDP_REQUEST_ID_MSG_SIG_DIGITS
  28 #define generate_udp_request_thread_id(A) (A) << UDP_REQUEST_ID_MSG_SIG_DIGITS
  29 #define UDP_REQUEST_ID_MAX_THREAD_ID get_thread_id_from_request_id(0xFFFF)
  30
  31 struct udp_datagram_header_st
  32 {
  33   uint16_t request_id;
  34   uint16_t sequence_number;
  35   uint16_t num_datagrams;
  36   uint16_t reserved;
  37 };
  38
  39 struct libmemcached_io_vector_st
  40 {
  41   size_t length;
  42   const void *buffer;
  43 };
  44
  45 #ifdef __cplusplus
  46 extern "C" {
  47 #endif
  48
  49 LIBMEMCACHED_LOCAL
  50 memcached_return_t memcached_io_wait_for_write(memcached_server_write_instance_st ptr);
  51
  52 LIBMEMCACHED_LOCAL
  53 ssize_t memcached_io_writev(memcached_server_write_instance_st ptr,
  54                             const struct libmemcached_io_vector_st *vector,
  55                             size_t number_of, bool with_flush);
  56
  57 LIBMEMCACHED_LOCAL
  58 ssize_t memcached_io_write(memcached_server_write_instance_st ptr,
  59                            const void *buffer, size_t length, bool with_flush);
  60
  61 LIBMEMCACHED_LOCAL
  62 void memcached_io_reset(memcached_server_write_instance_st ptr);
  63
  64 LIBMEMCACHED_LOCAL
  65 memcached_return_t memcached_io_read(memcached_server_write_instance_st ptr,
  66                                      void *buffer, size_t length, ssize_t *nread);
  67
  68 /* Read a line (terminated by '\n') into the buffer */
  69 LIBMEMCACHED_LOCAL
  70 memcached_return_t memcached_io_readline(memcached_server_write_instance_st ptr,
  71                                          char *buffer_ptr,
  72                                          size_t size);
  73
  74 LIBMEMCACHED_LOCAL
  75 memcached_return_t memcached_io_close(memcached_server_write_instance_st ptr);
  76
  77 /* Read n bytes of data from the server and store them in dta */
  78 LIBMEMCACHED_LOCAL
  79 memcached_return_t memcached_safe_read(memcached_server_write_instance_st ptr,
  80                                        void *dta,
  81                                        size_t size);
  82
  83 LIBMEMCACHED_LOCAL
  84 memcached_return_t memcached_io_init_udp_header(memcached_server_write_instance_st ptr,
  85                                                 uint16_t thread_id);
  86
  87 LIBMEMCACHED_LOCAL
  88 memcached_server_write_instance_st memcached_io_get_readable_server(memcached_st *memc);
  89
  90 #ifdef __cplusplus
  91 }
  92 #endif
  93
  94 #endif /* BUILDING_LIBMEMCACHED */
  95
  96 #endif /* __LIBMEMCACHED_IO_H__ */