1   
//
1   
//
2   
// Copyright (c) 2026 Steve Gerbino
2   
// Copyright (c) 2026 Steve Gerbino
3   
//
3   
//
4   
// Distributed under the Boost Software License, Version 1.0. (See accompanying
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)
5   
// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
6   
//
6   
//
7   
// Official repository: https://github.com/cppalliance/corosio
7   
// Official repository: https://github.com/cppalliance/corosio
8   
//
8   
//
9  
9  
10   
#ifndef BOOST_COROSIO_IO_IO_READ_STREAM_HPP
10   
#ifndef BOOST_COROSIO_IO_IO_READ_STREAM_HPP
11   
#define BOOST_COROSIO_IO_IO_READ_STREAM_HPP
11   
#define BOOST_COROSIO_IO_IO_READ_STREAM_HPP
12  
12  
13   
#include <boost/corosio/detail/config.hpp>
13   
#include <boost/corosio/detail/config.hpp>
14   
#include <boost/corosio/detail/op_base.hpp>
14   
#include <boost/corosio/detail/op_base.hpp>
15   
#include <boost/corosio/io/io_object.hpp>
15   
#include <boost/corosio/io/io_object.hpp>
16   
#include <boost/corosio/detail/buffer_param.hpp>
16   
#include <boost/corosio/detail/buffer_param.hpp>
17   
#include <boost/capy/io_result.hpp>
17   
#include <boost/capy/io_result.hpp>
18   
#include <boost/capy/ex/executor_ref.hpp>
18   
#include <boost/capy/ex/executor_ref.hpp>
19   
#include <boost/capy/ex/io_env.hpp>
19   
#include <boost/capy/ex/io_env.hpp>
20  
20  
21   
#include <coroutine>
21   
#include <coroutine>
22   
#include <cstddef>
22   
#include <cstddef>
23   
#include <stop_token>
23   
#include <stop_token>
24   
#include <system_error>
24   
#include <system_error>
25  
25  
26   
namespace boost::corosio {
26   
namespace boost::corosio {
27  
27  
28   
/** Abstract base for streams that support async reads.
28   
/** Abstract base for streams that support async reads.
29  
29  
30   
    Provides the `read_some` operation via a pure virtual
30   
    Provides the `read_some` operation via a pure virtual
31   
    `do_read_some` dispatch point. Concrete classes override
31   
    `do_read_some` dispatch point. Concrete classes override
32   
    `do_read_some` to route through their implementation.
32   
    `do_read_some` to route through their implementation.
33  
33  
34   
    Uses virtual inheritance from @ref io_object so that
34   
    Uses virtual inheritance from @ref io_object so that
35   
    @ref io_stream can combine this with @ref io_write_stream
35   
    @ref io_stream can combine this with @ref io_write_stream
36   
    without duplicating the `io_object` base.
36   
    without duplicating the `io_object` base.
37  
37  
38   
    @par Thread Safety
38   
    @par Thread Safety
39   
    Distinct objects: Safe.
39   
    Distinct objects: Safe.
40   
    Shared objects: Unsafe.
40   
    Shared objects: Unsafe.
41  
41  
42   
    @see io_write_stream, io_stream, io_object
42   
    @see io_write_stream, io_stream, io_object
43   
*/
43   
*/
44   
class BOOST_COROSIO_DECL io_read_stream : virtual public io_object
44   
class BOOST_COROSIO_DECL io_read_stream : virtual public io_object
45   
{
45   
{
46   
protected:
46   
protected:
47   
    /// Awaitable for async read operations.
47   
    /// Awaitable for async read operations.
48   
    template<class MutableBufferSequence>
48   
    template<class MutableBufferSequence>
49   
    struct read_some_awaitable
49   
    struct read_some_awaitable
50   
        : detail::bytes_op_base<read_some_awaitable<MutableBufferSequence>>
50   
        : detail::bytes_op_base<read_some_awaitable<MutableBufferSequence>>
51   
    {
51   
    {
52   
        io_read_stream& ios_;
52   
        io_read_stream& ios_;
53   
        MutableBufferSequence buffers_;
53   
        MutableBufferSequence buffers_;
54  
54  
55   
        read_some_awaitable(
55   
        read_some_awaitable(
56   
            io_read_stream& ios, MutableBufferSequence buffers) noexcept
56   
            io_read_stream& ios, MutableBufferSequence buffers) noexcept
57   
            : ios_(ios), buffers_(std::move(buffers)) {}
57   
            : ios_(ios), buffers_(std::move(buffers)) {}
58  
58  
59   
        std::coroutine_handle<> dispatch(
59   
        std::coroutine_handle<> dispatch(
60   
            std::coroutine_handle<> h, capy::executor_ref ex) const
60   
            std::coroutine_handle<> h, capy::executor_ref ex) const
61   
        {
61   
        {
62   
            return ios_.do_read_some(
62   
            return ios_.do_read_some(
63   
                h, ex, buffers_, this->token_, &this->ec_, &this->bytes_);
63   
                h, ex, buffers_, this->token_, &this->ec_, &this->bytes_);
64   
        }
64   
        }
65   
    };
65   
    };
66  
66  
67   
    /** Dispatch a read through the concrete implementation.
67   
    /** Dispatch a read through the concrete implementation.
68  
68  
69   
        @param h Coroutine handle to resume on completion.
69   
        @param h Coroutine handle to resume on completion.
70   
        @param ex Executor for dispatching the completion.
70   
        @param ex Executor for dispatching the completion.
71   
        @param buffers Target buffer sequence.
71   
        @param buffers Target buffer sequence.
72   
        @param token Stop token for cancellation.
72   
        @param token Stop token for cancellation.
73   
        @param ec Output error code.
73   
        @param ec Output error code.
74   
        @param bytes Output bytes transferred.
74   
        @param bytes Output bytes transferred.
75  
75  
76   
        @return Coroutine handle to resume immediately.
76   
        @return Coroutine handle to resume immediately.
77   
    */
77   
    */
78   
    virtual std::coroutine_handle<> do_read_some(
78   
    virtual std::coroutine_handle<> do_read_some(
79   
        std::coroutine_handle<>,
79   
        std::coroutine_handle<>,
80   
        capy::executor_ref,
80   
        capy::executor_ref,
81   
        buffer_param,
81   
        buffer_param,
82   
        std::stop_token,
82   
        std::stop_token,
83   
        std::error_code*,
83   
        std::error_code*,
84   
        std::size_t*) = 0;
84   
        std::size_t*) = 0;
85  
85  
86   
    io_read_stream() noexcept = default;
86   
    io_read_stream() noexcept = default;
87  
87  
88   
    /// Construct from a handle.
88   
    /// Construct from a handle.
89   
    explicit io_read_stream(handle h) noexcept : io_object(std::move(h)) {}
89   
    explicit io_read_stream(handle h) noexcept : io_object(std::move(h)) {}
90  
90  
91   
    io_read_stream(io_read_stream&&) noexcept            = default;
91   
    io_read_stream(io_read_stream&&) noexcept            = default;
92   
    io_read_stream& operator=(io_read_stream&&) noexcept = delete;
92   
    io_read_stream& operator=(io_read_stream&&) noexcept = delete;
93   
    io_read_stream(io_read_stream const&)                = delete;
93   
    io_read_stream(io_read_stream const&)                = delete;
94   
    io_read_stream& operator=(io_read_stream const&)     = delete;
94   
    io_read_stream& operator=(io_read_stream const&)     = delete;
95  
95  
96   
public:
96   
public:
97   
    /** Asynchronously read data from the stream.
97   
    /** Asynchronously read data from the stream.
98  
98  
99   
        Suspends the calling coroutine and initiates a kernel-level
99   
        Suspends the calling coroutine and initiates a kernel-level
100   
        read. The coroutine resumes when at least one byte is read,
100   
        read. The coroutine resumes when at least one byte is read,
101   
        an error occurs, or the operation is cancelled.
101   
        an error occurs, or the operation is cancelled.
102  
102  
103   
        This stream must outlive the returned awaitable. The memory
103   
        This stream must outlive the returned awaitable. The memory
104   
        referenced by @p buffers must remain valid until the operation
104   
        referenced by @p buffers must remain valid until the operation
105   
        completes.
105   
        completes.
106  
106  
107   
        @param buffers The buffer sequence to read data into.
107   
        @param buffers The buffer sequence to read data into.
108  
108  
109   
        @return An awaitable yielding `(error_code, std::size_t)`.
109   
        @return An awaitable yielding `(error_code, std::size_t)`.
110  
110  
111   
        @see io_stream::write_some
111   
        @see io_stream::write_some
112   
    */
112   
    */
113   
    template<capy::MutableBufferSequence MB>
113   
    template<capy::MutableBufferSequence MB>
114   
    auto read_some(MB const& buffers)
114   
    auto read_some(MB const& buffers)
115   
    {
115   
    {
116   
        return read_some_awaitable<MB>(*this, buffers);
116   
        return read_some_awaitable<MB>(*this, buffers);
117   
    }
117   
    }
118   
};
118   
};
119  
119  
120   
} // namespace boost::corosio
120   
} // namespace boost::corosio
121  
121  
122   
#endif
122   
#endif