buffered_read_stream.hpp 15 KB

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