#include <PlainWSPeer.h>

Inheritance diagram for xrpl::PlainWSPeer< Handler >:

[legend]

Collaboration diagram for xrpl::PlainWSPeer< Handler >:

[legend]

Public Member Functions
template<class Body, class Headers>
	PlainWSPeer (Port const &port, Handler &handler, EndpointType remoteAddress, boost::beast::http::request< Body, Headers > &&request, SocketType &&socket, beast::Journal journal)
void	run () override
Port const &	port () const override
HttpRequestType const &	request () const override
boost::asio::ip::tcp::endpoint const &	remoteEndpoint () const override
void	send (std::shared_ptr< WSMsg > w) override
	Send a WebSockets message.
void	close () override
virtual void	close (boost::beast::websocket::close_reason const &reason)=0
void	complete () override
	Indicate that the response is complete.
IOList &	ios ()
	Return the IOList associated with the work.
T	shared_from_this (T... args)
T	weak_from_this (T... args)

Public Attributes
std::shared_ptr< void >	appDefined

Protected Member Functions
PlainWSPeer< Handler > &	impl ()
void	onWsHandshake (ErrorCode const &ec)
void	doWrite ()
void	onWrite (ErrorCode const &ec)
void	onWriteFin (ErrorCode const &ec)
void	doRead ()
void	onRead (ErrorCode const &ec)
void	onClose (ErrorCode const &ec)
void	startTimer ()
void	cancelTimer ()
void	onPing (ErrorCode const &ec)
void	onPingPong (boost::beast::websocket::frame_type kind, std::string_view payload)
void	onTimer (ErrorCode ec)
void	fail (ErrorCode ec, String const &what)

Protected Attributes
Port const &	port_
Handler &	handler_
EndpointType	remoteAddress_
beast::WrappedSink	sink_
beast::Journal const	j_
boost::asio::executor_work_guard< boost::asio::executor >	work_
boost::asio::strand< boost::asio::executor >	strand_

Private Types
using	ClockType = std::chrono::system_clock
using	ErrorCode = boost::system::error_code
using	EndpointType = boost::asio::ip::tcp::endpoint
using	WaitableTimer = boost::asio::basic_waitable_timer<ClockType>
using	SocketType = boost::beast::tcp_stream

Private Member Functions
void	destroy ()

Private Attributes
boost::beast::websocket::stream< SocketType >	ws_
HttpRequestType	request_
boost::beast::multi_buffer	rb_
boost::beast::multi_buffer	wb_
std::list< std::shared_ptr< WSMsg > >	wq_
bool	doClose_
	The socket has been closed, or will close after the next write finishes.
boost::beast::websocket::close_reason	cr_
WaitableTimer	timer_
bool	closeOnTimer_
bool	pingActive_
boost::beast::websocket::ping_data	payload_
ErrorCode	ec_
std::function< void(boost::beast::websocket::frame_type, std::string_view)>	controlCallback_
IOList *	ios_

Friends
class	BasePeer< Handler, PlainWSPeer >
class	BaseWSPeer< Handler, PlainWSPeer >

Detailed Description

template<class Handler>
class xrpl::PlainWSPeer< Handler >

Definition at line 16 of file PlainWSPeer.h.

Member Typedef Documentation

◆ ClockType

template<class Handler>

using xrpl::PlainWSPeer< Handler >::ClockType = std::chrono::system_clock

private

Definition at line 22 of file PlainWSPeer.h.

◆ ErrorCode

template<class Handler>

using xrpl::PlainWSPeer< Handler >::ErrorCode = boost::system::error_code

private

Definition at line 23 of file PlainWSPeer.h.

◆ EndpointType

template<class Handler>

using xrpl::PlainWSPeer< Handler >::EndpointType = boost::asio::ip::tcp::endpoint

private

Definition at line 24 of file PlainWSPeer.h.

◆ WaitableTimer

template<class Handler>

using xrpl::PlainWSPeer< Handler >::WaitableTimer = boost::asio::basic_waitable_timer<ClockType>

private

Definition at line 25 of file PlainWSPeer.h.

◆ SocketType

template<class Handler>

using xrpl::PlainWSPeer< Handler >::SocketType = boost::beast::tcp_stream

