Store a list of transactions to be broadcast privately. More...

#include <private_broadcast.h>

Collaboration diagram for PrivateBroadcast:

Classes
struct	CTransactionRefComp

struct	CTransactionRefHash

struct	Priority
	Cumulative stats from all the send attempts for a transaction. Used to prioritize transactions. More...

struct	SendStatus
	Status of a transaction sent to a given node. More...

struct	TxAndSendStatusForNode
	A pair of a transaction and a sent status for a given node. Convenience return type of GetSendStatusByNode(). More...

Public Member Functions
bool	Add (const CTransactionRef &tx) EXCLUSIVE_LOCKS_REQUIRED(!m_mutex)
	Add a transaction to the storage. More...

std::optional< size_t >	Remove (const CTransactionRef &tx) EXCLUSIVE_LOCKS_REQUIRED(!m_mutex)
	Forget a transaction. More...

std::optional< CTransactionRef >	PickTxForSend (const NodeId &will_send_to_nodeid) EXCLUSIVE_LOCKS_REQUIRED(!m_mutex)
	Pick the transaction with the fewest send attempts, and confirmations, and oldest send/confirm times. More...

std::optional< CTransactionRef >	GetTxForNode (const NodeId &nodeid) EXCLUSIVE_LOCKS_REQUIRED(!m_mutex)
	Get the transaction that was picked for sending to a given node by PickTxForSend(). More...

void	NodeConfirmedReception (const NodeId &nodeid) EXCLUSIVE_LOCKS_REQUIRED(!m_mutex)
	Mark that the node has confirmed reception of the transaction we sent it by responding with `PONG` to our `PING` message. More...

bool	DidNodeConfirmReception (const NodeId &nodeid) EXCLUSIVE_LOCKS_REQUIRED(!m_mutex)
	Check if the node has confirmed reception of the transaction. More...

bool	HavePendingTransactions () EXCLUSIVE_LOCKS_REQUIRED(!m_mutex)
	Check if there are transactions that need to be broadcast. More...

std::vector< CTransactionRef >	GetStale () const EXCLUSIVE_LOCKS_REQUIRED(!m_mutex)
	Get the transactions that have not been broadcast recently. More...

Private Member Functions
std::optional< TxAndSendStatusForNode >	GetSendStatusByNode (const NodeId &nodeid) EXCLUSIVE_LOCKS_REQUIRED(m_mutex)
	Find which transaction we sent to a given node (marked by PickTxForSend()). More...

std::unordered_map< CTransactionRef, std::vector< SendStatus >, CTransactionRefHash, CTransactionRefComp > m_transactions	GUARDED_BY (m_mutex)

Static Private Member Functions
static Priority	DerivePriority (const std::vector< SendStatus > &sent_to)
	Derive the sending priority of a transaction. More...

Private Attributes
Mutex	m_mutex

Detailed Description

Store a list of transactions to be broadcast privately.

Supports the following operations:

Add a new transaction
Remove a transaction
Pick a transaction for sending to one recipient
Query which transaction has been picked for sending to a given recipient node
Mark that a given recipient node has confirmed receipt of a transaction
Query whether a given recipient node has confirmed reception
Query whether any transactions that need sending are currently on the list

Definition at line 30 of file private_broadcast.h.

Member Function Documentation

◆ Add()

bool PrivateBroadcast::Add ( const CTransactionRef & tx )

Add a transaction to the storage.

Parameters

[in] tx The transaction to add.

Return values

true	The transaction was added.
false	The transaction was already present.

Definition at line 14 of file private_broadcast.cpp.

Here is the caller graph for this function:

◆ DerivePriority()

PrivateBroadcast::Priority PrivateBroadcast::DerivePriority ( const std::vector< SendStatus > & sent_to )

staticprivate

Derive the sending priority of a transaction.

Parameters

[in] sent_to List of nodes that the transaction has been sent to.

