xrpld
Loading...
Searching...
No Matches
Classes | Public Member Functions | Private Types | Private Member Functions | Private Attributes | Static Private Attributes | List of all members
xrpl::Door< Handler > Class Template Reference

A listening socket. More...

#include <Door.h>

Inheritance diagram for xrpl::Door< Handler >:
Inheritance graph
[legend]
Collaboration diagram for xrpl::Door< Handler >:
Collaboration graph
[legend]

Classes

class  Detector
struct  FDStats

Public Member Functions

 Door (Handler &handler, boost::asio::io_context &ioContext, Port const &port, beast::Journal j)
void run ()
void close () override
 Close the Door listening socket and connections.
EndpointType getEndpoint () const
IOList & ios ()
 Return the IOList associated with the work.
T shared_from_this (T... args)
T weak_from_this (T... args)

Private Types

using ClockType = std::chrono::steady_clock
using TimerType = boost::asio::basic_waitable_timer<ClockType>
using ErrorCode = boost::system::error_code
using YieldContext = boost::asio::yield_context
using ProtocolType = boost::asio::ip::tcp
using AcceptorType = ProtocolType::acceptor
using EndpointType = ProtocolType::endpoint
using SocketType = boost::asio::ip::tcp::socket
using StreamType = boost::beast::tcp_stream

Private Member Functions

void reOpen ()
std::optional< FDStats > queryFdStats () const
bool shouldThrottleForFds ()
template<class ConstBufferSequence>
void create (bool ssl, ConstBufferSequence const &buffers, StreamType &&stream, EndpointType remoteAddress)
void doAccept (YieldContext yield)
template<class = void>
void destroy ()

Private Attributes

beast::Journal const j_
Port const & port_
Handler & handler_
boost::asio::io_context & ioc_
AcceptorType acceptor_
boost::asio::strand< boost::asio::io_context::executor_type > strand_
bool ssl_
bool plain_
std::chrono::milliseconds acceptDelay_ {kInitialAcceptDelay}
boost::asio::steady_timer backoffTimer_
ClockType::time_point fdSampleAt_
bool cachedThrottle_ {false}
IOList * ios_ = nullptr

Static Private Attributes

static constexpr std::chrono::milliseconds kInitialAcceptDelay {50}
static constexpr std::chrono::milliseconds kMaxAcceptDelay {2000}
static constexpr std::uint64_t kMaxUsedFdPercent = 70
static constexpr std::chrono::milliseconds kFdSampleInterval {250}

Detailed Description

template<class Handler>
class xrpl::Door< Handler >

A listening socket.

Definition at line 47 of file Door.h.

Member Typedef Documentation

◆ ClockType

template<class Handler>
using xrpl::Door< Handler >::ClockType = std::chrono::steady_clock
private

Definition at line 50 of file Door.h.

◆ TimerType

template<class Handler>
using xrpl::Door< Handler >::TimerType = boost::asio::basic_waitable_timer<ClockType>
private

Definition at line 51 of file Door.h.

◆ ErrorCode

template<class Handler>
using xrpl::Door< Handler >::ErrorCode = boost::system::error_code
private

Definition at line 52 of file Door.h.

◆ YieldContext

template<class Handler>
using xrpl::Door< Handler >::YieldContext = boost::asio::yield_context
private

Definition at line 53 of file Door.h.

◆ ProtocolType

template<class Handler>
using xrpl::Door< Handler >::ProtocolType = boost::asio::ip::tcp
private

Definition at line 54 of file Door.h.

◆ AcceptorType

template<class Handler>
using xrpl::Door< Handler >::AcceptorType = ProtocolType::acceptor
private

Definition at line 55 of file Door.h.

◆ EndpointType

template<class Handler>
using xrpl::Door< Handler >::EndpointType = ProtocolType::endpoint
private

Definition at line 56 of file Door.h.

◆ SocketType

template<class Handler>
using xrpl::Door< Handler >::SocketType = boost::asio::ip::tcp::socket
private

Definition at line 57 of file Door.h.

◆ StreamType

template<class Handler>
using xrpl::Door< Handler >::StreamType = boost::beast::tcp_stream
private

Definition at line 58 of file Door.h.

Constructor & Destructor Documentation

◆ Door()

template<class Handler>
xrpl::Door< Handler >::Door ( Handler & handler,
boost::asio::io_context & ioContext,
Port const & port,
beast::Journal j )

Definition at line 280 of file Door.h.

Member Function Documentation

◆ reOpen()

template<class Handler>
void xrpl::Door< Handler >::reOpen ( )
private

Definition at line 230 of file Door.h.

◆ queryFdStats()

template<class Handler>
std::optional< typename Door< Handler >::FDStats > xrpl::Door< Handler >::queryFdStats ( ) const
private

