Represents a ledger in RCLConsensus. More...
#include <RCLCxLedger.h>
Public Types | |
| using | ID = LedgerHash |
| Unique identifier of a ledger. | |
| using | Seq = LedgerIndex |
| Sequence number of a ledger. | |
Public Member Functions | |
| RCLCxLedger ()=default | |
| Default constructor. | |
| RCLCxLedger (std::shared_ptr< Ledger const > const &l) | |
| Constructor. | |
| Seq const & | seq () const |
| Sequence number of the ledger. | |
| ID const & | id () const |
| Unique identifier (hash) of this ledger. | |
| ID const & | parentID () const |
| Unique identifier (hash) of this ledger's parent. | |
| NetClock::duration | closeTimeResolution () const |
| Resolution used when calculating this ledger's close time. | |
| bool | closeAgree () const |
| Whether consensus process agreed on close time of the ledger. | |
| NetClock::time_point | closeTime () const |
| The close time of this ledger. | |
| NetClock::time_point | parentCloseTime () const |
| The close time of this ledger's parent. | |
| Json::Value | getJson () const |
| JSON representation of this ledger. | |
Public Attributes | |
| std::shared_ptr< Ledger const > | ledger_ |
| The ledger instance. | |
Detailed Description
Represents a ledger in RCLConsensus.
RCLCxLedger is a thin wrapper over std::shared_ptr<Ledger const>.
Definition at line 16 of file RCLCxLedger.h.
Member Typedef Documentation
◆ ID
| using ripple::RCLCxLedger::ID = LedgerHash |
Unique identifier of a ledger.
Definition at line 20 of file RCLCxLedger.h.
◆ Seq
| using ripple::RCLCxLedger::Seq = LedgerIndex |
Sequence number of a ledger.
Definition at line 22 of file RCLCxLedger.h.
Constructor & Destructor Documentation
◆ RCLCxLedger() [1/2]
|
default |
Default constructor.
TODO: This may not be needed if we ensure RCLConsensus is handed a valid ledger in its constructor. Its bad now because other members are not checking whether the ledger is valid.
◆ RCLCxLedger() [2/2]
| ripple::RCLCxLedger::RCLCxLedger | ( | std::shared_ptr< Ledger const > const & | l | ) |
Member Function Documentation
◆ seq()
| Seq const & ripple::RCLCxLedger::seq | ( | ) | const |
Sequence number of the ledger.
Definition at line 42 of file RCLCxLedger.h.
◆ id()
| ID const & ripple::RCLCxLedger::id | ( | ) | const |
Unique identifier (hash) of this ledger.
Definition at line 49 of file RCLCxLedger.h.
◆ parentID()
| ID const & ripple::RCLCxLedger::parentID | ( | ) | const |
Unique identifier (hash) of this ledger's parent.
Definition at line 56 of file RCLCxLedger.h.
◆ closeTimeResolution()
| NetClock::duration ripple::RCLCxLedger::closeTimeResolution | ( | ) | const |
Resolution used when calculating this ledger's close time.
Definition at line 63 of file RCLCxLedger.h.
◆ closeAgree()
| bool ripple::RCLCxLedger::closeAgree | ( | ) | const |
Whether consensus process agreed on close time of the ledger.
Definition at line 70 of file RCLCxLedger.h.
◆ closeTime()
| NetClock::time_point ripple::RCLCxLedger::closeTime | ( | ) | const |
The close time of this ledger.
Definition at line 77 of file RCLCxLedger.h.
◆ parentCloseTime()
| NetClock::time_point ripple::RCLCxLedger::parentCloseTime | ( | ) | const |
The close time of this ledger's parent.
Definition at line 84 of file RCLCxLedger.h.
◆ getJson()
| Json::Value ripple::RCLCxLedger::getJson | ( | ) | const |
JSON representation of this ledger.
Definition at line 91 of file RCLCxLedger.h.
Member Data Documentation
◆ ledger_
| std::shared_ptr<Ledger const> ripple::RCLCxLedger::ledger_ |
The ledger instance.
TODO: Make this shared_ptr<ReadView const> .. requires ability to create a new ledger from a readView?
Definition at line 101 of file RCLCxLedger.h.
