#include <PlainHTTPPeer.h>

Inheritance diagram for ripple::PlainHTTPPeer< Handler >:

[legend]

Collaboration diagram for ripple::PlainHTTPPeer< Handler >:

[legend]

Public Member Functions
template<class ConstBufferSequence >
	PlainHTTPPeer (Port const &port, Handler &handler, boost::asio::io_context &ioc, beast::Journal journal, endpoint_type remote_address, ConstBufferSequence const &buffers, stream_type &&stream)

void	run ()

std::shared_ptr< WSSession >	websocketUpgrade () override
	Convert the connection to WebSocket.

Session &	session ()

void	close () override

io_list &	ios ()
	Return the io_list associated with the work.

T	shared_from_this (T... args)

T	weak_from_this (T... args)


void	write (std::string const &s)
	Send a copy of data asynchronously.

template<typename BufferSequence >
void	write (BufferSequence const &buffers)

Public Attributes
void *	tag = nullptr
	A user-definable pointer.

Protected Types
enum

using	clock_type = std::chrono::system_clock

using	error_code = boost::system::error_code

using	yield_context = boost::asio::yield_context

Protected Member Functions
void	close (bool graceful) override
	Close the session.

PlainHTTPPeer< Handler > &	impl ()

void	fail (error_code ec, char const *what)

void	start_timer ()

void	cancel_timer ()

void	on_timer ()

void	do_read (yield_context do_yield)

void	on_write (error_code const &ec, std::size_t bytes_transferred)

void	do_writer (std::shared_ptr< Writer > const &writer, bool keep_alive, yield_context do_yield)

beast::Journal	journal () override
	Returns the Journal to use for logging.

Port const &	port () override
	Returns the Port settings for this connection.

beast::IP::Endpoint	remoteAddress () override
	Returns the remote address of the connection.

http_request_type &	request () override
	Returns the current HTTP request.

void	write (void const *buffer, std::size_t bytes) override

void	write (std::shared_ptr< Writer > const &writer, bool keep_alive) override

std::shared_ptr< Session >	detach () override
	Detach the session.

void	complete () override
	Indicate that the response is complete.

Protected Attributes
Port const &	port_

Handler &	handler_

boost::asio::executor_work_guard< boost::asio::executor >	work_

boost::asio::strand< boost::asio::executor >	strand_

endpoint_type	remote_address_

beast::Journal const	journal_

std::string	id_

std::size_t	nid_

boost::asio::streambuf	read_buf_

http_request_type	message_

std::vector< buffer >	wq_

std::vector< buffer >	wq2_

std::mutex	mutex_

bool	graceful_

bool	complete_

boost::system::error_code	ec_

int	request_count_

std::size_t	bytes_in_

std::size_t	bytes_out_

Private Types
using	socket_type = boost::asio::ip::tcp::socket

using	stream_type = boost::beast::tcp_stream

using	endpoint_type = boost::asio::ip::tcp::endpoint

Private Member Functions
void	do_request () override

void	do_close () override

template<class = void>
void	destroy ()

Private Attributes
stream_type	stream_

socket_type &	socket_

io_list *	ios_ = nullptr

Friends
class	BaseHTTPPeer< Handler, PlainHTTPPeer >

Detailed Description

template<class Handler>
class ripple::PlainHTTPPeer< Handler >

Definition at line 34 of file PlainHTTPPeer.h.

Member Typedef Documentation

◆ socket_type

template<class Handler >

using ripple::PlainHTTPPeer< Handler >::socket_type = boost::asio::ip::tcp::socket

private

Definition at line 40 of file PlainHTTPPeer.h.

◆ stream_type

template<class Handler >

using ripple::PlainHTTPPeer< Handler >::stream_type = boost::beast::tcp_stream

private

Definition at line 41 of file PlainHTTPPeer.h.

◆ endpoint_type

template<class Handler >

using ripple::PlainHTTPPeer< Handler >::endpoint_type = boost::asio::ip::tcp::endpoint

private

Definition at line 42 of file PlainHTTPPeer.h.

◆ clock_type

using ripple::BaseHTTPPeer< Handler, PlainHTTPPeer< Handler > >::clock_type = std::chrono::system_clock

protectedinherited

Definition at line 55 of file BaseHTTPPeer.h.

◆ error_code

using ripple::BaseHTTPPeer< Handler, PlainHTTPPeer< Handler > >::error_code = boost::system::error_code

protectedinherited

Definition at line 56 of file BaseHTTPPeer.h.

◆ yield_context

using ripple::BaseHTTPPeer< Handler, PlainHTTPPeer< Handler > >::yield_context = boost::asio::yield_context

protectedinherited

Definition at line 58 of file BaseHTTPPeer.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

protectedinherited

Definition at line 60 of file BaseHTTPPeer.h.

