boostorg/beast
1
0
Fork 1
mirror of https://github.com/boostorg/beast.git synced 2025-08-01 22:04:34 +02:00
Code Issues Packages Projects Releases Wiki Activity

Rename to buffered_read_stream (API Change):

Browse Source 
dynabuf_readstream is renamed to buffered_read_stream.
This commit is contained in:
Vinnie Falco
2017-05-04 19:38:59 -07:00
parent aa9f42cd06
commit fc0e356149
9 changed files with 43 additions and 42 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
CHANGELOG.md
View File

@@ -13,6 +13,7 @@ API Changes:
* Rename to multi_buffer, basic_multi_buffer * Rename to multi_buffer, basic_multi_buffer
* Rename to flat_buffer, basic_flat_buffer * Rename to flat_buffer, basic_flat_buffer
* Rename to static_buffer, static_buffer_n * Rename to static_buffer, static_buffer_n
* Rename to buffered_read_stream
-------------------------------------------------------------------------------- --------------------------------------------------------------------------------

2
doc/quickref.xml
View File

@@ -156,7 +156,7 @@
<member><link linkend="beast.ref.basic_multi_buffer">basic_multi_buffer</link></member> <member><link linkend="beast.ref.basic_multi_buffer">basic_multi_buffer</link></member>
<member><link linkend="beast.ref.buffers_adapter">buffers_adapter</link></member> <member><link linkend="beast.ref.buffers_adapter">buffers_adapter</link></member>
<member><link linkend="beast.ref.consuming_buffers">consuming_buffers</link></member> <member><link linkend="beast.ref.consuming_buffers">consuming_buffers</link></member>
<member><link linkend="beast.ref.dynabuf_readstream">dynabuf_readstream</link></member> <member><link linkend="beast.ref.buffered_read_stream">buffered_read_stream</link></member>
<member><link linkend="beast.ref.errc">errc</link></member> <member><link linkend="beast.ref.errc">errc</link></member>
<member><link linkend="beast.ref.error_category">error_category</link></member> <member><link linkend="beast.ref.error_category">error_category</link></member>
<member><link linkend="beast.ref.error_code">error_code</link></member> <member><link linkend="beast.ref.error_code">error_code</link></member>

2
include/beast/core.hpp
View File

@@ -16,7 +16,7 @@
#include <beast/core/buffer_concepts.hpp> #include <beast/core/buffer_concepts.hpp>
#include <beast/core/buffers_adapter.hpp> #include <beast/core/buffers_adapter.hpp>
#include <beast/core/consuming_buffers.hpp> #include <beast/core/consuming_buffers.hpp>
#include <beast/core/dynabuf_readstream.hpp> #include <beast/core/buffered_read_stream.hpp>
#include <beast/core/error.hpp> #include <beast/core/error.hpp>
#include <beast/core/flat_buffer.hpp> #include <beast/core/flat_buffer.hpp>
#include <beast/core/handler_alloc.hpp> #include <beast/core/handler_alloc.hpp>

22
include/beast/core/dynabuf_readstream.hpp → include/beast/core/buffered_read_stream.hpp
View File

