buffered_read_stream.hpp 7.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257
  1. //
  2. // buffered_read_stream.hpp
  3. // ~~~~~~~~~~~~~~~~~~~~~~~~
  4. //
  5. // Copyright (c) 2003-2018 Christopher M. Kohlhoff (chris at kohlhoff dot com)
  6. //
  7. // Distributed under the Boost Software License, Version 1.0. (See accompanying
  8. // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
  9. //
  10. #ifndef ASIO_BUFFERED_READ_STREAM_HPP
  11. #define ASIO_BUFFERED_READ_STREAM_HPP
  12. #if defined(_MSC_VER) && (_MSC_VER >= 1200)
  13. # pragma once
  14. #endif // defined(_MSC_VER) && (_MSC_VER >= 1200)
  15. #include "asio/detail/config.hpp"
  16. #include <cstddef>
  17. #include "asio/async_result.hpp"
  18. #include "asio/buffered_read_stream_fwd.hpp"
  19. #include "asio/buffer.hpp"
  20. #include "asio/detail/bind_handler.hpp"
  21. #include "asio/detail/buffer_resize_guard.hpp"
  22. #include "asio/detail/buffered_stream_storage.hpp"
  23. #include "asio/detail/noncopyable.hpp"
  24. #include "asio/detail/type_traits.hpp"
  25. #include "asio/error.hpp"
  26. #include "asio/io_context.hpp"
  27. #include "asio/detail/push_options.hpp"
  28. namespace asio {
  29. /// Adds buffering to the read-related operations of a stream.
  30. /**
  31. * The buffered_read_stream class template can be used to add buffering to the
  32. * synchronous and asynchronous read operations of a stream.
  33. *
  34. * @par Thread Safety
  35. * @e Distinct @e objects: Safe.@n
  36. * @e Shared @e objects: Unsafe.
  37. *
  38. * @par Concepts:
  39. * AsyncReadStream, AsyncWriteStream, Stream, SyncReadStream, SyncWriteStream.
  40. */
  41. template <typename Stream>
  42. class buffered_read_stream
  43. : private noncopyable
  44. {
  45. public:
  46. /// The type of the next layer.
  47. typedef typename remove_reference<Stream>::type next_layer_type;
  48. /// The type of the lowest layer.
  49. typedef typename next_layer_type::lowest_layer_type lowest_layer_type;
  50. /// The type of the executor associated with the object.
  51. typedef typename lowest_layer_type::executor_type executor_type;
  52. #if defined(GENERATING_DOCUMENTATION)
  53. /// The default buffer size.
  54. static const std::size_t default_buffer_size = implementation_defined;
  55. #else
  56. ASIO_STATIC_CONSTANT(std::size_t, default_buffer_size = 1024);
  57. #endif
  58. /// Construct, passing the specified argument to initialise the next layer.
  59. template <typename Arg>
  60. explicit buffered_read_stream(Arg& a)
  61. : next_layer_(a),
  62. storage_(default_buffer_size)
  63. {
  64. }
  65. /// Construct, passing the specified argument to initialise the next layer.
  66. template <typename Arg>
  67. buffered_read_stream(Arg& a, std::size_t buffer_size)
  68. : next_layer_(a),
  69. storage_(buffer_size)
  70. {
  71. }
  72. /// Get a reference to the next layer.
  73. next_layer_type& next_layer()
  74. {
  75. return next_layer_;
  76. }
  77. /// Get a reference to the lowest layer.
  78. lowest_layer_type& lowest_layer()
  79. {
  80. return next_layer_.lowest_layer();
  81. }
  82. /// Get a const reference to the lowest layer.
  83. const lowest_layer_type& lowest_layer() const
  84. {
  85. return next_layer_.lowest_layer();
  86. }
  87. /// Get the executor associated with the object.
  88. executor_type get_executor() ASIO_NOEXCEPT
  89. {
  90. return next_layer_.lowest_layer().get_executor();
  91. }
  92. #if !defined(ASIO_NO_DEPRECATED)
  93. /// (Deprecated: Use get_executor().) Get the io_context associated with the
  94. /// object.
  95. asio::io_context& get_io_context()
  96. {
  97. return next_layer_.get_io_context();
  98. }
  99. /// (Deprecated: Use get_executor().) Get the io_context associated with the
  100. /// object.
  101. asio::io_context& get_io_service()
  102. {
  103. return next_layer_.get_io_service();
  104. }
  105. #endif // !defined(ASIO_NO_DEPRECATED)
  106. /// Close the stream.
  107. void close()
  108. {
  109. next_layer_.close();
  110. }
  111. /// Close the stream.
  112. ASIO_SYNC_OP_VOID close(asio::error_code& ec)
  113. {
  114. next_layer_.close(ec);
  115. ASIO_SYNC_OP_VOID_RETURN(ec);
  116. }
  117. /// Write the given data to the stream. Returns the number of bytes written.
  118. /// Throws an exception on failure.
  119. template <typename ConstBufferSequence>
  120. std::size_t write_some(const ConstBufferSequence& buffers)
  121. {
  122. return next_layer_.write_some(buffers);
  123. }
  124. /// Write the given data to the stream. Returns the number of bytes written,
  125. /// or 0 if an error occurred.
  126. template <typename ConstBufferSequence>
  127. std::size_t write_some(const ConstBufferSequence& buffers,
  128. asio::error_code& ec)
  129. {
  130. return next_layer_.write_some(buffers, ec);
  131. }
  132. /// Start an asynchronous write. The data being written must be valid for the
  133. /// lifetime of the asynchronous operation.
  134. template <typename ConstBufferSequence, typename WriteHandler>
  135. ASIO_INITFN_RESULT_TYPE(WriteHandler,
  136. void (asio::error_code, std::size_t))
  137. async_write_some(const ConstBufferSequence& buffers,
  138. ASIO_MOVE_ARG(WriteHandler) handler)
  139. {
  140. return next_layer_.async_write_some(buffers,
  141. ASIO_MOVE_CAST(WriteHandler)(handler));
  142. }
  143. /// Fill the buffer with some data. Returns the number of bytes placed in the
  144. /// buffer as a result of the operation. Throws an exception on failure.
  145. std::size_t fill();
  146. /// Fill the buffer with some data. Returns the number of bytes placed in the
  147. /// buffer as a result of the operation, or 0 if an error occurred.
  148. std::size_t fill(asio::error_code& ec);
  149. /// Start an asynchronous fill.
  150. template <typename ReadHandler>
  151. ASIO_INITFN_RESULT_TYPE(ReadHandler,
  152. void (asio::error_code, std::size_t))
  153. async_fill(ASIO_MOVE_ARG(ReadHandler) handler);
  154. /// Read some data from the stream. Returns the number of bytes read. Throws
  155. /// an exception on failure.
  156. template <typename MutableBufferSequence>
  157. std::size_t read_some(const MutableBufferSequence& buffers);
  158. /// Read some data from the stream. Returns the number of bytes read or 0 if
  159. /// an error occurred.
  160. template <typename MutableBufferSequence>
  161. std::size_t read_some(const MutableBufferSequence& buffers,
  162. asio::error_code& ec);
  163. /// Start an asynchronous read. The buffer into which the data will be read
  164. /// must be valid for the lifetime of the asynchronous operation.
  165. template <typename MutableBufferSequence, typename ReadHandler>
  166. ASIO_INITFN_RESULT_TYPE(ReadHandler,
  167. void (asio::error_code, std::size_t))
  168. async_read_some(const MutableBufferSequence& buffers,
  169. ASIO_MOVE_ARG(ReadHandler) handler);
  170. /// Peek at the incoming data on the stream. Returns the number of bytes read.
  171. /// Throws an exception on failure.
  172. template <typename MutableBufferSequence>
  173. std::size_t peek(const MutableBufferSequence& buffers);
  174. /// Peek at the incoming data on the stream. Returns the number of bytes read,
  175. /// or 0 if an error occurred.
  176. template <typename MutableBufferSequence>
  177. std::size_t peek(const MutableBufferSequence& buffers,
  178. asio::error_code& ec);
  179. /// Determine the amount of data that may be read without blocking.
  180. std::size_t in_avail()
  181. {
  182. return storage_.size();
  183. }
  184. /// Determine the amount of data that may be read without blocking.
  185. std::size_t in_avail(asio::error_code& ec)
  186. {
  187. ec = asio::error_code();
  188. return storage_.size();
  189. }
  190. private:
  191. /// Copy data out of the internal buffer to the specified target buffer.
  192. /// Returns the number of bytes copied.
  193. template <typename MutableBufferSequence>
  194. std::size_t copy(const MutableBufferSequence& buffers)
  195. {
  196. std::size_t bytes_copied = asio::buffer_copy(
  197. buffers, storage_.data(), storage_.size());
  198. storage_.consume(bytes_copied);
  199. return bytes_copied;
  200. }
  201. /// Copy data from the internal buffer to the specified target buffer, without
  202. /// removing the data from the internal buffer. Returns the number of bytes
  203. /// copied.
  204. template <typename MutableBufferSequence>
  205. std::size_t peek_copy(const MutableBufferSequence& buffers)
  206. {
  207. return asio::buffer_copy(buffers, storage_.data(), storage_.size());
  208. }
  209. /// The next layer.
  210. Stream next_layer_;
  211. // The data in the buffer.
  212. detail::buffered_stream_storage storage_;
  213. };
  214. } // namespace asio
  215. #include "asio/detail/pop_options.hpp"
  216. #include "asio/impl/buffered_read_stream.hpp"
  217. #endif // ASIO_BUFFERED_READ_STREAM_HPP