Constructor & Destructor Documentation

◆ PlainHTTPPeer()

template<class Handler >

template<class ConstBufferSequence >

ripple::PlainHTTPPeer< Handler >::PlainHTTPPeer	(	Port const &	port,
		Handler &	handler,
		boost::asio::io_context &	ioc,
		beast::Journal	journal,
		endpoint_type	remote_address,
		ConstBufferSequence const &	buffers,
		stream_type &&	stream
	)

Definition at line 76 of file PlainHTTPPeer.h.

Member Function Documentation

◆ run()

template<class Handler >

void ripple::PlainHTTPPeer< Handler >::run ( )

Definition at line 104 of file PlainHTTPPeer.h.

◆ websocketUpgrade()

template<class Handler >

std::shared_ptr< WSSession > ripple::PlainHTTPPeer< Handler >::websocketUpgrade ( )

overridevirtual

Convert the connection to WebSocket.

Implements ripple::Session.

Definition at line 127 of file PlainHTTPPeer.h.

◆ do_request()

template<class Handler >

void ripple::PlainHTTPPeer< Handler >::do_request ( )

overrideprivatevirtual

Implements ripple::BaseHTTPPeer< Handler, PlainHTTPPeer< Handler > >.

Definition at line 141 of file PlainHTTPPeer.h.

◆ do_close()

template<class Handler >

void ripple::PlainHTTPPeer< Handler >::do_close ( )

overrideprivatevirtual

Implements ripple::BaseHTTPPeer< Handler, PlainHTTPPeer< Handler > >.

Definition at line 170 of file PlainHTTPPeer.h.

◆ session()

Session & ripple::BaseHTTPPeer< Handler, PlainHTTPPeer< Handler > >::session ( )

inherited

Definition at line 120 of file BaseHTTPPeer.h.

◆ close() [1/2]

void ripple::BaseHTTPPeer< Handler, PlainHTTPPeer< Handler > >::close ( )

overridevirtualinherited

Implements ripple::io_list::work.

Definition at line 126 of file BaseHTTPPeer.h.

◆ close() [2/2]

void ripple::BaseHTTPPeer< Handler, PlainHTTPPeer< Handler > >::close ( bool graceful )

overrideprotectedvirtualinherited

Close the session.

This will be performed asynchronously. The session will be closed gracefully after all pending writes have completed.

Parameters

graceful true to wait until all data has finished sending.

Implements ripple::Session.

Definition at line 204 of file BaseHTTPPeer.h.

◆ impl()

PlainHTTPPeer< Handler > & ripple::BaseHTTPPeer< Handler, PlainHTTPPeer< Handler > >::impl ( )

protectedinherited

Definition at line 130 of file BaseHTTPPeer.h.

◆ fail()

void ripple::BaseHTTPPeer< Handler, PlainHTTPPeer< Handler > >::fail	(	error_code	ec,
		char const *	what
	)

protectedinherited

Definition at line 136 of file BaseHTTPPeer.h.

◆ start_timer()

void ripple::BaseHTTPPeer< Handler, PlainHTTPPeer< Handler > >::start_timer ( )

protectedinherited

Definition at line 139 of file BaseHTTPPeer.h.

◆ cancel_timer()

void ripple::BaseHTTPPeer< Handler, PlainHTTPPeer< Handler > >::cancel_timer ( )

protectedinherited

Definition at line 142 of file BaseHTTPPeer.h.

◆ on_timer()

void ripple::BaseHTTPPeer< Handler, PlainHTTPPeer< Handler > >::on_timer ( )

protectedinherited

Definition at line 145 of file BaseHTTPPeer.h.

◆ do_read()

void ripple::BaseHTTPPeer< Handler, PlainHTTPPeer< Handler > >::do_read ( yield_context do_yield )

protectedinherited

Definition at line 148 of file BaseHTTPPeer.h.

◆ on_write()

void ripple::BaseHTTPPeer< Handler, PlainHTTPPeer< Handler > >::on_write	(	error_code const &	ec,
		std::size_t	bytes_transferred
	)

protectedinherited

Definition at line 151 of file BaseHTTPPeer.h.

◆ do_writer()

void ripple::BaseHTTPPeer< Handler, PlainHTTPPeer< Handler > >::do_writer	(	std::shared_ptr< Writer > const &	writer,
		bool	keep_alive,
		yield_context	do_yield
	)

protectedinherited

Definition at line 154 of file BaseHTTPPeer.h.

◆ journal()

beast::Journal ripple::BaseHTTPPeer< Handler, PlainHTTPPeer< Handler > >::journal ( )

overrideprotectedvirtualinherited

Returns the Journal to use for logging.

Implements ripple::Session.

Definition at line 168 of file BaseHTTPPeer.h.

◆ port()

