// // Copyright (c) 2016-2017 Vinnie Falco (vinnie dot falco at gmail dot com) // // Distributed under the Boost Software License, Version 1.0. (See accompanying // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) // // Official repository: https://github.com/boostorg/beast // #ifndef BOOST_BEAST_WEBSOCKET_IMPL_PING_HPP #define BOOST_BEAST_WEBSOCKET_IMPL_PING_HPP #include #include #include #include #include #include #include #include #include namespace boost { namespace beast { namespace websocket { /* This composed operation handles sending ping and pong frames. It only sends the frames it does not make attempts to read any frame data. */ template template class stream::ping_op : public beast::stable_async_op_base< Handler, beast::executor_type> , public net::coroutine { stream& ws_; detail::frame_buffer& fb_; public: static constexpr int id = 3; // for soft_mutex template ping_op( Handler_&& h, stream& ws, detail::opcode op, ping_data const& payload) : stable_async_op_base< Handler, beast::executor_type>( std::forward(h), ws.get_executor()) , ws_(ws) , fb_(beast::allocate_stable< detail::frame_buffer>(*this)) { // Serialize the ping or pong frame ws.template write_ping< flat_static_buffer_base>(fb_, op, payload); (*this)({}, 0, false); } void operator()( error_code ec = {}, std::size_t bytes_transferred = 0, bool cont = true) { boost::ignore_unused(bytes_transferred); auto& impl = *ws_.impl_; BOOST_ASIO_CORO_REENTER(*this) { // Acquire the write lock if(! impl.wr_block.try_lock(this)) { BOOST_ASIO_CORO_YIELD impl.paused_ping.emplace(std::move(*this)); impl.wr_block.lock(this); BOOST_ASIO_CORO_YIELD net::post(std::move(*this)); BOOST_ASSERT(impl.wr_block.is_locked(this)); } if(impl.check_stop_now(ec)) goto upcall; // Send ping frame BOOST_ASIO_CORO_YIELD net::async_write(impl.stream, fb_.data(), beast::detail::bind_continuation(std::move(*this))); if(impl.check_stop_now(ec)) goto upcall; upcall: impl.wr_block.unlock(this); impl.paused_close.maybe_invoke() || impl.paused_rd.maybe_invoke() || impl.paused_wr.maybe_invoke(); this->invoke(cont, ec); } } }; //------------------------------------------------------------------------------ template void stream:: ping(ping_data const& payload) { error_code ec; ping(payload, ec); if(ec) BOOST_THROW_EXCEPTION(system_error{ec}); } template void stream:: ping(ping_data const& payload, error_code& ec) { if(impl_->check_stop_now(ec)) return; detail::frame_buffer fb; write_ping( fb, detail::opcode::ping, payload); net::write(impl_->stream, fb.data(), ec); if(impl_->check_stop_now(ec)) return; } template void stream:: pong(ping_data const& payload) { error_code ec; pong(payload, ec); if(ec) BOOST_THROW_EXCEPTION(system_error{ec}); } template void stream:: pong(ping_data const& payload, error_code& ec) { if(impl_->check_stop_now(ec)) return; detail::frame_buffer fb; write_ping( fb, detail::opcode::pong, payload); net::write(impl_->stream, fb.data(), ec); if(impl_->check_stop_now(ec)) return; } template template BOOST_ASIO_INITFN_RESULT_TYPE( WriteHandler, void(error_code)) stream:: async_ping(ping_data const& payload, WriteHandler&& handler) { static_assert(is_async_stream::value, "AsyncStream requirements not met"); BOOST_BEAST_HANDLER_INIT( WriteHandler, void(error_code)); ping_op( std::move(init.completion_handler), *this, detail::opcode::ping, payload); return init.result.get(); } template template BOOST_ASIO_INITFN_RESULT_TYPE( WriteHandler, void(error_code)) stream:: async_pong(ping_data const& payload, WriteHandler&& handler) { static_assert(is_async_stream::value, "AsyncStream requirements not met"); BOOST_BEAST_HANDLER_INIT( WriteHandler, void(error_code)); ping_op( std::move(init.completion_handler), *this, detail::opcode::pong, payload); return init.result.get(); } } // websocket } // beast } // boost #endif