private

Definition at line 26 of file PlainWSPeer.h.

Constructor & Destructor Documentation

◆ PlainWSPeer()

template<class Handler>

template<class Body, class Headers>

xrpl::PlainWSPeer< Handler >::PlainWSPeer	(	Port const &	port,
		Handler &	handler,
		EndpointType	remoteAddress,
		boost::beast::http::request< Body, Headers > &&	request,
		SocketType &&	socket,
		beast::Journal	journal )

Definition at line 45 of file PlainWSPeer.h.

Member Function Documentation

◆ run()

void xrpl::BaseWSPeer< Handler, PlainWSPeer< Handler > >::run ( )

overridevirtualinherited

Implements xrpl::WSSession.

Definition at line 80 of file BaseWSPeer.h.

◆ port()

Port const & xrpl::BaseWSPeer< Handler, PlainWSPeer< Handler > >::port ( ) const

nodiscardoverridevirtualinherited

Implements xrpl::WSSession.

Definition at line 87 of file BaseWSPeer.h.

◆ request()

HttpRequestType const & xrpl::BaseWSPeer< Handler, PlainWSPeer< Handler > >::request ( ) const

nodiscardoverridevirtualinherited

Implements xrpl::WSSession.

Definition at line 93 of file BaseWSPeer.h.

◆ remoteEndpoint()

boost::asio::ip::tcp::endpoint const & xrpl::BaseWSPeer< Handler, PlainWSPeer< Handler > >::remoteEndpoint ( ) const

nodiscardoverridevirtualinherited

Implements xrpl::WSSession.

Definition at line 99 of file BaseWSPeer.h.

◆ send()

void xrpl::BaseWSPeer< Handler, PlainWSPeer< Handler > >::send ( std::shared_ptr< WSMsg > w )

overridevirtualinherited

Send a WebSockets message.

Implements xrpl::WSSession.

Definition at line 105 of file BaseWSPeer.h.

◆ close() [1/2]

void xrpl::BaseWSPeer< Handler, PlainWSPeer< Handler > >::close ( )

overridevirtualinherited

Reimplemented from xrpl::BasePeer< Handler, PlainWSPeer< Handler > >.

Definition at line 108 of file BaseWSPeer.h.

◆ close() [2/2]

virtual void xrpl::WSSession::close ( boost::beast::websocket::close_reason const & reason )

pure virtualinherited

Implemented in xrpl::BaseWSPeer< Handler, Impl >.

◆ complete()

void xrpl::BaseWSPeer< Handler, PlainWSPeer< Handler > >::complete ( )

overridevirtualinherited

Indicate that the response is complete.

The handler should call this when it has completed writing the response.

Implements xrpl::WSSession.

Definition at line 114 of file BaseWSPeer.h.

◆ impl()

PlainWSPeer< Handler > & xrpl::BaseWSPeer< Handler, PlainWSPeer< Handler > >::impl ( )

protectedinherited

Definition at line 118 of file BaseWSPeer.h.

◆ onWsHandshake()

void xrpl::BaseWSPeer< Handler, PlainWSPeer< Handler > >::onWsHandshake ( ErrorCode const & ec )

protectedinherited

Definition at line 124 of file BaseWSPeer.h.

◆ doWrite()

void xrpl::BaseWSPeer< Handler, PlainWSPeer< Handler > >::doWrite ( )

protectedinherited

Definition at line 127 of file BaseWSPeer.h.

◆ onWrite()

void xrpl::BaseWSPeer< Handler, PlainWSPeer< Handler > >::onWrite ( ErrorCode const & ec )

protectedinherited

Definition at line 130 of file BaseWSPeer.h.

◆ onWriteFin()

void xrpl::BaseWSPeer< Handler, PlainWSPeer< Handler > >::onWriteFin ( ErrorCode const & ec )

protectedinherited

Definition at line 133 of file BaseWSPeer.h.

◆ doRead()

void xrpl::BaseWSPeer< Handler, PlainWSPeer< Handler > >::doRead ( )

protectedinherited

Definition at line 136 of file BaseWSPeer.h.

◆ onRead()

