Slots is a container for validator's Slot and handles Slot update when a message is received from a validator. More...

#include <Slot.h>

Collaboration diagram for xrpl::reduce_relay::Slots< ClockType >:

[legend]

Public Member Functions
	Slots (ServiceRegistry &registry, SquelchHandler const &handler, Config const &config)
	~Slots ()=default
bool	baseSquelchReady ()
	Check if base squelching feature is enabled and ready.
bool	reduceRelayReady ()
	Check if reduce_relay::kWaitOnBootup time passed since startup.
void	updateSlotAndSquelch (UInt256 const &key, PublicKey const &validator, ID id, protocol::MessageType type)
	Calls Slot::update of Slot associated with the validator, with a noop callback.
void	updateSlotAndSquelch (UInt256 const &key, PublicKey const &validator, ID id, protocol::MessageType type, Slot< ClockType >::IgnoredSquelchCallback callback)
	Calls Slot::update of Slot associated with the validator.
void	deleteIdlePeers ()
	Check if peers stopped relaying messages and if slots stopped receiving messages from the validator.
std::optional< std::uint16_t >	inState (PublicKey const &validator, PeerState state) const
	Return number of peers in state.
std::optional< std::uint16_t >	notInState (PublicKey const &validator, PeerState state) const
	Return number of peers not in state.
bool	inState (PublicKey const &validator, SlotState state) const
	Return true if Slot is in state.
std::set< ID >	getSelected (PublicKey const &validator)
	Get selected peers.
std::unordered_map< Peer::ID, std::tuple< PeerState, uint16_t, uint32_t, std::uint32_t > >	getPeers (PublicKey const &validator)
	Get peers info.
std::optional< SlotState >	getState (PublicKey const &validator)
	Get Slot's state.
void	deletePeer (ID id, bool erase)
	Called when a peer is deleted.

Private Types
using	time_point = ClockType::time_point
using	ID = Peer::ID
using	Messages

Private Member Functions
bool	addPeerMessage (UInt256 const &key, ID id)
	Add message/peer if have not seen this message from the peer.

Private Attributes
std::atomic_bool	reduceRelayReady_ {false}
HashMap< PublicKey, Slot< ClockType > >	slots_
SquelchHandler const &	handler_
Logs &	logs_
beast::Journal const	journal_
bool const	baseSquelchEnabled_
uint16_t const	maxSelectedPeers_

Static Private Attributes
static Messages	peersWithMessage {beast::getAbstractClock<ClockType>()}

Detailed Description

template<typename ClockType>
class xrpl::reduce_relay::Slots< ClockType >

Slots is a container for validator's Slot and handles Slot update when a message is received from a validator.

It also handles Slot aging and checks for peers which are disconnected or stopped relaying the messages.

Definition at line 572 of file src/xrpld/overlay/Slot.h.

Member Typedef Documentation

◆ time_point

template<typename ClockType>

using xrpl::reduce_relay::Slots< ClockType >::time_point = ClockType::time_point

private

Definition at line 574 of file src/xrpld/overlay/Slot.h.

◆ ID

template<typename ClockType>

using xrpl::reduce_relay::Slots< ClockType >::ID = Peer::ID

private

Definition at line 575 of file src/xrpld/overlay/Slot.h.

◆ Messages

template<typename ClockType>

using xrpl::reduce_relay::Slots< ClockType >::Messages

private

Initial value:

beast::AgedUnorderedMap<
       UInt256,
       std::unordered_set<Peer::ID>,
       ClockType,
       HardenedHash<StrongHash>>

Definition at line 576 of file src/xrpld/overlay/Slot.h.

Constructor & Destructor Documentation

◆ Slots()

template<typename ClockType>

xrpl::reduce_relay::Slots< ClockType >::Slots	(	ServiceRegistry &	registry,
		SquelchHandler const &	handler,
		Config const &	config )

Parameters

registry	The service registry.
handler	Squelch/unsquelch implementation
config	reference to the global config

Definition at line 588 of file src/xrpld/overlay/Slot.h.

◆ ~Slots()

template<typename ClockType>

xrpl::reduce_relay::Slots< ClockType >::~Slots ( )

default

Member Function Documentation

◆ baseSquelchReady()

template<typename ClockType>

bool xrpl::reduce_relay::Slots< ClockType >::baseSquelchReady ( )

Check if base squelching feature is enabled and ready.

Definition at line 602 of file src/xrpld/overlay/Slot.h.

◆ reduceRelayReady()

template<typename ClockType>

bool xrpl::reduce_relay::Slots< ClockType >::reduceRelayReady ( )

Check if reduce_relay::kWaitOnBootup time passed since startup.

Definition at line 611 of file src/xrpld/overlay/Slot.h.

◆ updateSlotAndSquelch() [1/2]

template<typename ClockType>

void xrpl::reduce_relay::Slots< ClockType >::updateSlotAndSquelch	(	UInt256 const &	key,
		PublicKey const &	validator,
		ID	id,
		protocol::MessageType	type )

Calls Slot::update of Slot associated with the validator, with a noop callback.

Parameters

key	Message's hash
validator	Validator's public key
id	Peer's id which received the message
type	Received protocol message type

Definition at line 631 of file src/xrpld/overlay/Slot.h.

◆ updateSlotAndSquelch() [2/2]

template<typename ClockType>

void xrpl::reduce_relay::Slots< ClockType >::updateSlotAndSquelch	(	UInt256 const &	key,
		PublicKey const &	validator,
		ID	id,
		protocol::MessageType	type,
		Slot< ClockType >::IgnoredSquelchCallback	callback )

Calls Slot::update of Slot associated with the validator.

Parameters

