启动一个异步操作,将数据读取到 streambuf 中,直到它包含指定的定界符。
template< typename AsyncReadStream, typename Allocator, typename ReadToken = default_completion_token_t< typename AsyncReadStream::executor_type>> DEDUCED async_read_until( AsyncReadStream & s, boost::asio::basic_streambuf< Allocator > & b, char delim, ReadToken && token = default_completion_token_t< typename AsyncReadStream::executor_type >());
此函数用于将数据异步读取到指定的 streambuf 中,直到 streambuf 的 get 区域包含指定的定界符。它是 异步操作 的发起函数,并始终立即返回。异步操作将继续执行,直到满足以下任一条件:
此操作通过零次或多次调用流的 async_read_some 函数来实现,并且被称为 组合操作。如果 streambuf 的 get 区域已包含定界符,则此异步操作会立即完成。程序必须确保在操作完成之前,流不执行其他读取操作(例如 async_read、async_read_until、流的 async_read_some 函数或任何其他执行读取的组合操作)。
要从中读取数据的流。该类型必须支持 AsyncReadStream 概念。
一个 streambuf 对象,数据将被读取到其中。streambuf 的所有权由调用者保留,调用者必须确保在调用完成处理程序之前 streambuf 保持有效。
定界符字符。
将用于生成完成处理程序的 完成令牌,该处理程序将在读取完成时被调用。可能的完成令牌包括 use_future
、use_awaitable
、yield_context
,或者具有正确完成签名的函数对象。完成处理程序的函数签名必须为:
void handler( // Result of operation. const boost::system::error_code& error, // The number of bytes in the streambuf's get // area up to and including the delimiter. // 0 if an error occurred. std::size_t bytes_transferred );
无论异步操作是立即完成还是未立即完成,都不会在此函数内部调用完成处理程序。在立即完成时,处理程序的调用将以等同于使用 async_immediate
的方式执行。
void(boost::system::error_code, std::size_t)
在成功的 async_read_until 操作后,streambuf 可能包含超出定界符的其他数据。应用程序通常会将这些数据保留在 streambuf 中,供后续的 async_read_until 操作进行检查。
要异步地将数据读取到 streambuf 中,直到遇到换行符:
boost::asio::streambuf b; ... void handler(const boost::system::error_code& e, std::size_t size) { if (!e) { std::istream is(&b); std::string line; std::getline(is, line); ... } } ... boost::asio::async_read_until(s, b, '\n', handler);
在 async_read_until
操作成功完成后,缓冲区 b
包含定界符:
{ 'a', 'b', ..., 'c', '\n', 'd', 'e', ... }
然后调用 std::getline
提取包括换行符在内的数据(换行符将被丢弃),因此字符串 line
包含:
{ 'a', 'b', ..., 'c' }
剩余数据如下留在缓冲区 b
中:
{ 'd', 'e', ... }
这些数据可能是新行的开头,供后续的 async_read_until
操作提取。
此异步操作支持以下 cancellation_type
值的取消
cancellation_type::terminal
cancellation_type::partial
如果 AsyncReadStream
类型的 async_read_some
操作也支持这些值。