Port const & ripple::BaseHTTPPeer< Handler, PlainHTTPPeer< Handler > >::port ( )

overrideprotectedvirtualinherited

Returns the Port settings for this connection.

Implements ripple::Session.

Definition at line 174 of file BaseHTTPPeer.h.

◆ remoteAddress()

beast::IP::Endpoint ripple::BaseHTTPPeer< Handler, PlainHTTPPeer< Handler > >::remoteAddress ( )

overrideprotectedvirtualinherited

Returns the remote address of the connection.

Implements ripple::Session.

Definition at line 180 of file BaseHTTPPeer.h.

◆ request()

http_request_type & ripple::BaseHTTPPeer< Handler, PlainHTTPPeer< Handler > >::request ( )

overrideprotectedvirtualinherited

Returns the current HTTP request.

Implements ripple::Session.

Definition at line 186 of file BaseHTTPPeer.h.

◆ write() [1/4]

void ripple::BaseHTTPPeer< Handler, PlainHTTPPeer< Handler > >::write	(	void const *	buffer,
		std::size_t	bytes
	)

overrideprotectedvirtualinherited

Implements ripple::Session.

Definition at line 192 of file BaseHTTPPeer.h.

◆ write() [2/4]

void ripple::BaseHTTPPeer< Handler, PlainHTTPPeer< Handler > >::write	(	std::shared_ptr< Writer > const &	writer,
		bool	keep_alive
	)

overrideprotectedvirtualinherited

Implements ripple::Session.

Definition at line 195 of file BaseHTTPPeer.h.

◆ write() [3/4]

void ripple::Session::write ( std::string const & s )

inherited

Send a copy of data asynchronously.

Definition at line 76 of file Session.h.

◆ write() [4/4]

template<typename BufferSequence >

void ripple::Session::write ( BufferSequence const & buffers )

inherited

Definition at line 84 of file Session.h.

◆ detach()

std::shared_ptr< Session > ripple::BaseHTTPPeer< Handler, PlainHTTPPeer< Handler > >::detach ( )

overrideprotectedvirtualinherited

Detach the session.

This holds the session open so that the response can be sent asynchronously. Calls to io_context::run made by the server will not return until all detached sessions are closed.

Implements ripple::Session.

Definition at line 198 of file BaseHTTPPeer.h.

◆ complete()

void ripple::BaseHTTPPeer< Handler, PlainHTTPPeer< Handler > >::complete ( )

overrideprotectedvirtualinherited

Indicate that the response is complete.

The handler should call this when it has completed writing the response. If Keep-Alive is indicated on the connection, this will trigger a read for the next request; else, the connection will be closed when all remaining data has been sent.

Implements ripple::Session.

Definition at line 201 of file BaseHTTPPeer.h.

◆ destroy()

template<class = void>

void ripple::io_list::work::destroy ( )

privateinherited

Definition at line 182 of file io_list.h.

◆ ios()

io_list & ripple::io_list::work::ios ( )

inherited

Return the io_list associated with the work.

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

Definition at line 60 of file io_list.h.

Friends And Related Symbol Documentation

◆ BaseHTTPPeer< Handler, PlainHTTPPeer >

template<class Handler >

friend class BaseHTTPPeer< Handler, PlainHTTPPeer >

friend

Definition at line 170 of file PlainHTTPPeer.h.

Member Data Documentation

◆ stream_

template<class Handler >

stream_type ripple::PlainHTTPPeer< Handler >::stream_

private

Definition at line 44 of file PlainHTTPPeer.h.

◆ socket_

template<class Handler >

socket_type& ripple::PlainHTTPPeer< Handler >::socket_

private

Definition at line 45 of file PlainHTTPPeer.h.

◆ port_

Port const& ripple::BaseHTTPPeer< Handler, PlainHTTPPeer< Handler > >::port_

protectedinherited

Definition at line 82 of file BaseHTTPPeer.h.

◆ handler_

Handler& ripple::BaseHTTPPeer< Handler, PlainHTTPPeer< Handler > >::handler_

protectedinherited

Definition at line 83 of file BaseHTTPPeer.h.

◆ work_

boost::asio::executor_work_guard<boost::asio::executor> ripple::BaseHTTPPeer< Handler, PlainHTTPPeer< Handler > >::work_

protectedinherited

Definition at line 84 of file BaseHTTPPeer.h.

◆ strand_

boost::asio::strand<boost::asio::executor> ripple::BaseHTTPPeer< Handler, PlainHTTPPeer< Handler > >::strand_

protectedinherited

Definition at line 85 of file BaseHTTPPeer.h.

◆ remote_address_

endpoint_type ripple::BaseHTTPPeer< Handler, PlainHTTPPeer< Handler > >::remote_address_

protectedinherited

