buffered_write_stream.hpp 7.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249
  1. //
  2. // buffered_write_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_WRITE_STREAM_HPP
  11. #define ASIO_BUFFERED_WRITE_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/buffered_write_stream_fwd.hpp"
  18. #include "asio/buffer.hpp"
  19. #include "asio/completion_condition.hpp"
  20. #include "asio/detail/bind_handler.hpp"
  21. #include "asio/detail/buffered_stream_storage.hpp"
  22. #include "asio/detail/noncopyable.hpp"
  23. #include "asio/detail/type_traits.hpp"
  24. #include "asio/error.hpp"
  25. #include "asio/io_context.hpp"
  26. #include "asio/write.hpp"
  27. #include "asio/detail/push_options.hpp"
  28. namespace asio {
  29. /// Adds buffering to the write-related operations of a stream.
  30. /**
  31. * The buffered_write_stream class template can be used to add buffering to the
  32. * synchronous and asynchronous write 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_write_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_write_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_write_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. /// Flush all data from the buffer to the next layer. Returns the number of
  118. /// bytes written to the next layer on the last write operation. Throws an
  119. /// exception on failure.
  120. std::size_t flush();
  121. /// Flush all data from the buffer to the next layer. Returns the number of
  122. /// bytes written to the next layer on the last write operation, or 0 if an
  123. /// error occurred.
  124. std::size_t flush(asio::error_code& ec);
  125. /// Start an asynchronous flush.
  126. template <typename WriteHandler>
  127. ASIO_INITFN_RESULT_TYPE(WriteHandler,
  128. void (asio::error_code, std::size_t))
  129. async_flush(ASIO_MOVE_ARG(WriteHandler) handler);
  130. /// Write the given data to the stream. Returns the number of bytes written.
  131. /// Throws an exception on failure.
  132. template <typename ConstBufferSequence>
  133. std::size_t write_some(const ConstBufferSequence& buffers);
  134. /// Write the given data to the stream. Returns the number of bytes written,
  135. /// or 0 if an error occurred and the error handler did not throw.
  136. template <typename ConstBufferSequence>
  137. std::size_t write_some(const ConstBufferSequence& buffers,
  138. asio::error_code& ec);
  139. /// Start an asynchronous write. The data being written must be valid for the
  140. /// lifetime of the asynchronous operation.
  141. template <typename ConstBufferSequence, typename WriteHandler>
  142. ASIO_INITFN_RESULT_TYPE(WriteHandler,
  143. void (asio::error_code, std::size_t))
  144. async_write_some(const ConstBufferSequence& buffers,
  145. ASIO_MOVE_ARG(WriteHandler) handler);
  146. /// Read some data from the stream. Returns the number of bytes read. Throws
  147. /// an exception on failure.
  148. template <typename MutableBufferSequence>
  149. std::size_t read_some(const MutableBufferSequence& buffers)
  150. {
  151. return next_layer_.read_some(buffers);
  152. }
  153. /// Read some data from the stream. Returns the number of bytes read or 0 if
  154. /// an error occurred.
  155. template <typename MutableBufferSequence>
  156. std::size_t read_some(const MutableBufferSequence& buffers,
  157. asio::error_code& ec)
  158. {
  159. return next_layer_.read_some(buffers, ec);
  160. }
  161. /// Start an asynchronous read. The buffer into which the data will be read
  162. /// must be valid for the lifetime of the asynchronous operation.
  163. template <typename MutableBufferSequence, typename ReadHandler>
  164. ASIO_INITFN_RESULT_TYPE(ReadHandler,
  165. void (asio::error_code, std::size_t))
  166. async_read_some(const MutableBufferSequence& buffers,
  167. ASIO_MOVE_ARG(ReadHandler) handler)
  168. {
  169. return next_layer_.async_read_some(buffers,
  170. ASIO_MOVE_CAST(ReadHandler)(handler));
  171. }
  172. /// Peek at the incoming data on the stream. Returns the number of bytes read.
  173. /// Throws an exception on failure.
  174. template <typename MutableBufferSequence>
  175. std::size_t peek(const MutableBufferSequence& buffers)
  176. {
  177. return next_layer_.peek(buffers);
  178. }
  179. /// Peek at the incoming data on the stream. Returns the number of bytes read,
  180. /// or 0 if an error occurred.
  181. template <typename MutableBufferSequence>
  182. std::size_t peek(const MutableBufferSequence& buffers,
  183. asio::error_code& ec)
  184. {
  185. return next_layer_.peek(buffers, ec);
  186. }
  187. /// Determine the amount of data that may be read without blocking.
  188. std::size_t in_avail()
  189. {
  190. return next_layer_.in_avail();
  191. }
  192. /// Determine the amount of data that may be read without blocking.
  193. std::size_t in_avail(asio::error_code& ec)
  194. {
  195. return next_layer_.in_avail(ec);
  196. }
  197. private:
  198. /// Copy data into the internal buffer from the specified source buffer.
  199. /// Returns the number of bytes copied.
  200. template <typename ConstBufferSequence>
  201. std::size_t copy(const ConstBufferSequence& buffers);
  202. /// The next layer.
  203. Stream next_layer_;
  204. // The data in the buffer.
  205. detail::buffered_stream_storage storage_;
  206. };
  207. } // namespace asio
  208. #include "asio/detail/pop_options.hpp"
  209. #include "asio/impl/buffered_write_stream.hpp"
  210. #endif // ASIO_BUFFERED_WRITE_STREAM_HPP