xrpl::WSSession Struct Reference

#include <WSSession.h>

Inheritance diagram for xrpl::WSSession:

Collaboration diagram for xrpl::WSSession:

Public Member Functions
virtual	~WSSession ()=default
	WSSession ()=default
	WSSession (WSSession const &)=delete
WSSession &	operator= (WSSession const &)=delete
virtual void	run ()=0
virtual Port const &	port () const =0
virtual http_request_type const &	request () const =0
virtual boost::asio::ip::tcp::endpoint const &	remoteEndpoint () const =0
virtual void	send (std::shared_ptr< WSMsg > w)=0
	Send a WebSockets message.
virtual void	close ()=0
virtual void	close (boost::beast::websocket::close_reason const &reason)=0
virtual void	complete ()=0
	Indicate that the response is complete.

Public Attributes
std::shared_ptr< void >	appDefined

Detailed Description

Definition at line 86 of file WSSession.h.

Constructor & Destructor Documentation

~WSSession()

virtual xrpl::WSSession::~WSSession ( )

virtualdefault

WSSession() [1/2]

xrpl::WSSession::WSSession ( )

default

WSSession() [2/2]

xrpl::WSSession::WSSession ( WSSession const & )

delete

Member Function Documentation

operator=()

WSSession & xrpl::WSSession::operator= ( WSSession const & )

delete

run()

virtual void xrpl::WSSession::run ( )

pure virtual

Implemented in xrpl::BaseWSPeer< Handler, Impl >, xrpl::BaseWSPeer< Handler, PlainWSPeer< Handler > >, and xrpl::BaseWSPeer< Handler, SSLWSPeer< Handler > >.

port()

virtual Port const & xrpl::WSSession::port ( ) const

nodiscardpure virtual

Implemented in xrpl::BaseWSPeer< Handler, Impl >, xrpl::BaseWSPeer< Handler, PlainWSPeer< Handler > >, and xrpl::BaseWSPeer< Handler, SSLWSPeer< Handler > >.

request()

virtual http_request_type const & xrpl::WSSession::request ( ) const

nodiscardpure virtual

Implemented in xrpl::BaseWSPeer< Handler, Impl >, xrpl::BaseWSPeer< Handler, PlainWSPeer< Handler > >, and xrpl::BaseWSPeer< Handler, SSLWSPeer< Handler > >.

remoteEndpoint()

virtual boost::asio::ip::tcp::endpoint const & xrpl::WSSession::remoteEndpoint ( ) const

nodiscardpure virtual

Implemented in xrpl::BaseWSPeer< Handler, Impl >, xrpl::BaseWSPeer< Handler, PlainWSPeer< Handler > >, and xrpl::BaseWSPeer< Handler, SSLWSPeer< Handler > >.

send()

virtual void xrpl::WSSession::send ( std::shared_ptr< WSMsg > w )

pure virtual

Send a WebSockets message.

Implemented in xrpl::BaseWSPeer< Handler, Impl >, xrpl::BaseWSPeer< Handler, PlainWSPeer< Handler > >, and xrpl::BaseWSPeer< Handler, SSLWSPeer< Handler > >.

close() [1/2]

virtual void xrpl::WSSession::close ( )

pure virtual

Implemented in xrpl::BaseWSPeer< Handler, Impl >, xrpl::BaseWSPeer< Handler, PlainWSPeer< Handler > >, and xrpl::BaseWSPeer< Handler, SSLWSPeer< Handler > >.

close() [2/2]

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

pure virtual

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

complete()

virtual void xrpl::WSSession::complete ( )

pure virtual

Indicate that the response is complete.

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

Implemented in xrpl::BaseWSPeer< Handler, Impl >, xrpl::BaseWSPeer< Handler, PlainWSPeer< Handler > >, and xrpl::BaseWSPeer< Handler, SSLWSPeer< Handler > >.

Member Data Documentation

appDefined

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

Definition at line 88 of file WSSession.h.