Definition at line 406 of file Door.h.

◆ shouldThrottleForFds()

template<class Handler>
bool xrpl::Door< Handler >::shouldThrottleForFds ( )
private

Definition at line 437 of file Door.h.

◆ run()

template<class Handler>
void xrpl::Door< Handler >::run ( )

Definition at line 299 of file Door.h.

◆ close()

template<class Handler>
void xrpl::Door< Handler >::close ( )
overridevirtual

Close the Door listening socket and connections.

The listening socket is closed, and all open connections belonging to the Door are closed. Thread Safety: May be called concurrently

Implements xrpl::IOList::Work.

Definition at line 307 of file Door.h.

◆ getEndpoint()

template<class Handler>
EndpointType xrpl::Door< Handler >::getEndpoint ( ) const
nodiscard

Definition at line 145 of file Door.h.

◆ create()

template<class Handler>
template<class ConstBufferSequence>
void xrpl::Door< Handler >::create ( bool ssl,
ConstBufferSequence const & buffers,
StreamType && stream,
EndpointType remoteAddress )
private

Definition at line 323 of file Door.h.

◆ doAccept()

template<class Handler>
void xrpl::Door< Handler >::doAccept ( YieldContext yield)
private

Definition at line 343 of file Door.h.

◆ destroy()

template<class = void>
void xrpl::IOList::Work::destroy ( )
privateinherited

Definition at line 170 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.

Member Data Documentation

◆ j_

template<class Handler>
beast::Journal const xrpl::Door< Handler >::j_
private

Definition at line 91 of file Door.h.

◆ port_

template<class Handler>
Port const& xrpl::Door< Handler >::port_
private

Definition at line 92 of file Door.h.

◆ handler_

template<class Handler>
Handler& xrpl::Door< Handler >::handler_
private

Definition at line 93 of file Door.h.

◆ ioc_

template<class Handler>
boost::asio::io_context& xrpl::Door< Handler >::ioc_
private

Definition at line 94 of file Door.h.

◆ acceptor_

template<class Handler>
AcceptorType xrpl::Door< Handler >::acceptor_
private

Definition at line 95 of file Door.h.

◆ strand_

template<class Handler>
boost::asio::strand<boost::asio::io_context::executor_type> xrpl::Door< Handler >::strand_
private

Definition at line 96 of file Door.h.

◆ ssl_

template<class Handler>
bool xrpl::Door< Handler >::ssl_
private
Initial value:
{
port_.protocol.contains("https") || port_.protocol.contains("wss") ||
port_.protocol.contains("wss2") || port_.protocol.contains("peer")}
xrpl::Door::port_
Port const & port_
Definition Door.h:92

Definition at line 97 of file Door.h.

◆ plain_

template<class Handler>
bool xrpl::Door< Handler >::plain_
private
Initial value:
{
port_.protocol.contains("http") || port_.protocol.contains("ws") ||
(port_.protocol.contains("ws2"))}

Definition at line 100 of file Door.h.

◆ kInitialAcceptDelay

template<class Handler>
std::chrono::milliseconds xrpl::Door< Handler >::kInitialAcceptDelay {50}
staticconstexprprivate

Definition at line 103 of file Door.h.

◆ kMaxAcceptDelay

template<class Handler>
std::chrono::milliseconds xrpl::Door< Handler >::kMaxAcceptDelay {2000}
staticconstexprprivate

Definition at line 104 of file Door.h.

◆ acceptDelay_

template<class Handler>
std::chrono::milliseconds xrpl::Door< Handler >::acceptDelay_ {kInitialAcceptDelay}
private

Definition at line 105 of file Door.h.

◆ backoffTimer_

template<class Handler>
boost::asio::steady_timer xrpl::Door< Handler >::backoffTimer_
private

Definition at line 106 of file Door.h.

◆ kMaxUsedFdPercent

template<class Handler>
std::uint64_t xrpl::Door< Handler >::kMaxUsedFdPercent = 70
staticconstexprprivate

Definition at line 107 of file Door.h.

◆ kFdSampleInterval

template<class Handler>
std::chrono::milliseconds xrpl::Door< Handler >::kFdSampleInterval {250}
staticconstexprprivate

Definition at line 108 of file Door.h.

◆ fdSampleAt_

template<class Handler>
ClockType::time_point xrpl::Door< Handler >::fdSampleAt_
private

Definition at line 109 of file Door.h.

◆ cachedThrottle_

template<class Handler>
bool xrpl::Door< Handler >::cachedThrottle_ {false}
private

Definition at line 110 of file Door.h.

◆ ios_

IOList* xrpl::IOList::Work::ios_ = nullptr
privateinherited

Definition at line 28 of file io_list.h.

Generated by doxygen 1.17.0