mirror of
https://github.com/boostorg/beast.git
synced 2025-07-31 13:27:33 +02:00
Refactor ping_op
This commit is contained in:
@ -8,6 +8,7 @@ WebSocket:
|
|||||||
* websocket test improvements
|
* websocket test improvements
|
||||||
* Remove obsolete write_op
|
* Remove obsolete write_op
|
||||||
* Refactor write_op
|
* Refactor write_op
|
||||||
|
* Refactor ping_op
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
--------------------------------------------------------------------------------
|
||||||
|
|
||||||
|
@ -11,6 +11,7 @@
|
|||||||
#define BOOST_BEAST_WEBSOCKET_DETAIL_PAUSATION_HPP
|
#define BOOST_BEAST_WEBSOCKET_DETAIL_PAUSATION_HPP
|
||||||
|
|
||||||
#include <boost/beast/core/handler_ptr.hpp>
|
#include <boost/beast/core/handler_ptr.hpp>
|
||||||
|
#include <boost/asio/coroutine.hpp>
|
||||||
#include <boost/assert.hpp>
|
#include <boost/assert.hpp>
|
||||||
#include <array>
|
#include <array>
|
||||||
#include <memory>
|
#include <memory>
|
||||||
@ -68,7 +69,7 @@ class pausation
|
|||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
struct exemplar
|
struct exemplar : boost::asio::coroutine
|
||||||
{
|
{
|
||||||
struct H
|
struct H
|
||||||
{
|
{
|
||||||
|
@ -15,6 +15,7 @@
|
|||||||
#include <boost/beast/core/type_traits.hpp>
|
#include <boost/beast/core/type_traits.hpp>
|
||||||
#include <boost/beast/core/detail/config.hpp>
|
#include <boost/beast/core/detail/config.hpp>
|
||||||
#include <boost/beast/websocket/detail/frame.hpp>
|
#include <boost/beast/websocket/detail/frame.hpp>
|
||||||
|
#include <boost/asio/coroutine.hpp>
|
||||||
#include <boost/asio/handler_alloc_hook.hpp>
|
#include <boost/asio/handler_alloc_hook.hpp>
|
||||||
#include <boost/asio/handler_continuation_hook.hpp>
|
#include <boost/asio/handler_continuation_hook.hpp>
|
||||||
#include <boost/asio/handler_invoke_hook.hpp>
|
#include <boost/asio/handler_invoke_hook.hpp>
|
||||||
@ -25,53 +26,56 @@ namespace boost {
|
|||||||
namespace beast {
|
namespace beast {
|
||||||
namespace websocket {
|
namespace websocket {
|
||||||
|
|
||||||
//------------------------------------------------------------------------------
|
/*
|
||||||
|
This composed operation handles sending ping and pong frames.
|
||||||
// write a ping frame
|
It only sends the frames it does not make attempts to read
|
||||||
//
|
any frame data.
|
||||||
|
*/
|
||||||
template<class NextLayer>
|
template<class NextLayer>
|
||||||
template<class Handler>
|
template<class Handler>
|
||||||
class stream<NextLayer>::ping_op
|
class stream<NextLayer>::ping_op
|
||||||
|
: public boost::asio::coroutine
|
||||||
{
|
{
|
||||||
struct data : op
|
struct state
|
||||||
{
|
{
|
||||||
stream<NextLayer>& ws;
|
stream<NextLayer>& ws;
|
||||||
detail::frame_streambuf fb;
|
detail::frame_streambuf fb;
|
||||||
int state = 0;
|
|
||||||
token tok;
|
token tok;
|
||||||
|
|
||||||
data(Handler&, stream<NextLayer>& ws_,
|
state(
|
||||||
detail::opcode op_, ping_data const& payload)
|
Handler&,
|
||||||
|
stream<NextLayer>& ws_,
|
||||||
|
detail::opcode op,
|
||||||
|
ping_data const& payload)
|
||||||
: ws(ws_)
|
: ws(ws_)
|
||||||
, tok(ws.t_.unique())
|
, tok(ws.t_.unique())
|
||||||
{
|
{
|
||||||
using boost::asio::buffer;
|
// Serialize the control frame
|
||||||
using boost::asio::buffer_copy;
|
|
||||||
ws.template write_ping<
|
ws.template write_ping<
|
||||||
flat_static_buffer_base>(fb, op_, payload);
|
flat_static_buffer_base>(
|
||||||
|
fb, op, payload);
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
handler_ptr<data, Handler> d_;
|
handler_ptr<state, Handler> d_;
|
||||||
|
|
||||||
public:
|
public:
|
||||||
ping_op(ping_op&&) = default;
|
ping_op(ping_op&&) = default;
|
||||||
ping_op(ping_op const&) = default;
|
ping_op(ping_op const&) = default;
|
||||||
|
|
||||||
template<class DeducedHandler, class... Args>
|
template<class DeducedHandler>
|
||||||
ping_op(DeducedHandler&& h,
|
ping_op(
|
||||||
stream<NextLayer>& ws, Args&&... args)
|
DeducedHandler&& h,
|
||||||
|
stream<NextLayer>& ws,
|
||||||
|
detail::opcode op,
|
||||||
|
ping_data const& payload)
|
||||||
: d_(std::forward<DeducedHandler>(h),
|
: d_(std::forward<DeducedHandler>(h),
|
||||||
ws, std::forward<Args>(args)...)
|
ws, op, payload)
|
||||||
{
|
{
|
||||||
}
|
}
|
||||||
|
|
||||||
void operator()()
|
void operator()(
|
||||||
{
|
error_code ec = {},
|
||||||
(*this)({});
|
|
||||||
}
|
|
||||||
|
|
||||||
void operator()(error_code ec,
|
|
||||||
std::size_t bytes_transferred = 0);
|
std::size_t bytes_transferred = 0);
|
||||||
|
|
||||||
friend
|
friend
|
||||||
@ -118,109 +122,66 @@ ping_op<Handler>::
|
|||||||
operator()(error_code ec, std::size_t)
|
operator()(error_code ec, std::size_t)
|
||||||
{
|
{
|
||||||
auto& d = *d_;
|
auto& d = *d_;
|
||||||
if(ec)
|
BOOST_ASIO_CORO_REENTER(*this)
|
||||||
{
|
{
|
||||||
BOOST_ASSERT(d.ws.wr_block_ == d.tok);
|
// Maybe suspend
|
||||||
d.ws.failed_ = true;
|
if(! d.ws.wr_block_)
|
||||||
goto upcall;
|
|
||||||
}
|
|
||||||
switch(d.state)
|
|
||||||
{
|
|
||||||
case 0:
|
|
||||||
if(d.ws.wr_block_)
|
|
||||||
{
|
{
|
||||||
// suspend
|
// Acquire the write block
|
||||||
d.state = 1;
|
d.ws.wr_block_ = d.tok;
|
||||||
d.ws.ping_op_.emplace(std::move(*this));
|
|
||||||
return;
|
// Make sure the stream is open
|
||||||
|
if(d.ws.failed_)
|
||||||
|
{
|
||||||
|
BOOST_ASIO_CORO_YIELD
|
||||||
|
d.ws.get_io_service().post(
|
||||||
|
bind_handler(std::move(*this),
|
||||||
|
boost::asio::error::operation_aborted));
|
||||||
|
goto upcall;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
d.ws.wr_block_ = d.tok;
|
else
|
||||||
if(d.ws.failed_ || d.ws.wr_close_)
|
|
||||||
{
|
{
|
||||||
// call handler
|
// Suspend
|
||||||
return d.ws.get_io_service().post(
|
BOOST_ASSERT(d.ws.wr_block_ != d.tok);
|
||||||
bind_handler(std::move(*this),
|
BOOST_ASIO_CORO_YIELD
|
||||||
boost::asio::error::operation_aborted));
|
d.ws.ping_op_.emplace(std::move(*this));
|
||||||
|
|
||||||
|
// Acquire the write block
|
||||||
|
BOOST_ASSERT(! d.ws.wr_block_);
|
||||||
|
d.ws.wr_block_ = d.tok;
|
||||||
|
|
||||||
|
// Resume
|
||||||
|
BOOST_ASIO_CORO_YIELD
|
||||||
|
d.ws.get_io_service().post(std::move(*this));
|
||||||
|
BOOST_ASSERT(d.ws.wr_block_ == d.tok);
|
||||||
|
|
||||||
|
// Make sure the stream is open
|
||||||
|
if(d.ws.failed_)
|
||||||
|
{
|
||||||
|
ec = boost::asio::error::operation_aborted;
|
||||||
|
goto upcall;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
do_write:
|
// Send ping frame
|
||||||
// send ping frame
|
BOOST_ASIO_CORO_YIELD
|
||||||
BOOST_ASSERT(d.ws.wr_block_ == d.tok);
|
|
||||||
d.state = 3;
|
|
||||||
boost::asio::async_write(d.ws.stream_,
|
boost::asio::async_write(d.ws.stream_,
|
||||||
d.fb.data(), std::move(*this));
|
d.fb.data(), std::move(*this));
|
||||||
return;
|
if(ec)
|
||||||
|
d.ws.failed_ = true;
|
||||||
|
|
||||||
case 1:
|
upcall:
|
||||||
BOOST_ASSERT(! d.ws.wr_block_);
|
|
||||||
d.ws.wr_block_ = d.tok;
|
|
||||||
d.state = 2;
|
|
||||||
// The current context is safe but might not be
|
|
||||||
// the same as the one for this operation (since
|
|
||||||
// we are being called from a write operation).
|
|
||||||
// Call post to make sure we are invoked the same
|
|
||||||
// way as the final handler for this operation.
|
|
||||||
d.ws.get_io_service().post(
|
|
||||||
bind_handler(std::move(*this), ec));
|
|
||||||
return;
|
|
||||||
|
|
||||||
case 2:
|
|
||||||
BOOST_ASSERT(d.ws.wr_block_ == d.tok);
|
BOOST_ASSERT(d.ws.wr_block_ == d.tok);
|
||||||
if(d.ws.failed_ || d.ws.wr_close_)
|
d.ws.wr_block_.reset();
|
||||||
{
|
d.ws.close_op_.maybe_invoke() ||
|
||||||
// call handler
|
d.ws.rd_op_.maybe_invoke() ||
|
||||||
ec = boost::asio::error::operation_aborted;
|
d.ws.wr_op_.maybe_invoke();
|
||||||
goto upcall;
|
d_.invoke(ec);
|
||||||
}
|
|
||||||
goto do_write;
|
|
||||||
|
|
||||||
case 3:
|
|
||||||
break;
|
|
||||||
}
|
}
|
||||||
upcall:
|
|
||||||
BOOST_ASSERT(d.ws.wr_block_ == d.tok);
|
|
||||||
d.ws.wr_block_.reset();
|
|
||||||
d.ws.close_op_.maybe_invoke() ||
|
|
||||||
d.ws.rd_op_.maybe_invoke() ||
|
|
||||||
d.ws.wr_op_.maybe_invoke();
|
|
||||||
d_.invoke(ec);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
template<class NextLayer>
|
//------------------------------------------------------------------------------
|
||||||
template<class WriteHandler>
|
|
||||||
async_return_type<
|
|
||||||
WriteHandler, void(error_code)>
|
|
||||||
stream<NextLayer>::
|
|
||||||
async_ping(ping_data const& payload, WriteHandler&& handler)
|
|
||||||
{
|
|
||||||
static_assert(is_async_stream<next_layer_type>::value,
|
|
||||||
"AsyncStream requirements requirements not met");
|
|
||||||
async_completion<WriteHandler,
|
|
||||||
void(error_code)> init{handler};
|
|
||||||
ping_op<handler_type<
|
|
||||||
WriteHandler, void(error_code)>>{
|
|
||||||
init.completion_handler, *this,
|
|
||||||
detail::opcode::ping, payload}({});
|
|
||||||
return init.result.get();
|
|
||||||
}
|
|
||||||
|
|
||||||
template<class NextLayer>
|
|
||||||
template<class WriteHandler>
|
|
||||||
async_return_type<
|
|
||||||
WriteHandler, void(error_code)>
|
|
||||||
stream<NextLayer>::
|
|
||||||
async_pong(ping_data const& payload, WriteHandler&& handler)
|
|
||||||
{
|
|
||||||
static_assert(is_async_stream<next_layer_type>::value,
|
|
||||||
"AsyncStream requirements requirements not met");
|
|
||||||
async_completion<WriteHandler,
|
|
||||||
void(error_code)> init{handler};
|
|
||||||
ping_op<handler_type<
|
|
||||||
WriteHandler, void(error_code)>>{
|
|
||||||
init.completion_handler, *this,
|
|
||||||
detail::opcode::pong, payload}({});
|
|
||||||
return init.result.get();
|
|
||||||
}
|
|
||||||
|
|
||||||
template<class NextLayer>
|
template<class NextLayer>
|
||||||
void
|
void
|
||||||
@ -238,10 +199,16 @@ void
|
|||||||
stream<NextLayer>::
|
stream<NextLayer>::
|
||||||
ping(ping_data const& payload, error_code& ec)
|
ping(ping_data const& payload, error_code& ec)
|
||||||
{
|
{
|
||||||
detail::frame_streambuf db;
|
// Make sure the stream is open
|
||||||
|
if(failed_)
|
||||||
|
{
|
||||||
|
ec = boost::asio::error::operation_aborted;
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
detail::frame_streambuf fb;
|
||||||
write_ping<flat_static_buffer_base>(
|
write_ping<flat_static_buffer_base>(
|
||||||
db, detail::opcode::ping, payload);
|
fb, detail::opcode::ping, payload);
|
||||||
boost::asio::write(stream_, db.data(), ec);
|
boost::asio::write(stream_, fb.data(), ec);
|
||||||
}
|
}
|
||||||
|
|
||||||
template<class NextLayer>
|
template<class NextLayer>
|
||||||
@ -260,13 +227,53 @@ void
|
|||||||
stream<NextLayer>::
|
stream<NextLayer>::
|
||||||
pong(ping_data const& payload, error_code& ec)
|
pong(ping_data const& payload, error_code& ec)
|
||||||
{
|
{
|
||||||
detail::frame_streambuf db;
|
// Make sure the stream is open
|
||||||
|
if(failed_)
|
||||||
|
{
|
||||||
|
ec = boost::asio::error::operation_aborted;
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
detail::frame_streambuf fb;
|
||||||
write_ping<flat_static_buffer_base>(
|
write_ping<flat_static_buffer_base>(
|
||||||
db, detail::opcode::pong, payload);
|
fb, detail::opcode::pong, payload);
|
||||||
boost::asio::write(stream_, db.data(), ec);
|
boost::asio::write(stream_, fb.data(), ec);
|
||||||
}
|
}
|
||||||
|
|
||||||
//------------------------------------------------------------------------------
|
template<class NextLayer>
|
||||||
|
template<class WriteHandler>
|
||||||
|
async_return_type<
|
||||||
|
WriteHandler, void(error_code)>
|
||||||
|
stream<NextLayer>::
|
||||||
|
async_ping(ping_data const& payload, WriteHandler&& handler)
|
||||||
|
{
|
||||||
|
static_assert(is_async_stream<next_layer_type>::value,
|
||||||
|
"AsyncStream requirements requirements not met");
|
||||||
|
async_completion<WriteHandler,
|
||||||
|
void(error_code)> init{handler};
|
||||||
|
ping_op<handler_type<
|
||||||
|
WriteHandler, void(error_code)>>{
|
||||||
|
init.completion_handler, *this,
|
||||||
|
detail::opcode::ping, payload}();
|
||||||
|
return init.result.get();
|
||||||
|
}
|
||||||
|
|
||||||
|
template<class NextLayer>
|
||||||
|
template<class WriteHandler>
|
||||||
|
async_return_type<
|
||||||
|
WriteHandler, void(error_code)>
|
||||||
|
stream<NextLayer>::
|
||||||
|
async_pong(ping_data const& payload, WriteHandler&& handler)
|
||||||
|
{
|
||||||
|
static_assert(is_async_stream<next_layer_type>::value,
|
||||||
|
"AsyncStream requirements requirements not met");
|
||||||
|
async_completion<WriteHandler,
|
||||||
|
void(error_code)> init{handler};
|
||||||
|
ping_op<handler_type<
|
||||||
|
WriteHandler, void(error_code)>>{
|
||||||
|
init.completion_handler, *this,
|
||||||
|
detail::opcode::pong, payload}();
|
||||||
|
return init.result.get();
|
||||||
|
}
|
||||||
|
|
||||||
} // websocket
|
} // websocket
|
||||||
} // beast
|
} // beast
|
||||||
|
@ -522,8 +522,8 @@ operator()(error_code ec,
|
|||||||
//--------------------------------------------------------------------------
|
//--------------------------------------------------------------------------
|
||||||
|
|
||||||
upcall:
|
upcall:
|
||||||
if(ws_.wr_block_ == tok_)
|
BOOST_ASSERT(ws_.wr_block_ == tok_);
|
||||||
ws_.wr_block_.reset();
|
ws_.wr_block_.reset();
|
||||||
ws_.close_op_.maybe_invoke() ||
|
ws_.close_op_.maybe_invoke() ||
|
||||||
ws_.rd_op_.maybe_invoke() ||
|
ws_.rd_op_.maybe_invoke() ||
|
||||||
ws_.ping_op_.maybe_invoke();
|
ws_.ping_op_.maybe_invoke();
|
||||||
|
@ -154,7 +154,7 @@ class stream
|
|||||||
detail::prepared_key key; // current stateful mask key
|
detail::prepared_key key; // current stateful mask key
|
||||||
std::uint64_t size; // total size of current message so far
|
std::uint64_t size; // total size of current message so far
|
||||||
std::uint64_t remain; // message frame bytes left in current frame
|
std::uint64_t remain; // message frame bytes left in current frame
|
||||||
detail::frame_streambuf fb; // to write control frames
|
detail::frame_streambuf fb; // to write control frames (during reads)
|
||||||
detail::utf8_checker utf8; // to validate utf8
|
detail::utf8_checker utf8; // to validate utf8
|
||||||
|
|
||||||
// A small, circular buffer to read frame headers.
|
// A small, circular buffer to read frame headers.
|
||||||
|
Reference in New Issue
Block a user