Definition at line 86 of file BaseHTTPPeer.h.

◆ journal_

beast::Journal const ripple::BaseHTTPPeer< Handler, PlainHTTPPeer< Handler > >::journal_

protectedinherited

Definition at line 87 of file BaseHTTPPeer.h.

◆ id_

std::string ripple::BaseHTTPPeer< Handler, PlainHTTPPeer< Handler > >::id_

protectedinherited

Definition at line 89 of file BaseHTTPPeer.h.

◆ nid_

std::size_t ripple::BaseHTTPPeer< Handler, PlainHTTPPeer< Handler > >::nid_

protectedinherited

Definition at line 90 of file BaseHTTPPeer.h.

◆ read_buf_

boost::asio::streambuf ripple::BaseHTTPPeer< Handler, PlainHTTPPeer< Handler > >::read_buf_

protectedinherited

Definition at line 92 of file BaseHTTPPeer.h.

◆ message_

http_request_type ripple::BaseHTTPPeer< Handler, PlainHTTPPeer< Handler > >::message_

protectedinherited

Definition at line 93 of file BaseHTTPPeer.h.

◆ wq_

std::vector<buffer> ripple::BaseHTTPPeer< Handler, PlainHTTPPeer< Handler > >::wq_

protectedinherited

Definition at line 94 of file BaseHTTPPeer.h.

◆ wq2_

std::vector<buffer> ripple::BaseHTTPPeer< Handler, PlainHTTPPeer< Handler > >::wq2_

protectedinherited

Definition at line 95 of file BaseHTTPPeer.h.

◆ mutex_

std::mutex ripple::BaseHTTPPeer< Handler, PlainHTTPPeer< Handler > >::mutex_

protectedinherited

Definition at line 96 of file BaseHTTPPeer.h.

◆ graceful_

bool ripple::BaseHTTPPeer< Handler, PlainHTTPPeer< Handler > >::graceful_

protectedinherited

Definition at line 97 of file BaseHTTPPeer.h.

◆ complete_

bool ripple::BaseHTTPPeer< Handler, PlainHTTPPeer< Handler > >::complete_

protectedinherited

Definition at line 98 of file BaseHTTPPeer.h.

◆ ec_

boost::system::error_code ripple::BaseHTTPPeer< Handler, PlainHTTPPeer< Handler > >::ec_

protectedinherited

Definition at line 99 of file BaseHTTPPeer.h.

◆ request_count_

int ripple::BaseHTTPPeer< Handler, PlainHTTPPeer< Handler > >::request_count_

protectedinherited

Definition at line 101 of file BaseHTTPPeer.h.

◆ bytes_in_

std::size_t ripple::BaseHTTPPeer< Handler, PlainHTTPPeer< Handler > >::bytes_in_

protectedinherited

Definition at line 102 of file BaseHTTPPeer.h.

◆ bytes_out_

std::size_t ripple::BaseHTTPPeer< Handler, PlainHTTPPeer< Handler > >::bytes_out_

protectedinherited

Definition at line 103 of file BaseHTTPPeer.h.

◆ ios_

io_list* ripple::io_list::work::ios_ = nullptr

privateinherited

Definition at line 45 of file io_list.h.

◆ tag

void* ripple::Session::tag = nullptr

inherited

A user-definable pointer.

The initial value is always zero. Changes to the value are persisted between calls.

Definition at line 55 of file Session.h.

Public Member Functions

Public Attributes

Protected Types

Protected Member Functions

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ socket_type

◆ stream_type

◆ endpoint_type

◆ clock_type

◆ error_code

◆ yield_context

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ PlainHTTPPeer()

Member Function Documentation

◆ run()

◆ websocketUpgrade()

◆ do_request()

◆ do_close()

◆ session()

◆ close() [1/2]

◆ close() [2/2]

◆ impl()

◆ fail()

◆ start_timer()

◆ cancel_timer()

◆ on_timer()

◆ do_read()

◆ on_write()

◆ do_writer()

◆ journal()

◆ port()

◆ remoteAddress()

◆ request()

◆ write() [1/4]

◆ write() [2/4]

◆ write() [3/4]

◆ write() [4/4]

◆ detach()

◆ complete()

◆ destroy()

◆ ios()

Friends And Related Symbol Documentation

◆ BaseHTTPPeer< Handler, PlainHTTPPeer >

Member Data Documentation

◆ stream_

◆ socket_

◆ port_

◆ handler_

◆ work_

◆ strand_

◆ remote_address_

◆ journal_

◆ id_

◆ nid_

◆ read_buf_

◆ message_

◆ wq_

◆ wq2_

◆ mutex_

◆ graceful_

◆ complete_

◆ ec_

◆ request_count_

◆ bytes_in_

◆ bytes_out_

◆ ios_

◆ tag