Definition at line 107 of file private_broadcast.cpp.

Here is the caller graph for this function:

◆ DidNodeConfirmReception()

bool PrivateBroadcast::DidNodeConfirmReception ( const NodeId & nodeid )

Check if the node has confirmed reception of the transaction.

Return values

true	Node has confirmed, `NodeConfirmedReception()` has been called.
false	Node has not confirmed, `NodeConfirmedReception()` has not been called.

Definition at line 74 of file private_broadcast.cpp.

Here is the caller graph for this function:

◆ GetSendStatusByNode()

std::optional< PrivateBroadcast::TxAndSendStatusForNode > PrivateBroadcast::GetSendStatusByNode ( const NodeId & nodeid )

private

Find which transaction we sent to a given node (marked by PickTxForSend()).

Returns: That transaction together with the send status or nullopt if we did not send any transaction to the given node.

Definition at line 121 of file private_broadcast.cpp.

Here is the call graph for this function:

◆ GetStale()

std::vector< CTransactionRef > PrivateBroadcast::GetStale ( ) const

Get the transactions that have not been broadcast recently.

Definition at line 92 of file private_broadcast.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetTxForNode()

std::optional< CTransactionRef > PrivateBroadcast::GetTxForNode ( const NodeId & nodeid )

Get the transaction that was picked for sending to a given node by PickTxForSend().

Parameters

[in] nodeid Node to which a transaction is being (or was) sent.

Returns: Transaction or nullopt if the nodeid is unknown.

Definition at line 53 of file private_broadcast.cpp.

Here is the caller graph for this function:

◆ GUARDED_BY()

std::unordered_map< CTransactionRef, std::vector< SendStatus >, CTransactionRefHash, CTransactionRefComp > m_transactions PrivateBroadcast::GUARDED_BY ( m_mutex )

private

◆ HavePendingTransactions()

bool PrivateBroadcast::HavePendingTransactions ( )

Check if there are transactions that need to be broadcast.

Definition at line 85 of file private_broadcast.cpp.

Here is the caller graph for this function:

◆ NodeConfirmedReception()

void PrivateBroadcast::NodeConfirmedReception ( const NodeId & nodeid )

Mark that the node has confirmed reception of the transaction we sent it by responding with PONG to our PING message.

Parameters

[in] nodeid Node that we sent a transaction to.

Definition at line 64 of file private_broadcast.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ PickTxForSend()

std::optional< CTransactionRef > PrivateBroadcast::PickTxForSend ( const NodeId & will_send_to_nodeid )

Pick the transaction with the fewest send attempts, and confirmations, and oldest send/confirm times.

Parameters

[in] will_send_to_nodeid Will remember that the returned transaction was picked for sending to this node.

Returns: Most urgent transaction or nullopt if there are no transactions.

Definition at line 34 of file private_broadcast.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Remove()

std::optional< size_t > PrivateBroadcast::Remove ( const CTransactionRef & tx )

Forget a transaction.

Parameters

[in] tx Transaction to forget.

Return values

!nullopt	The number of times the transaction was sent and confirmed by the recipient (if the transaction existed and was removed).
nullopt	The transaction was not in the storage.

Definition at line 22 of file private_broadcast.cpp.

Here is the caller graph for this function:

Member Data Documentation

◆ m_mutex

Mutex PrivateBroadcast::m_mutex

mutableprivate

Definition at line 161 of file private_broadcast.h.

The documentation for this class was generated from the following files:

src/private_broadcast.h
src/private_broadcast.cpp

Classes

Public Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Member Function Documentation

◆ Add()

◆ DerivePriority()

◆ DidNodeConfirmReception()

◆ GetSendStatusByNode()

◆ GetStale()

◆ GetTxForNode()

◆ GUARDED_BY()

◆ HavePendingTransactions()

◆ NodeConfirmedReception()

◆ PickTxForSend()

◆ Remove()

Member Data Documentation

◆ m_mutex