xrpl::RCLTxSet Class Reference

Represents a set of transactions in RCLConsensus. More...

#include <RCLCxTx.h>

Collaboration diagram for xrpl::RCLTxSet:

Classes
class	MutableTxSet

Public Types
using	ID = uint256
	Unique identifier/hash of the set of transactions.
using	Tx = RCLCxTx
	The type that corresponds to a single transaction.

Public Member Functions
	RCLTxSet (std::shared_ptr< SHAMap > m)
	Constructor.
	RCLTxSet (MutableTxSet const &m)
	Constructor from a previously created MutableTxSet.
bool	exists (Tx::ID const &entry) const
	Test if a transaction is in the set.
boost::intrusive_ptr< SHAMapItem const > const &	find (Tx::ID const &entry) const
	Lookup a transaction.
ID	id () const
	The unique ID/hash of the transaction set.
std::map< Tx::ID, bool >	compare (RCLTxSet const &j) const
	Find transactions not in common between this and another transaction set.

Public Attributes
std::shared_ptr< SHAMap >	map_
	The SHAMap representing the transactions.

Detailed Description

Represents a set of transactions in RCLConsensus.

RCLTxSet is a thin wrapper over a SHAMap that stores the set of transactions.

Definition at line 42 of file RCLCxTx.h.

Member Typedef Documentation

ID

using xrpl::RCLTxSet::ID = uint256

Unique identifier/hash of the set of transactions.

Definition at line 46 of file RCLCxTx.h.

Tx

using xrpl::RCLTxSet::Tx = RCLCxTx

The type that corresponds to a single transaction.

Definition at line 48 of file RCLCxTx.h.

Constructor & Destructor Documentation

RCLTxSet() [1/2]

xrpl::RCLTxSet::RCLTxSet

(

std::shared_ptr< SHAMap >

m

)

Constructor.

Parameters

m	SHAMap to wrap

Definition at line 89 of file RCLCxTx.h.

RCLTxSet() [2/2]

xrpl::RCLTxSet::RCLTxSet

(

MutableTxSet const &

m

)

Constructor from a previously created MutableTxSet.

Parameters

m	MutableTxSet that will become fixed

Definition at line 98 of file RCLCxTx.h.

Member Function Documentation

exists()

bool xrpl::RCLTxSet::exists

(

Tx::ID const &

entry

)

const

Test if a transaction is in the set.

Parameters

entry

The ID of transaction to test.

Returns

Whether the transaction is in the set.

Definition at line 108 of file RCLCxTx.h.

find()

boost::intrusive_ptr< SHAMapItem const > const & xrpl::RCLTxSet::find

(

Tx::ID const &

entry

)

const

Lookup a transaction.

Parameters

entry

The ID of the transaction to find.

Returns

A shared pointer to the SHAMapItem.

Note

Since find may not succeed, this returns a std::shared_ptr<const SHAMapItem> rather than a Tx, which cannot refer to a missing transaction. The generic consensus code uses the shared_ptr semantics to know whether the find was successful and properly creates a Tx as needed.

Definition at line 125 of file RCLCxTx.h.

id()

ID xrpl::RCLTxSet::id

(

)

const

The unique ID/hash of the transaction set.

Definition at line 132 of file RCLCxTx.h.

compare()

std::map< Tx::ID, bool > xrpl::RCLTxSet::compare

(

RCLTxSet const &

j

)

const

Find transactions not in common between this and another transaction set.

Parameters

j	The set to compare with

Returns

Map of transactions in this set and j but not both. The key is the transaction ID and the value is a bool of the transaction exists in this set.

Definition at line 146 of file RCLCxTx.h.

Member Data Documentation

map_

std::shared_ptr<SHAMap> xrpl::RCLTxSet::map_

The SHAMap representing the transactions.

Definition at line 166 of file RCLCxTx.h.