rippled
Public Types | Public Member Functions | Private Attributes | List of all members
ripple::RCLValidation Class Reference

Wrapper over STValidation for generic Validation code. More...

Collaboration diagram for ripple::RCLValidation:
Collaboration graph
[legend]

Public Types

using NodeKey = ripple::PublicKey
 
using NodeID = ripple::NodeID
 

Public Member Functions

 RCLValidation (std::shared_ptr< STValidation > const &v)
 Constructor. More...
 
uint256 ledgerID () const
 Validated ledger's hash. More...
 
std::uint32_t seq () const
 Validated ledger's sequence number (0 if none) More...
 
NetClock::time_point signTime () const
 Validation's signing time. More...
 
NetClock::time_point seenTime () const
 Validated ledger's first seen time. More...
 
PublicKey key () const
 Public key of validator that published the validation. More...
 
NodeID nodeID () const
 NodeID of validator that published the validation. More...
 
bool trusted () const
 Whether the validation is considered trusted. More...
 
void setTrusted ()
 
void setUntrusted ()
 
bool full () const
 Whether the validation is full (not-partial) More...
 
std::optional< std::uint32_tloadFee () const
 Get the load fee of the validation if it exists. More...
 
std::uint64_t cookie () const
 Get the cookie specified in the validation (0 if not set) More...
 
std::shared_ptr< STValidationunwrap () const
 Extract the underlying STValidation being wrapped. More...
 

Private Attributes

std::shared_ptr< STValidationval_
 

Detailed Description

Wrapper over STValidation for generic Validation code.

Wraps an STValidation for compatibility with the generic validation code.

Definition at line 38 of file RCLValidations.h.

Member Typedef Documentation

◆ NodeKey

Definition at line 43 of file RCLValidations.h.

◆ NodeID

Definition at line 44 of file RCLValidations.h.

Constructor & Destructor Documentation

◆ RCLValidation()

ripple::RCLValidation::RCLValidation ( std::shared_ptr< STValidation > const &  v)

Constructor.

Parameters
vThe validation to wrap.

Definition at line 50 of file RCLValidations.h.

Member Function Documentation

◆ ledgerID()

uint256 ripple::RCLValidation::ledgerID ( ) const

Validated ledger's hash.

Definition at line 56 of file RCLValidations.h.

◆ seq()

std::uint32_t ripple::RCLValidation::seq ( ) const

Validated ledger's sequence number (0 if none)

Definition at line 63 of file RCLValidations.h.

◆ signTime()

NetClock::time_point ripple::RCLValidation::signTime ( ) const

Validation's signing time.

Definition at line 70 of file RCLValidations.h.

◆ seenTime()

NetClock::time_point ripple::RCLValidation::seenTime ( ) const

Validated ledger's first seen time.

Definition at line 77 of file RCLValidations.h.

◆ key()

PublicKey ripple::RCLValidation::key ( ) const

Public key of validator that published the validation.

Definition at line 84 of file RCLValidations.h.

◆ nodeID()

NodeID ripple::RCLValidation::nodeID ( ) const

NodeID of validator that published the validation.

Definition at line 91 of file RCLValidations.h.

◆ trusted()

bool ripple::RCLValidation::trusted ( ) const

Whether the validation is considered trusted.

Definition at line 98 of file RCLValidations.h.

◆ setTrusted()

void ripple::RCLValidation::setTrusted ( )

Definition at line 104 of file RCLValidations.h.

◆ setUntrusted()

void ripple::RCLValidation::setUntrusted ( )

Definition at line 110 of file RCLValidations.h.

◆ full()

bool ripple::RCLValidation::full ( ) const

Whether the validation is full (not-partial)

Definition at line 117 of file RCLValidations.h.

◆ loadFee()

std::optional<std::uint32_t> ripple::RCLValidation::loadFee ( ) const

Get the load fee of the validation if it exists.

Definition at line 124 of file RCLValidations.h.

◆ cookie()

std::uint64_t ripple::RCLValidation::cookie ( ) const

Get the cookie specified in the validation (0 if not set)

Definition at line 131 of file RCLValidations.h.

◆ unwrap()

std::shared_ptr<STValidation> ripple::RCLValidation::unwrap ( ) const

Extract the underlying STValidation being wrapped.

Definition at line 138 of file RCLValidations.h.

Member Data Documentation

◆ val_

std::shared_ptr<STValidation> ripple::RCLValidation::val_
private

Definition at line 40 of file RCLValidations.h.