xrpld
Loading...
Searching...
No Matches
xrpl::reduce_relay::SquelchHandler Class Referenceabstract

Abstract class. More...

#include <Slot.h>

Inheritance diagram for xrpl::reduce_relay::SquelchHandler:

Public Member Functions

virtual ~SquelchHandler ()=default
virtual void squelch (PublicKey const &validator, Peer::id_t id, std::uint32_t duration) const =0
 Squelch handler.
virtual void unsquelch (PublicKey const &validator, Peer::id_t id) const =0
 Unsquelch handler.

Detailed Description

Abstract class.

Declares squelch and unsquelch handlers. OverlayImpl inherits from this class. Motivation is for easier unit tests to facilitate on the fly changing callbacks.

Definition at line 50 of file overlay/Slot.h.

Constructor & Destructor Documentation

◆ ~SquelchHandler()

virtual xrpl::reduce_relay::SquelchHandler::~SquelchHandler ( )
virtualdefault

Member Function Documentation

◆ squelch()

virtual void xrpl::reduce_relay::SquelchHandler::squelch ( PublicKey const & validator,
Peer::id_t id,
std::uint32_t duration ) const
pure virtual

Squelch handler.

Parameters
validatorPublic key of the source validator
idPeer's id to squelch
durationSquelch duration in seconds

Implemented in xrpl::OverlayImpl, xrpl::test::OverlaySim, and xrpl::test::reduce_relay_test::Handler.

◆ unsquelch()

virtual void xrpl::reduce_relay::SquelchHandler::unsquelch ( PublicKey const & validator,
Peer::id_t id ) const
pure virtual

Unsquelch handler.

Parameters
validatorPublic key of the source validator
idPeer's id to unsquelch

Implemented in xrpl::OverlayImpl, xrpl::test::OverlaySim, and xrpl::test::reduce_relay_test::Handler.