ripple::HashRouter::Entry Class Reference

An entry in the routing table. More...

Inheritance diagram for ripple::HashRouter::Entry:

Collaboration diagram for ripple::HashRouter::Entry:

Public Member Functions
	Entry ()
void	addPeer (PeerShortID peer)
int	getFlags (void) const
void	setFlags (int flagsToSet)
std::set< PeerShortID >	releasePeerSet ()
	Return set of peers we've relayed to and reset tracking. More...
std::optional< Stopwatch::time_point >	relayed () const
	Return seated relay time point if the message has been relayed. More...
bool	shouldRelay (Stopwatch::time_point const &now, std::chrono::seconds holdTime)
	Determines if this item should be relayed. More...
bool	shouldRecover (std::uint32_t limit)
	Determines if this item should be recovered from the open ledger. More...
bool	shouldProcess (Stopwatch::time_point now, std::chrono::seconds interval)

Static Private Member Functions
static auto &	getCounter () noexcept

Private Attributes
int	flags_ = 0
std::set< PeerShortID >	peers_
std::optional< Stopwatch::time_point >	relayed_
std::optional< Stopwatch::time_point >	processed_
std::uint32_t	recoveries_ = 0

Detailed Description

An entry in the routing table.

Definition at line 62 of file HashRouter.h.

Constructor & Destructor Documentation

Entry()

ripple::HashRouter::Entry::Entry

(

)

Definition at line 65 of file HashRouter.h.

Member Function Documentation

addPeer()

void ripple::HashRouter::Entry::addPeer

(

PeerShortID

peer

)

Definition at line 70 of file HashRouter.h.

getFlags()

int ripple::HashRouter::Entry::getFlags

(

void

)

const

Definition at line 77 of file HashRouter.h.

setFlags()

void ripple::HashRouter::Entry::setFlags

(

int

flagsToSet

)

Definition at line 83 of file HashRouter.h.

releasePeerSet()

std::set<PeerShortID> ripple::HashRouter::Entry::releasePeerSet

(

)

Return set of peers we've relayed to and reset tracking.

Definition at line 90 of file HashRouter.h.

relayed()

std::optional<Stopwatch::time_point> ripple::HashRouter::Entry::relayed

(

)

const

Return seated relay time point if the message has been relayed.

Definition at line 97 of file HashRouter.h.

shouldRelay()

bool ripple::HashRouter::Entry::shouldRelay	(	Stopwatch::time_point const &	now,
		std::chrono::seconds	holdTime
	)

Determines if this item should be relayed.

Checks whether the item has been recently relayed. If it has, return false. If it has not, update the last relay timestamp and return true.

Definition at line 109 of file HashRouter.h.

shouldRecover()

bool ripple::HashRouter::Entry::shouldRecover

(

std::uint32_t

limit

)

Determines if this item should be recovered from the open ledger.

Counts the number of times the item has been recovered. Every limit times the function is called, return false. Else return true.

Note

The limit must be > 0

Definition at line 128 of file HashRouter.h.

shouldProcess()

bool ripple::HashRouter::Entry::shouldProcess	(	Stopwatch::time_point	now,
		std::chrono::seconds	interval
	)

Definition at line 134 of file HashRouter.h.

getCounter()

static auto& ripple::CountedObject< Entry >::getCounter

staticprivatenoexceptinherited

Definition at line 128 of file CountedObject.h.

Member Data Documentation

flags_

int ripple::HashRouter::Entry::flags_ = 0

private

Definition at line 143 of file HashRouter.h.

peers_

std::set<PeerShortID> ripple::HashRouter::Entry::peers_

private

Definition at line 144 of file HashRouter.h.

relayed_

std::optional<Stopwatch::time_point> ripple::HashRouter::Entry::relayed_

private

Definition at line 147 of file HashRouter.h.

processed_

std::optional<Stopwatch::time_point> ripple::HashRouter::Entry::processed_

private

Definition at line 148 of file HashRouter.h.

recoveries_

std::uint32_t ripple::HashRouter::Entry::recoveries_ = 0

private

Definition at line 149 of file HashRouter.h.