rippled
Public Member Functions | List of all members
ripple::reduce_relay::SquelchHandler Class Referenceabstract

Abstract class. More...

Inheritance diagram for ripple::reduce_relay::SquelchHandler:
Inheritance graph
[legend]

Public Member Functions

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

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 71 of file overlay/Slot.h.

Constructor & Destructor Documentation

◆ ~SquelchHandler()

virtual ripple::reduce_relay::SquelchHandler::~SquelchHandler ( )
virtual

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

Member Function Documentation

◆ squelch()

virtual void ripple::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 ripple::test::OverlaySim, ripple::OverlayImpl, and ripple::test::reduce_relay_test::Handler.

◆ unsquelch()

virtual void ripple::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 ripple::test::OverlaySim, ripple::OverlayImpl, and ripple::test::reduce_relay_test::Handler.