void xrpl::BaseWSPeer< Handler, PlainWSPeer< Handler > >::onRead ( ErrorCode const & ec )

protectedinherited

Definition at line 139 of file BaseWSPeer.h.

◆ onClose()

void xrpl::BaseWSPeer< Handler, PlainWSPeer< Handler > >::onClose ( ErrorCode const & ec )

protectedinherited

Definition at line 142 of file BaseWSPeer.h.

◆ startTimer()

void xrpl::BaseWSPeer< Handler, PlainWSPeer< Handler > >::startTimer ( )

protectedinherited

Definition at line 145 of file BaseWSPeer.h.

◆ cancelTimer()

void xrpl::BaseWSPeer< Handler, PlainWSPeer< Handler > >::cancelTimer ( )

protectedinherited

Definition at line 148 of file BaseWSPeer.h.

◆ onPing()

void xrpl::BaseWSPeer< Handler, PlainWSPeer< Handler > >::onPing ( ErrorCode const & ec )

protectedinherited

Definition at line 151 of file BaseWSPeer.h.

◆ onPingPong()

void xrpl::BaseWSPeer< Handler, PlainWSPeer< Handler > >::onPingPong	(	boost::beast::websocket::frame_type	kind,
		std::string_view	payload )

protectedinherited

Definition at line 154 of file BaseWSPeer.h.

◆ onTimer()

void xrpl::BaseWSPeer< Handler, PlainWSPeer< Handler > >::onTimer ( ErrorCode ec )

protectedinherited

Definition at line 157 of file BaseWSPeer.h.

◆ fail()

void xrpl::BaseWSPeer< Handler, PlainWSPeer< Handler > >::fail	(	ErrorCode	ec,
		String const &	what )

protectedinherited

Definition at line 161 of file BaseWSPeer.h.

◆ destroy()

void xrpl::IOList::Work::destroy ( )

privateinherited

Definition at line 25 of file io_list.h.

◆ ios()

IOList & xrpl::IOList::Work::ios ( )

inherited

Return the IOList associated with the work.

Requirements: The call to IOList::emplace to create the work has already returned.

Definition at line 44 of file io_list.h.

◆ BasePeer< Handler, PlainWSPeer >

template<class Handler>

friend class BasePeer< Handler, PlainWSPeer >

friend

Definition at line 45 of file PlainWSPeer.h.

◆ BaseWSPeer< Handler, PlainWSPeer >

template<class Handler>

friend class BaseWSPeer< Handler, PlainWSPeer >

friend

Definition at line 45 of file PlainWSPeer.h.

Member Data Documentation

◆ ws_

template<class Handler>

boost::beast::websocket::stream<SocketType> xrpl::PlainWSPeer< Handler >::ws_

private

Definition at line 28 of file PlainWSPeer.h.

◆ request_

HttpRequestType xrpl::BaseWSPeer< Handler, PlainWSPeer< Handler > >::request_

privateinherited

Definition at line 50 of file BaseWSPeer.h.

◆ rb_

boost::beast::multi_buffer xrpl::BaseWSPeer< Handler, PlainWSPeer< Handler > >::rb_

privateinherited

Definition at line 51 of file BaseWSPeer.h.

◆ wb_

boost::beast::multi_buffer xrpl::BaseWSPeer< Handler, PlainWSPeer< Handler > >::wb_

privateinherited

Definition at line 52 of file BaseWSPeer.h.

◆ wq_

std::list<std::shared_ptr<WSMsg> > xrpl::BaseWSPeer< Handler, PlainWSPeer< Handler > >::wq_

privateinherited

Definition at line 53 of file BaseWSPeer.h.

◆ doClose_

bool xrpl::BaseWSPeer< Handler, PlainWSPeer< Handler > >::doClose_

privateinherited

The socket has been closed, or will close after the next write finishes.

Do not do any more writes, and don't try to close again.

Definition at line 59 of file BaseWSPeer.h.

◆ cr_

boost::beast::websocket::close_reason xrpl::BaseWSPeer< Handler, PlainWSPeer< Handler > >::cr_

privateinherited

Definition at line 60 of file BaseWSPeer.h.

◆ timer_

