rippled
Public Member Functions | List of all members
ripple::TxsRawView Class Referenceabstract

Interface for changing ledger entries with transactions. More...

Inheritance diagram for ripple::TxsRawView:
Inheritance graph
[legend]
Collaboration diagram for ripple::TxsRawView:
Collaboration graph
[legend]

Public Member Functions

virtual void rawTxInsert (ReadView::key_type const &key, std::shared_ptr< Serializer const > const &txn, std::shared_ptr< Serializer const > const &metaData)=0
 Add a transaction to the tx map. More...
 
virtual void rawErase (std::shared_ptr< SLE > const &sle)=0
 Delete an existing state item. More...
 
virtual void rawInsert (std::shared_ptr< SLE > const &sle)=0
 Unconditionally insert a state item. More...
 
virtual void rawReplace (std::shared_ptr< SLE > const &sle)=0
 Unconditionally replace a state item. More...
 
virtual void rawDestroyXRP (XRPAmount const &fee)=0
 Destroy XRP. More...
 

Detailed Description

Interface for changing ledger entries with transactions.

Allows raw modification of ledger entries and insertion of transactions into the transaction map.

Definition at line 97 of file RawView.h.

Member Function Documentation

◆ rawTxInsert()

virtual void ripple::TxsRawView::rawTxInsert ( ReadView::key_type const &  key,
std::shared_ptr< Serializer const > const &  txn,
std::shared_ptr< Serializer const > const &  metaData 
)
pure virtual

Add a transaction to the tx map.

Closed ledgers must have metadata, while open ledgers omit metadata.

Implemented in ripple::Ledger, and ripple::OpenView.

◆ rawErase()

virtual void ripple::RawView::rawErase ( std::shared_ptr< SLE > const &  sle)
pure virtualinherited

Delete an existing state item.

The SLE is provided so the implementation can calculate metadata.

Implemented in ripple::OpenView, ripple::Ledger, and ripple::detail::ApplyViewBase.

◆ rawInsert()

virtual void ripple::RawView::rawInsert ( std::shared_ptr< SLE > const &  sle)
pure virtualinherited

Unconditionally insert a state item.

Requirements: The key must not already exist.

Effects:

The key is associated with the SLE.
Note
The key is taken from the SLE

Implemented in ripple::OpenView, ripple::Ledger, and ripple::detail::ApplyViewBase.

◆ rawReplace()

virtual void ripple::RawView::rawReplace ( std::shared_ptr< SLE > const &  sle)
pure virtualinherited

Unconditionally replace a state item.

Requirements:

The key must exist.

Effects:

The key is associated with the SLE.
Note
The key is taken from the SLE

Implemented in ripple::OpenView, ripple::Ledger, and ripple::detail::ApplyViewBase.

◆ rawDestroyXRP()

virtual void ripple::RawView::rawDestroyXRP ( XRPAmount const &  fee)
pure virtualinherited

Destroy XRP.

This is used to pay for transaction fees.

Implemented in ripple::detail::ApplyViewBase, ripple::OpenView, and ripple::Ledger.