ceph/src/Beast/doc/types/Streams.qbk

   1 [/
   2     Copyright (c) 2013-2017 Vinnie Falco (vinnie dot falco at gmail dot com)
   3
   4     Distributed under the Boost Software License, Version 1.0. (See accompanying
   5     file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
   6 ]
   7
   8 [section:streams Streams requirements]
   9
  10 Stream types represent objects capable of performing synchronous or
  11 asynchronous I/O. They are based on concepts from `boost::asio`.
  12
  13 [heading:Stream Stream]
  14
  15 A type modeling [*`Stream`] meets either or both of the following requirements:
  16
  17 * [*`AsyncStream`]
  18 * [*`SyncStream`]
  19
  20 [heading:AsyncStream AsyncStream]
  21
  22 A type modeling [*`AsyncStream`] meets the following requirements:
  23
  24 * [@http://www.boost.org/doc/libs/1_61_0/doc/html/boost_asio/reference/AsyncReadStream.html [*`AsyncReadStream`]]
  25 * [@http://www.boost.org/doc/libs/1_61_0/doc/html/boost_asio/reference/AsyncWriteStream.html [*`AsyncWriteStream`]]
  26
  27 [heading:SyncStream SyncStream]
  28
  29 A type modeling [*`SyncStream`] meets the following requirements:
  30
  31 * [@http://www.boost.org/doc/libs/1_61_0/doc/html/boost_asio/reference/SyncReadStream.html [*`SyncReadStream`]]
  32 * [@http://www.boost.org/doc/libs/1_61_0/doc/html/boost_asio/reference/SyncWriteStream.html [*`SyncWriteStream`]]
  33
  34 [endsect]