key	Message's hash
validator	Validator's public key
id	Peer's id which received the message
type	Received protocol message type
callback	A callback to report ignored validations

Definition at line 805 of file src/xrpld/overlay/Slot.h.

◆ deleteIdlePeers()

template<typename ClockType>

void xrpl::reduce_relay::Slots< ClockType >::deleteIdlePeers ( )

Check if peers stopped relaying messages and if slots stopped receiving messages from the validator.

Definition at line 843 of file src/xrpld/overlay/Slot.h.

◆ inState() [1/2]

template<typename ClockType>

std::optional< std::uint16_t > xrpl::reduce_relay::Slots< ClockType >::inState	(	PublicKey const &	validator,
		PeerState	state ) const

nodiscard

Return number of peers in state.

Definition at line 667 of file src/xrpld/overlay/Slot.h.

◆ notInState()

template<typename ClockType>

std::optional< std::uint16_t > xrpl::reduce_relay::Slots< ClockType >::notInState	(	PublicKey const &	validator,
		PeerState	state ) const

nodiscard

Return number of peers not in state.

Definition at line 679 of file src/xrpld/overlay/Slot.h.

◆ inState() [2/2]

template<typename ClockType>

bool xrpl::reduce_relay::Slots< ClockType >::inState	(	PublicKey const &	validator,
		SlotState	state ) const

nodiscard

Return true if Slot is in state.

Definition at line 691 of file src/xrpld/overlay/Slot.h.

◆ getSelected()

template<typename ClockType>

std::set< ID > xrpl::reduce_relay::Slots< ClockType >::getSelected ( PublicKey const & validator )

Get selected peers.

Definition at line 703 of file src/xrpld/overlay/Slot.h.

◆ getPeers()

template<typename ClockType>

std::unordered_map< Peer::ID, std::tuple< PeerState, uint16_t, uint32_t, std::uint32_t > > xrpl::reduce_relay::Slots< ClockType >::getPeers ( PublicKey const & validator )

Get peers info.

Return map of peer's state, count, and squelch expiration milliseconds.

Definition at line 716 of file src/xrpld/overlay/Slot.h.

◆ getState()

template<typename ClockType>

std::optional< SlotState > xrpl::reduce_relay::Slots< ClockType >::getState ( PublicKey const & validator )

Get Slot's state.

Definition at line 728 of file src/xrpld/overlay/Slot.h.

◆ deletePeer()

template<typename ClockType>

void xrpl::reduce_relay::Slots< ClockType >::deletePeer	(	ID	id,
		bool	erase )

Called when a peer is deleted.

If the peer was selected to be the source of messages from the validator then squelched peers have to be unsquelched.

Parameters

id	Peer's id
erase	If true then erase the peer

Definition at line 835 of file src/xrpld/overlay/Slot.h.

◆ addPeerMessage()

template<typename ClockType>

bool xrpl::reduce_relay::Slots< ClockType >::addPeerMessage	(	UInt256 const &	key,
		ID	id )

private

Add message/peer if have not seen this message from the peer.

A message is aged after IDLED seconds. Return true if added

Definition at line 774 of file src/xrpld/overlay/Slot.h.

Member Data Documentation

◆ reduceRelayReady_

template<typename ClockType>

std::atomic_bool xrpl::reduce_relay::Slots< ClockType >::reduceRelayReady_ {false}

private

Definition at line 755 of file src/xrpld/overlay/Slot.h.

◆ slots_

template<typename ClockType>

HashMap<PublicKey, Slot<ClockType> > xrpl::reduce_relay::Slots< ClockType >::slots_

private

Definition at line 757 of file src/xrpld/overlay/Slot.h.

◆ handler_

template<typename ClockType>

SquelchHandler const& xrpl::reduce_relay::Slots< ClockType >::handler_

private

Definition at line 758 of file src/xrpld/overlay/Slot.h.

◆ logs_

template<typename ClockType>

Logs& xrpl::reduce_relay::Slots< ClockType >::logs_

private

Definition at line 759 of file src/xrpld/overlay/Slot.h.

◆ journal_

template<typename ClockType>

beast::Journal const xrpl::reduce_relay::Slots< ClockType >::journal_

private

Definition at line 760 of file src/xrpld/overlay/Slot.h.

◆ baseSquelchEnabled_

template<typename ClockType>

bool const xrpl::reduce_relay::Slots< ClockType >::baseSquelchEnabled_

private

Definition at line 762 of file src/xrpld/overlay/Slot.h.

◆ maxSelectedPeers_

template<typename ClockType>

uint16_t const xrpl::reduce_relay::Slots< ClockType >::maxSelectedPeers_

private

Definition at line 763 of file src/xrpld/overlay/Slot.h.

◆ peersWithMessage

template<typename ClockType>

Messages xrpl::reduce_relay::Slots< ClockType >::peersWithMessage {beast::getAbstractClock<ClockType>()}

staticprivate

Definition at line 769 of file src/xrpld/overlay/Slot.h.

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Typedef Documentation

◆ time_point

◆ ID

◆ Messages

Constructor & Destructor Documentation

◆ Slots()

◆ ~Slots()

Member Function Documentation

◆ baseSquelchReady()

◆ reduceRelayReady()

◆ updateSlotAndSquelch() [1/2]

◆ updateSlotAndSquelch() [2/2]

◆ deleteIdlePeers()

◆ inState() [1/2]

◆ notInState()

◆ inState() [2/2]

◆ getSelected()

◆ getPeers()

◆ getState()

◆ deletePeer()

◆ addPeerMessage()

Member Data Documentation

◆ reduceRelayReady_

◆ slots_

◆ handler_

◆ logs_

◆ journal_

◆ baseSquelchEnabled_

◆ maxSelectedPeers_

◆ peersWithMessage