buffered_write_stream.hpp 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471
  1. //
  2. // impl/buffered_write_stream.hpp
  3. // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  4. //
  5. // Copyright (c) 2003-2019 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 BOOST_ASIO_IMPL_BUFFERED_WRITE_STREAM_HPP
  11. #define BOOST_ASIO_IMPL_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 <boost/asio/associated_allocator.hpp>
  16. #include <boost/asio/associated_executor.hpp>
  17. #include <boost/asio/detail/handler_alloc_helpers.hpp>
  18. #include <boost/asio/detail/handler_cont_helpers.hpp>
  19. #include <boost/asio/detail/handler_invoke_helpers.hpp>
  20. #include <boost/asio/detail/handler_type_requirements.hpp>
  21. #include <boost/asio/detail/non_const_lvalue.hpp>
  22. #include <boost/asio/detail/push_options.hpp>
  23. namespace boost {
  24. namespace asio {
  25. template <typename Stream>
  26. std::size_t buffered_write_stream<Stream>::flush()
  27. {
  28. std::size_t bytes_written = write(next_layer_,
  29. buffer(storage_.data(), storage_.size()));
  30. storage_.consume(bytes_written);
  31. return bytes_written;
  32. }
  33. template <typename Stream>
  34. std::size_t buffered_write_stream<Stream>::flush(boost::system::error_code& ec)
  35. {
  36. std::size_t bytes_written = write(next_layer_,
  37. buffer(storage_.data(), storage_.size()),
  38. transfer_all(), ec);
  39. storage_.consume(bytes_written);
  40. return bytes_written;
  41. }
  42. namespace detail
  43. {
  44. template <typename WriteHandler>
  45. class buffered_flush_handler
  46. {
  47. public:
  48. buffered_flush_handler(detail::buffered_stream_storage& storage,
  49. WriteHandler& handler)
  50. : storage_(storage),
  51. handler_(BOOST_ASIO_MOVE_CAST(WriteHandler)(handler))
  52. {
  53. }
  54. #if defined(BOOST_ASIO_HAS_MOVE)
  55. buffered_flush_handler(const buffered_flush_handler& other)
  56. : storage_(other.storage_),
  57. handler_(other.handler_)
  58. {
  59. }
  60. buffered_flush_handler(buffered_flush_handler&& other)
  61. : storage_(other.storage_),
  62. handler_(BOOST_ASIO_MOVE_CAST(WriteHandler)(other.handler_))
  63. {
  64. }
  65. #endif // defined(BOOST_ASIO_HAS_MOVE)
  66. void operator()(const boost::system::error_code& ec,
  67. const std::size_t bytes_written)
  68. {
  69. storage_.consume(bytes_written);
  70. handler_(ec, bytes_written);
  71. }
  72. //private:
  73. detail::buffered_stream_storage& storage_;
  74. WriteHandler handler_;
  75. };
  76. template <typename WriteHandler>
  77. inline void* asio_handler_allocate(std::size_t size,
  78. buffered_flush_handler<WriteHandler>* this_handler)
  79. {
  80. return boost_asio_handler_alloc_helpers::allocate(
  81. size, this_handler->handler_);
  82. }
  83. template <typename WriteHandler>
  84. inline void asio_handler_deallocate(void* pointer, std::size_t size,
  85. buffered_flush_handler<WriteHandler>* this_handler)
  86. {
  87. boost_asio_handler_alloc_helpers::deallocate(
  88. pointer, size, this_handler->handler_);
  89. }
  90. template <typename WriteHandler>
  91. inline bool asio_handler_is_continuation(
  92. buffered_flush_handler<WriteHandler>* this_handler)
  93. {
  94. return boost_asio_handler_cont_helpers::is_continuation(
  95. this_handler->handler_);
  96. }
  97. template <typename Function, typename WriteHandler>
  98. inline void asio_handler_invoke(Function& function,
  99. buffered_flush_handler<WriteHandler>* this_handler)
  100. {
  101. boost_asio_handler_invoke_helpers::invoke(
  102. function, this_handler->handler_);
  103. }
  104. template <typename Function, typename WriteHandler>
  105. inline void asio_handler_invoke(const Function& function,
  106. buffered_flush_handler<WriteHandler>* this_handler)
  107. {
  108. boost_asio_handler_invoke_helpers::invoke(
  109. function, this_handler->handler_);
  110. }
  111. template <typename Stream>
  112. class initiate_async_buffered_flush
  113. {
  114. public:
  115. typedef typename remove_reference<
  116. Stream>::type::lowest_layer_type::executor_type executor_type;
  117. explicit initiate_async_buffered_flush(Stream& next_layer)
  118. : next_layer_(next_layer)
  119. {
  120. }
  121. executor_type get_executor() const BOOST_ASIO_NOEXCEPT
  122. {
  123. return next_layer_.lowest_layer().get_executor();
  124. }
  125. template <typename WriteHandler>
  126. void operator()(BOOST_ASIO_MOVE_ARG(WriteHandler) handler,
  127. buffered_stream_storage* storage) const
  128. {
  129. // If you get an error on the following line it means that your handler
  130. // does not meet the documented type requirements for a WriteHandler.
  131. BOOST_ASIO_WRITE_HANDLER_CHECK(WriteHandler, handler) type_check;
  132. non_const_lvalue<WriteHandler> handler2(handler);
  133. async_write(next_layer_, buffer(storage->data(), storage->size()),
  134. buffered_flush_handler<typename decay<WriteHandler>::type>(
  135. *storage, handler2.value));
  136. }
  137. private:
  138. Stream& next_layer_;
  139. };
  140. } // namespace detail
  141. #if !defined(GENERATING_DOCUMENTATION)
  142. template <typename WriteHandler, typename Allocator>
  143. struct associated_allocator<
  144. detail::buffered_flush_handler<WriteHandler>, Allocator>
  145. {
  146. typedef typename associated_allocator<WriteHandler, Allocator>::type type;
  147. static type get(const detail::buffered_flush_handler<WriteHandler>& h,
  148. const Allocator& a = Allocator()) BOOST_ASIO_NOEXCEPT
  149. {
  150. return associated_allocator<WriteHandler, Allocator>::get(h.handler_, a);
  151. }
  152. };
  153. template <typename WriteHandler, typename Executor>
  154. struct associated_executor<
  155. detail::buffered_flush_handler<WriteHandler>, Executor>
  156. {
  157. typedef typename associated_executor<WriteHandler, Executor>::type type;
  158. static type get(const detail::buffered_flush_handler<WriteHandler>& h,
  159. const Executor& ex = Executor()) BOOST_ASIO_NOEXCEPT
  160. {
  161. return associated_executor<WriteHandler, Executor>::get(h.handler_, ex);
  162. }
  163. };
  164. #endif // !defined(GENERATING_DOCUMENTATION)
  165. template <typename Stream>
  166. template <
  167. BOOST_ASIO_COMPLETION_TOKEN_FOR(void (boost::system::error_code,
  168. std::size_t)) WriteHandler>
  169. BOOST_ASIO_INITFN_AUTO_RESULT_TYPE(WriteHandler,
  170. void (boost::system::error_code, std::size_t))
  171. buffered_write_stream<Stream>::async_flush(
  172. BOOST_ASIO_MOVE_ARG(WriteHandler) handler)
  173. {
  174. return async_initiate<WriteHandler,
  175. void (boost::system::error_code, std::size_t)>(
  176. detail::initiate_async_buffered_flush<Stream>(next_layer_),
  177. handler, &storage_);
  178. }
  179. template <typename Stream>
  180. template <typename ConstBufferSequence>
  181. std::size_t buffered_write_stream<Stream>::write_some(
  182. const ConstBufferSequence& buffers)
  183. {
  184. using boost::asio::buffer_size;
  185. if (buffer_size(buffers) == 0)
  186. return 0;
  187. if (storage_.size() == storage_.capacity())
  188. this->flush();
  189. return this->copy(buffers);
  190. }
  191. template <typename Stream>
  192. template <typename ConstBufferSequence>
  193. std::size_t buffered_write_stream<Stream>::write_some(
  194. const ConstBufferSequence& buffers, boost::system::error_code& ec)
  195. {
  196. ec = boost::system::error_code();
  197. using boost::asio::buffer_size;
  198. if (buffer_size(buffers) == 0)
  199. return 0;
  200. if (storage_.size() == storage_.capacity() && !flush(ec))
  201. return 0;
  202. return this->copy(buffers);
  203. }
  204. namespace detail
  205. {
  206. template <typename ConstBufferSequence, typename WriteHandler>
  207. class buffered_write_some_handler
  208. {
  209. public:
  210. buffered_write_some_handler(detail::buffered_stream_storage& storage,
  211. const ConstBufferSequence& buffers, WriteHandler& handler)
  212. : storage_(storage),
  213. buffers_(buffers),
  214. handler_(BOOST_ASIO_MOVE_CAST(WriteHandler)(handler))
  215. {
  216. }
  217. #if defined(BOOST_ASIO_HAS_MOVE)
  218. buffered_write_some_handler(const buffered_write_some_handler& other)
  219. : storage_(other.storage_),
  220. buffers_(other.buffers_),
  221. handler_(other.handler_)
  222. {
  223. }
  224. buffered_write_some_handler(buffered_write_some_handler&& other)
  225. : storage_(other.storage_),
  226. buffers_(other.buffers_),
  227. handler_(BOOST_ASIO_MOVE_CAST(WriteHandler)(other.handler_))
  228. {
  229. }
  230. #endif // defined(BOOST_ASIO_HAS_MOVE)
  231. void operator()(const boost::system::error_code& ec, std::size_t)
  232. {
  233. if (ec)
  234. {
  235. const std::size_t length = 0;
  236. handler_(ec, length);
  237. }
  238. else
  239. {
  240. using boost::asio::buffer_size;
  241. std::size_t orig_size = storage_.size();
  242. std::size_t space_avail = storage_.capacity() - orig_size;
  243. std::size_t bytes_avail = buffer_size(buffers_);
  244. std::size_t length = bytes_avail < space_avail
  245. ? bytes_avail : space_avail;
  246. storage_.resize(orig_size + length);
  247. const std::size_t bytes_copied = boost::asio::buffer_copy(
  248. storage_.data() + orig_size, buffers_, length);
  249. handler_(ec, bytes_copied);
  250. }
  251. }
  252. //private:
  253. detail::buffered_stream_storage& storage_;
  254. ConstBufferSequence buffers_;
  255. WriteHandler handler_;
  256. };
  257. template <typename ConstBufferSequence, typename WriteHandler>
  258. inline void* asio_handler_allocate(std::size_t size,
  259. buffered_write_some_handler<
  260. ConstBufferSequence, WriteHandler>* this_handler)
  261. {
  262. return boost_asio_handler_alloc_helpers::allocate(
  263. size, this_handler->handler_);
  264. }
  265. template <typename ConstBufferSequence, typename WriteHandler>
  266. inline void asio_handler_deallocate(void* pointer, std::size_t size,
  267. buffered_write_some_handler<
  268. ConstBufferSequence, WriteHandler>* this_handler)
  269. {
  270. boost_asio_handler_alloc_helpers::deallocate(
  271. pointer, size, this_handler->handler_);
  272. }
  273. template <typename ConstBufferSequence, typename WriteHandler>
  274. inline bool asio_handler_is_continuation(
  275. buffered_write_some_handler<
  276. ConstBufferSequence, WriteHandler>* this_handler)
  277. {
  278. return boost_asio_handler_cont_helpers::is_continuation(
  279. this_handler->handler_);
  280. }
  281. template <typename Function, typename ConstBufferSequence,
  282. typename WriteHandler>
  283. inline void asio_handler_invoke(Function& function,
  284. buffered_write_some_handler<
  285. ConstBufferSequence, WriteHandler>* this_handler)
  286. {
  287. boost_asio_handler_invoke_helpers::invoke(
  288. function, this_handler->handler_);
  289. }
  290. template <typename Function, typename ConstBufferSequence,
  291. typename WriteHandler>
  292. inline void asio_handler_invoke(const Function& function,
  293. buffered_write_some_handler<
  294. ConstBufferSequence, WriteHandler>* this_handler)
  295. {
  296. boost_asio_handler_invoke_helpers::invoke(
  297. function, this_handler->handler_);
  298. }
  299. template <typename Stream>
  300. class initiate_async_buffered_write_some
  301. {
  302. public:
  303. typedef typename remove_reference<
  304. Stream>::type::lowest_layer_type::executor_type executor_type;
  305. explicit initiate_async_buffered_write_some(Stream& next_layer)
  306. : next_layer_(next_layer)
  307. {
  308. }
  309. executor_type get_executor() const BOOST_ASIO_NOEXCEPT
  310. {
  311. return next_layer_.lowest_layer().get_executor();
  312. }
  313. template <typename WriteHandler, typename ConstBufferSequence>
  314. void operator()(BOOST_ASIO_MOVE_ARG(WriteHandler) handler,
  315. buffered_stream_storage* storage,
  316. const ConstBufferSequence& buffers) const
  317. {
  318. // If you get an error on the following line it means that your handler
  319. // does not meet the documented type requirements for a WriteHandler.
  320. BOOST_ASIO_WRITE_HANDLER_CHECK(WriteHandler, handler) type_check;
  321. using boost::asio::buffer_size;
  322. non_const_lvalue<WriteHandler> handler2(handler);
  323. if (buffer_size(buffers) == 0 || storage->size() < storage->capacity())
  324. {
  325. next_layer_.async_write_some(BOOST_ASIO_CONST_BUFFER(0, 0),
  326. buffered_write_some_handler<ConstBufferSequence,
  327. typename decay<WriteHandler>::type>(
  328. *storage, buffers, handler2.value));
  329. }
  330. else
  331. {
  332. initiate_async_buffered_flush<Stream>(this->next_layer_)(
  333. buffered_write_some_handler<ConstBufferSequence,
  334. typename decay<WriteHandler>::type>(
  335. *storage, buffers, handler2.value),
  336. storage);
  337. }
  338. }
  339. private:
  340. Stream& next_layer_;
  341. };
  342. } // namespace detail
  343. #if !defined(GENERATING_DOCUMENTATION)
  344. template <typename ConstBufferSequence,
  345. typename WriteHandler, typename Allocator>
  346. struct associated_allocator<
  347. detail::buffered_write_some_handler<ConstBufferSequence, WriteHandler>,
  348. Allocator>
  349. {
  350. typedef typename associated_allocator<WriteHandler, Allocator>::type type;
  351. static type get(
  352. const detail::buffered_write_some_handler<
  353. ConstBufferSequence, WriteHandler>& h,
  354. const Allocator& a = Allocator()) BOOST_ASIO_NOEXCEPT
  355. {
  356. return associated_allocator<WriteHandler, Allocator>::get(h.handler_, a);
  357. }
  358. };
  359. template <typename ConstBufferSequence,
  360. typename WriteHandler, typename Executor>
  361. struct associated_executor<
  362. detail::buffered_write_some_handler<ConstBufferSequence, WriteHandler>,
  363. Executor>
  364. {
  365. typedef typename associated_executor<WriteHandler, Executor>::type type;
  366. static type get(
  367. const detail::buffered_write_some_handler<
  368. ConstBufferSequence, WriteHandler>& h,
  369. const Executor& ex = Executor()) BOOST_ASIO_NOEXCEPT
  370. {
  371. return associated_executor<WriteHandler, Executor>::get(h.handler_, ex);
  372. }
  373. };
  374. #endif // !defined(GENERATING_DOCUMENTATION)
  375. template <typename Stream>
  376. template <typename ConstBufferSequence,
  377. BOOST_ASIO_COMPLETION_TOKEN_FOR(void (boost::system::error_code,
  378. std::size_t)) WriteHandler>
  379. BOOST_ASIO_INITFN_AUTO_RESULT_TYPE(WriteHandler,
  380. void (boost::system::error_code, std::size_t))
  381. buffered_write_stream<Stream>::async_write_some(
  382. const ConstBufferSequence& buffers,
  383. BOOST_ASIO_MOVE_ARG(WriteHandler) handler)
  384. {
  385. return async_initiate<WriteHandler,
  386. void (boost::system::error_code, std::size_t)>(
  387. detail::initiate_async_buffered_write_some<Stream>(next_layer_),
  388. handler, &storage_, buffers);
  389. }
  390. template <typename Stream>
  391. template <typename ConstBufferSequence>
  392. std::size_t buffered_write_stream<Stream>::copy(
  393. const ConstBufferSequence& buffers)
  394. {
  395. using boost::asio::buffer_size;
  396. std::size_t orig_size = storage_.size();
  397. std::size_t space_avail = storage_.capacity() - orig_size;
  398. std::size_t bytes_avail = buffer_size(buffers);
  399. std::size_t length = bytes_avail < space_avail ? bytes_avail : space_avail;
  400. storage_.resize(orig_size + length);
  401. return boost::asio::buffer_copy(
  402. storage_.data() + orig_size, buffers, length);
  403. }
  404. } // namespace asio
  405. } // namespace boost
  406. #include <boost/asio/detail/pop_options.hpp>
  407. #endif // BOOST_ASIO_IMPL_BUFFERED_WRITE_STREAM_HPP