@@ -5,8 +5,8 @@
// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
// //
#ifndef BEAST_DYNABUF_READSTREAM_HPP #ifndef BEAST_BUFFERED_READ_STREAM_HPP
#define BEAST_DYNABUF_READSTREAM_HPP #define BEAST_BUFFERED_READ_STREAM_HPP
#include <beast/config.hpp> #include <beast/config.hpp>
#include <beast/core/async_completion.hpp> #include <beast/core/async_completion.hpp>
@@ -22,9 +22,9 @@
namespace beast { namespace beast {
/** A @b `Stream` with attached @b `DynamicBuffer` to buffer reads. /** A @b Stream with attached @b DynamicBuffer to buffer reads.
This wraps a @b `Stream` implementation so that calls to write are This wraps a @b Stream implementation so that calls to write are
passed through to the underlying stream, while calls to read will passed through to the underlying stream, while calls to read will
first consume the input sequence stored in a @b `DynamicBuffer` which first consume the input sequence stored in a @b `DynamicBuffer` which
is part of the object. is part of the object.
@@ -52,7 +52,7 @@ namespace beast {
// //
template<class DynamicBuffer> template<class DynamicBuffer>
void process_http_message( void process_http_message(
dynabuf_readstream<DynamicBuffer>& stream) buffered_read_stream<DynamicBuffer>& stream)
{ {
// Read up to and including the end of the HTTP // Read up to and including the end of the HTTP
// header, leaving the sequence in the stream's // header, leaving the sequence in the stream's
@@ -88,7 +88,7 @@ namespace beast {
@tparam DynamicBuffer The type of stream buffer to use. @tparam DynamicBuffer The type of stream buffer to use.
*/ */
template<class Stream, class DynamicBuffer> template<class Stream, class DynamicBuffer>
class dynabuf_readstream class buffered_read_stream
{ {
static_assert(is_DynamicBuffer<DynamicBuffer>::value, static_assert(is_DynamicBuffer<DynamicBuffer>::value,
"DynamicBuffer requirements not met"); "DynamicBuffer requirements not met");
@@ -102,7 +102,7 @@ class dynabuf_readstream
public: public:
/// The type of the internal buffer /// The type of the internal buffer
using dynabuf_type = DynamicBuffer; using buffer_type = DynamicBuffer;
/// The type of the next layer. /// The type of the next layer.
using next_layer_type = using next_layer_type =
@@ -122,14 +122,14 @@ public:
@note The behavior of move assignment on or from streams @note The behavior of move assignment on or from streams
with active or pending operations is undefined. with active or pending operations is undefined.
*/ */
dynabuf_readstream(dynabuf_readstream&&) = default; buffered_read_stream(buffered_read_stream&&) = default;
/** Move assignment. /** Move assignment.
@note The behavior of move assignment on or from streams @note The behavior of move assignment on or from streams
with active or pending operations is undefined. with active or pending operations is undefined.
*/ */
dynabuf_readstream& operator=(dynabuf_readstream&&) = default; buffered_read_stream& operator=(buffered_read_stream&&) = default;
/** Construct the wrapping stream. /** Construct the wrapping stream.
@@ -137,7 +137,7 @@ public:
*/ */
template<class... Args> template<class... Args>
explicit explicit
dynabuf_readstream(Args&&... args); buffered_read_stream(Args&&... args);
/// Get a reference to the next layer. /// Get a reference to the next layer.
next_layer_type& next_layer_type&
@@ -358,6 +358,6 @@ public:
} // beast } // beast
#include <beast/core/impl/dynabuf_readstream.ipp> #include <beast/core/impl/buffered_read_stream.ipp>
#endif #endif

26
include/beast/core/impl/dynabuf_readstream.ipp → include/beast/core/impl/buffered_read_stream.ipp
View File

@@ -5,8 +5,8 @@
// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
// //
#ifndef BEAST_IMPL_DYNABUF_READSTREAM_HPP #ifndef BEAST_IMPL_BUFFERED_READ_STREAM_IPP
#define BEAST_IMPL_DYNABUF_READSTREAM_HPP #define BEAST_IMPL_BUFFERED_READ_STREAM_IPP
#include <beast/core/bind_handler.hpp> #include <beast/core/bind_handler.hpp>
#include <beast/core/error.hpp> #include <beast/core/error.hpp>
@@ -18,17 +18,17 @@ namespace beast {
template<class Stream, class DynamicBuffer> template<class Stream, class DynamicBuffer>
template<class MutableBufferSequence, class Handler> template<class MutableBufferSequence, class Handler>
class dynabuf_readstream< class buffered_read_stream<
Stream, DynamicBuffer>::read_some_op Stream, DynamicBuffer>::read_some_op
{ {
// VFALCO What about bool cont for is_continuation? // VFALCO What about bool cont for is_continuation?
struct data struct data
{ {
dynabuf_readstream& srs; buffered_read_stream& srs;
MutableBufferSequence bs; MutableBufferSequence bs;
int state = 0; int state = 0;
data(Handler&, dynabuf_readstream& srs_, data(Handler&, buffered_read_stream& srs_,
MutableBufferSequence const& bs_) MutableBufferSequence const& bs_)
: srs(srs_) : srs(srs_)
, bs(bs_) , bs(bs_)
@@ -44,7 +44,7 @@ public:
template<class DeducedHandler, class... Args> template<class DeducedHandler, class... Args>
read_some_op(DeducedHandler&& h, read_some_op(DeducedHandler&& h,
dynabuf_readstream& srs, Args&&... args) buffered_read_stream& srs, Args&&... args)
: d_(std::forward<DeducedHandler>(h), : d_(std::forward<DeducedHandler>(h),
srs, std::forward<Args>(args)...) srs, std::forward<Args>(args)...)
{ {
@@ -90,7 +90,7 @@ public:
template<class Stream, class DynamicBuffer> template<class Stream, class DynamicBuffer>
template<class MutableBufferSequence, class Handler> template<class MutableBufferSequence, class Handler>
void void
dynabuf_readstream<Stream, DynamicBuffer>:: buffered_read_stream<Stream, DynamicBuffer>::
read_some_op<MutableBufferSequence, Handler>::operator()( read_some_op<MutableBufferSequence, Handler>::operator()(
error_code const& ec, std::size_t bytes_transferred) error_code const& ec, std::size_t bytes_transferred)
{ {
@@ -150,8 +150,8 @@ read_some_op<MutableBufferSequence, Handler>::operator()(
template<class Stream, class DynamicBuffer> template<class Stream, class DynamicBuffer>
template<class... Args> template<class... Args>
dynabuf_readstream<Stream, DynamicBuffer>:: buffered_read_stream<Stream, DynamicBuffer>::
dynabuf_readstream(Args&&... args) buffered_read_stream(Args&&... args)
: next_layer_(std::forward<Args>(args)...) : next_layer_(std::forward<Args>(args)...)
{ {
} }
@@ -159,7 +159,7 @@ dynabuf_readstream(Args&&... args)
template<class Stream, class DynamicBuffer> template<class Stream, class DynamicBuffer>
template<class ConstBufferSequence, class WriteHandler> template<class ConstBufferSequence, class WriteHandler>
auto auto
dynabuf_readstream<Stream, DynamicBuffer>:: buffered_read_stream<Stream, DynamicBuffer>::
async_write_some(ConstBufferSequence const& buffers, async_write_some(ConstBufferSequence const& buffers,
WriteHandler&& handler) -> WriteHandler&& handler) ->
typename async_completion< typename async_completion<
@@ -180,7 +180,7 @@ async_write_some(ConstBufferSequence const& buffers,
template<class Stream, class DynamicBuffer> template<class Stream, class DynamicBuffer>
template<class MutableBufferSequence> template<class MutableBufferSequence>
std::size_t std::size_t
dynabuf_readstream<Stream, DynamicBuffer>:: buffered_read_stream<Stream, DynamicBuffer>::
read_some( read_some(
MutableBufferSequence const& buffers) MutableBufferSequence const& buffers)
{ {
@@ -199,7 +199,7 @@ read_some(
template<class Stream, class DynamicBuffer> template<class Stream, class DynamicBuffer>
template<class MutableBufferSequence> template<class MutableBufferSequence>
std::size_t std::size_t
dynabuf_readstream<Stream, DynamicBuffer>:: buffered_read_stream<Stream, DynamicBuffer>::
read_some(MutableBufferSequence const& buffers, read_some(MutableBufferSequence const& buffers,
error_code& ec) error_code& ec)
{ {
@@ -228,7 +228,7 @@ read_some(MutableBufferSequence const& buffers,
template<class Stream, class DynamicBuffer> template<class Stream, class DynamicBuffer>
template<class MutableBufferSequence, class ReadHandler> template<class MutableBufferSequence, class ReadHandler>
auto auto
dynabuf_readstream<Stream, DynamicBuffer>:: buffered_read_stream<Stream, DynamicBuffer>::
async_read_some( async_read_some(
MutableBufferSequence const& buffers, MutableBufferSequence const& buffers,
ReadHandler&& handler) -> ReadHandler&& handler) ->

4
include/beast/websocket/stream.hpp
View File

@@ -15,7 +15,7 @@
#include <beast/http/message.hpp> #include <beast/http/message.hpp>
#include <beast/http/string_body.hpp> #include <beast/http/string_body.hpp>
#include <beast/core/async_completion.hpp> #include <beast/core/async_completion.hpp>
#include <beast/core/dynabuf_readstream.hpp> #include <beast/core/buffered_read_stream.hpp>
#include <beast/core/detail/get_lowest_layer.hpp> #include <beast/core/detail/get_lowest_layer.hpp>
#include <boost/asio.hpp> #include <boost/asio.hpp>
#include <boost/utility/string_ref.hpp> #include <boost/utility/string_ref.hpp>
@@ -98,7 +98,7 @@ class stream : public detail::stream_base
{ {
friend class stream_test; friend class stream_test;
dynabuf_readstream<NextLayer, multi_buffer> stream_; buffered_read_stream<NextLayer, multi_buffer> stream_;
public: public:
/// The type of the next layer. /// The type of the next layer.

2
test/Jamfile
View File

@@ -20,10 +20,10 @@ unit-test core-tests :
core/bind_handler.cpp core/bind_handler.cpp
core/buffer_cat.cpp core/buffer_cat.cpp
core/buffer_concepts.cpp core/buffer_concepts.cpp
core/buffered_read_stream.cpp
core/buffers_adapter.cpp core/buffers_adapter.cpp
core/clamp.cpp core/clamp.cpp
core/consuming_buffers.cpp core/consuming_buffers.cpp
core/dynabuf_readstream.cpp
core/error.cpp core/error.cpp
core/flat_buffer.cpp core/flat_buffer.cpp
core/handler_alloc.cpp core/handler_alloc.cpp

2
test/core/CMakeLists.txt
View File

@@ -16,7 +16,7 @@ add_executable (core-tests
buffers_adapter.cpp buffers_adapter.cpp
clamp.cpp clamp.cpp
consuming_buffers.cpp consuming_buffers.cpp
dynabuf_readstream.cpp buffered_read_stream.cpp
error.cpp error.cpp
flat_buffer.cpp flat_buffer.cpp
handler_alloc.cpp handler_alloc.cpp

24
test/core/dynabuf_readstream.cpp → test/core/buffered_read_stream.cpp
View File

@@ -6,7 +6,7 @@
// //
// Test that header file is self-contained. // Test that header file is self-contained.
#include <beast/core/dynabuf_readstream.hpp> #include <beast/core/buffered_read_stream.hpp>
#include <beast/core/multi_buffer.hpp> #include <beast/core/multi_buffer.hpp>
#include <beast/test/fail_stream.hpp> #include <beast/test/fail_stream.hpp>
@@ -17,11 +17,11 @@
namespace beast { namespace beast {
class dynabuf_readstream_test class buffered_read_stream_test
: public unit_test::suite : public unit_test::suite
, public test::enable_yield_to , public test::enable_yield_to
{ {
using self = dynabuf_readstream_test; using self = buffered_read_stream_test;
public: public:
void testSpecialMembers() void testSpecialMembers()
@@ -29,16 +29,16 @@ public:
using socket_type = boost::asio::ip::tcp::socket; using socket_type = boost::asio::ip::tcp::socket;
boost::asio::io_service ios; boost::asio::io_service ios;
{ {
dynabuf_readstream<socket_type, multi_buffer> srs(ios); buffered_read_stream<socket_type, multi_buffer> srs(ios);
dynabuf_readstream<socket_type, multi_buffer> srs2(std::move(srs)); buffered_read_stream<socket_type, multi_buffer> srs2(std::move(srs));
srs = std::move(srs2); srs = std::move(srs2);
BEAST_EXPECT(&srs.get_io_service() == &ios); BEAST_EXPECT(&srs.get_io_service() == &ios);
BEAST_EXPECT(&srs.get_io_service() == &srs2.get_io_service()); BEAST_EXPECT(&srs.get_io_service() == &srs2.get_io_service());
} }
{ {
socket_type sock(ios); socket_type sock(ios);
dynabuf_readstream<socket_type&, multi_buffer> srs(sock); buffered_read_stream<socket_type&, multi_buffer> srs(sock);
dynabuf_readstream<socket_type&, multi_buffer> srs2(std::move(srs)); buffered_read_stream<socket_type&, multi_buffer> srs2(std::move(srs));
} }
} }
@@ -55,7 +55,7 @@ public:
{ {
test::fail_stream< test::fail_stream<
test::string_istream> fs(n, ios_, ", world!"); test::string_istream> fs(n, ios_, ", world!");
dynabuf_readstream< buffered_read_stream<
decltype(fs)&, multi_buffer> srs(fs); decltype(fs)&, multi_buffer> srs(fs);
srs.buffer().commit(buffer_copy( srs.buffer().commit(buffer_copy(
srs.buffer().prepare(5), buffer("Hello", 5))); srs.buffer().prepare(5), buffer("Hello", 5)));
@@ -73,7 +73,7 @@ public:
{ {
test::fail_stream< test::fail_stream<
test::string_istream> fs(n, ios_, ", world!"); test::string_istream> fs(n, ios_, ", world!");
dynabuf_readstream< buffered_read_stream<
decltype(fs)&, multi_buffer> srs(fs); decltype(fs)&, multi_buffer> srs(fs);
srs.capacity(3); srs.capacity(3);
srs.buffer().commit(buffer_copy( srs.buffer().commit(buffer_copy(
@@ -92,7 +92,7 @@ public:
{ {
test::fail_stream< test::fail_stream<
test::string_istream> fs(n, ios_, ", world!"); test::string_istream> fs(n, ios_, ", world!");
dynabuf_readstream< buffered_read_stream<
decltype(fs)&, multi_buffer> srs(fs); decltype(fs)&, multi_buffer> srs(fs);
srs.buffer().commit(buffer_copy( srs.buffer().commit(buffer_copy(
srs.buffer().prepare(5), buffer("Hello", 5))); srs.buffer().prepare(5), buffer("Hello", 5)));
@@ -111,7 +111,7 @@ public:
{ {
test::fail_stream< test::fail_stream<
test::string_istream> fs(n, ios_, ", world!"); test::string_istream> fs(n, ios_, ", world!");
dynabuf_readstream< buffered_read_stream<
decltype(fs)&, multi_buffer> srs(fs); decltype(fs)&, multi_buffer> srs(fs);
srs.capacity(3); srs.capacity(3);
srs.buffer().commit(buffer_copy( srs.buffer().commit(buffer_copy(
@@ -136,7 +136,7 @@ public:
} }
}; };
BEAST_DEFINE_TESTSUITE(dynabuf_readstream,core,beast); BEAST_DEFINE_TESTSUITE(buffered_read_stream,core,beast);
} // beast } // beast