WaitableTimer xrpl::BaseWSPeer< Handler, PlainWSPeer< Handler > >::timer_

privateinherited

Definition at line 61 of file BaseWSPeer.h.

◆ closeOnTimer_

bool xrpl::BaseWSPeer< Handler, PlainWSPeer< Handler > >::closeOnTimer_

privateinherited

Definition at line 62 of file BaseWSPeer.h.

◆ pingActive_

bool xrpl::BaseWSPeer< Handler, PlainWSPeer< Handler > >::pingActive_

privateinherited

Definition at line 63 of file BaseWSPeer.h.

◆ payload_

boost::beast::websocket::ping_data xrpl::BaseWSPeer< Handler, PlainWSPeer< Handler > >::payload_

privateinherited

Definition at line 64 of file BaseWSPeer.h.

◆ ec_

ErrorCode xrpl::BaseWSPeer< Handler, PlainWSPeer< Handler > >::ec_

privateinherited

Definition at line 65 of file BaseWSPeer.h.

◆ controlCallback_

std::function<void(boost::beast::websocket::frame_type, std::string_view)> xrpl::BaseWSPeer< Handler, PlainWSPeer< Handler > >::controlCallback_

privateinherited

Definition at line 66 of file BaseWSPeer.h.

◆ port_

Port const& xrpl::BasePeer< Handler, PlainWSPeer< Handler > >::port_

protectedinherited

Definition at line 28 of file BasePeer.h.

◆ handler_

Handler& xrpl::BasePeer< Handler, PlainWSPeer< Handler > >::handler_

protectedinherited

Definition at line 29 of file BasePeer.h.

◆ remoteAddress_

EndpointType xrpl::BasePeer< Handler, PlainWSPeer< Handler > >::remoteAddress_

protectedinherited

Definition at line 30 of file BasePeer.h.

◆ sink_

beast::WrappedSink xrpl::BasePeer< Handler, PlainWSPeer< Handler > >::sink_

protectedinherited

Definition at line 31 of file BasePeer.h.

◆ j_

beast::Journal const xrpl::BasePeer< Handler, PlainWSPeer< Handler > >::j_

protectedinherited

Definition at line 32 of file BasePeer.h.

◆ work_

boost::asio::executor_work_guard<boost::asio::executor> xrpl::BasePeer< Handler, PlainWSPeer< Handler > >::work_

protectedinherited

Definition at line 34 of file BasePeer.h.

◆ strand_

boost::asio::strand<boost::asio::executor> xrpl::BasePeer< Handler, PlainWSPeer< Handler > >::strand_

protectedinherited

Definition at line 35 of file BasePeer.h.

◆ ios_

IOList* xrpl::IOList::Work::ios_

privateinherited

Definition at line 28 of file io_list.h.

◆ appDefined

std::shared_ptr<void> xrpl::WSSession::appDefined

inherited

Definition at line 90 of file WSSession.h.

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ ClockType

◆ ErrorCode

◆ EndpointType

◆ WaitableTimer

◆ SocketType

Constructor & Destructor Documentation

◆ PlainWSPeer()

Member Function Documentation

◆ run()

◆ port()

◆ request()

◆ remoteEndpoint()

◆ send()

◆ close() [1/2]

◆ close() [2/2]

◆ complete()

◆ impl()

◆ onWsHandshake()

◆ doWrite()

◆ onWrite()

◆ onWriteFin()

◆ doRead()

◆ onRead()

◆ onClose()

◆ startTimer()

◆ cancelTimer()

◆ onPing()

◆ onPingPong()

◆ onTimer()

◆ fail()

◆ destroy()

◆ ios()

Friends And Related Symbol Documentation

◆ BasePeer< Handler, PlainWSPeer >

◆ BaseWSPeer< Handler, PlainWSPeer >

Member Data Documentation

◆ ws_

◆ request_

◆ rb_

◆ wb_

◆ wq_

◆ doClose_

◆ cr_

◆ timer_

◆ closeOnTimer_

◆ pingActive_

◆ payload_

◆ ec_

◆ controlCallback_

◆ port_

◆ handler_

◆ remoteAddress_

◆ sink_

◆ j_

◆ work_

◆ strand_

◆ ios_

◆ appDefined