rippled
ApplyViewBase.cpp
1 //------------------------------------------------------------------------------
2 /*
3  This file is part of rippled: https://github.com/ripple/rippled
4  Copyright (c) 2012, 2013 Ripple Labs Inc.
5 
6  Permission to use, copy, modify, and/or distribute this software for any
7  purpose with or without fee is hereby granted, provided that the above
8  copyright notice and this permission notice appear in all copies.
9 
10  THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11  WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12  MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13  ANY SPECIAL , DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14  WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15  ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16  OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17 */
18 //==============================================================================
19 
20 #include <ripple/basics/contract.h>
21 #include <ripple/ledger/detail/ApplyViewBase.h>
22 
23 namespace ripple {
24 namespace detail {
25 
27  : flags_(flags), base_(base)
28 {
29 }
30 
31 //---
32 
33 bool
35 {
36  return base_->open();
37 }
38 
39 LedgerInfo const&
41 {
42  return base_->info();
43 }
44 
45 Fees const&
47 {
48  return base_->fees();
49 }
50 
51 Rules const&
53 {
54  return base_->rules();
55 }
56 
57 bool
59 {
60  return items_.exists(*base_, k);
61 }
62 
63 auto
66 {
67  return items_.succ(*base_, key, last);
68 }
69 
71 ApplyViewBase::read(Keylet const& k) const
72 {
73  return items_.read(*base_, k);
74 }
75 
76 auto
77 ApplyViewBase::slesBegin() const -> std::unique_ptr<sles_type::iter_base>
78 {
79  return base_->slesBegin();
80 }
81 
82 auto
83 ApplyViewBase::slesEnd() const -> std::unique_ptr<sles_type::iter_base>
84 {
85  return base_->slesEnd();
86 }
87 
88 auto
91 {
92  return base_->slesUpperBound(key);
93 }
94 
95 auto
96 ApplyViewBase::txsBegin() const -> std::unique_ptr<txs_type::iter_base>
97 {
98  return base_->txsBegin();
99 }
100 
101 auto
102 ApplyViewBase::txsEnd() const -> std::unique_ptr<txs_type::iter_base>
103 {
104  return base_->txsEnd();
105 }
106 
107 bool
109 {
110  return base_->txExists(key);
111 }
112 
113 auto
115 {
116  return base_->txRead(key);
117 }
118 
119 //---
120 
123 {
124  return flags_;
125 }
126 
129 {
130  return items_.peek(*base_, k);
131 }
132 
133 void
135 {
136  items_.erase(*base_, sle);
137 }
138 
139 void
141 {
142  items_.insert(*base_, sle);
143 }
144 
145 void
147 {
148  items_.update(*base_, sle);
149 }
150 
151 //---
152 
153 void
155 {
156  items_.rawErase(*base_, sle);
157 }
158 
159 void
161 {
162  items_.insert(*base_, sle);
163 }
164 
165 void
167 {
168  items_.replace(*base_, sle);
169 }
170 
171 void
173 {
174  items_.destroyXRP(fee);
175 }
176 
177 } // namespace detail
178 } // namespace ripple
ripple::ReadView::info
virtual LedgerInfo const & info() const =0
Returns information about the ledger.
ripple::detail::ApplyViewBase::succ
std::optional< key_type > succ(key_type const &key, std::optional< key_type > const &last=std::nullopt) const override
Return the key of the next state item.
Definition: ApplyViewBase.cpp:64
ripple::Keylet
A pair of SHAMap key and LedgerEntryType.
Definition: Keylet.h:38
std::shared_ptr
STL class.
ripple::detail::ApplyViewBase::rawReplace
void rawReplace(std::shared_ptr< SLE > const &sle) override
Unconditionally replace a state item.
Definition: ApplyViewBase.cpp:166
ripple::detail::ApplyViewBase::txsBegin
std::unique_ptr< txs_type::iter_base > txsBegin() const override
Definition: ApplyViewBase.cpp:96
ripple::ReadView::txs_type
Definition: ReadView.h:146
std::pair
ripple::detail::ApplyStateTable::insert
void insert(ReadView const &base, std::shared_ptr< SLE > const &sle)
Definition: ApplyStateTable.cpp:432
ripple::detail::ApplyViewBase::txRead
tx_type txRead(key_type const &key) const override
Read a transaction from the tx map.
Definition: ApplyViewBase.cpp:114
ripple::detail::ApplyViewBase::exists
bool exists(Keylet const &k) const override
Determine if a state item exists.
Definition: ApplyViewBase.cpp:58
ripple::ReadView::fees
virtual Fees const & fees() const =0
Returns the fees for the base ledger.
ripple::ApplyFlags
ApplyFlags
Definition: ApplyView.h:29
ripple::detail::ApplyViewBase::update
void update(std::shared_ptr< SLE > const &sle) override
Indicate changes to a peeked SLE.
Definition: ApplyViewBase.cpp:146
ripple::ReadView::txsEnd
virtual std::unique_ptr< txs_type::iter_base > txsEnd() const =0
ripple::detail::ApplyStateTable::exists
bool exists(ReadView const &base, Keylet const &k) const
Definition: ApplyStateTable.cpp:268
ripple::ReadView::txExists
virtual bool txExists(key_type const &key) const =0
Returns true if a tx exists in the tx map.
ripple::ReadView::slesBegin
virtual std::unique_ptr< sles_type::iter_base > slesBegin() const =0
ripple::detail::ApplyViewBase::fees
Fees const & fees() const override
Returns the fees for the base ledger.
Definition: ApplyViewBase.cpp:46
ripple::detail::ApplyViewBase::items_
detail::ApplyStateTable items_
Definition: ApplyViewBase.h:125
ripple::detail::ApplyStateTable::destroyXRP
void destroyXRP(XRPAmount const &fee)
Definition: ApplyStateTable.cpp:514
ripple::detail::ApplyStateTable::replace
void replace(ReadView const &base, std::shared_ptr< SLE > const &sle)
Definition: ApplyStateTable.cpp:462
ripple::detail::ApplyViewBase::ApplyViewBase
ApplyViewBase()=delete
ripple::ReadView::txsBegin
virtual std::unique_ptr< txs_type::iter_base > txsBegin() const =0
ripple::detail::ApplyViewBase::txsEnd
std::unique_ptr< txs_type::iter_base > txsEnd() const override
Definition: ApplyViewBase.cpp:102
ripple::base_uint< 256 >
ripple::detail::ApplyViewBase::open
bool open() const override
Returns true if this reflects an open ledger.
Definition: ApplyViewBase.cpp:34
ripple::Fees
Reflects the fee settings for a particular ledger.
Definition: ReadView.h:49
ripple::detail::ApplyViewBase::info
LedgerInfo const & info() const override
Returns information about the ledger.
Definition: ApplyViewBase.cpp:40
ripple::detail::ApplyViewBase::slesEnd
std::unique_ptr< sles_type::iter_base > slesEnd() const override
Definition: ApplyViewBase.cpp:83
ripple::detail::ApplyViewBase::base_
ReadView const * base_
Definition: ApplyViewBase.h:124
ripple::ReadView::slesEnd
virtual std::unique_ptr< sles_type::iter_base > slesEnd() const =0
ripple::detail::ApplyStateTable::erase
void erase(ReadView const &base, std::shared_ptr< SLE > const &sle)
Definition: ApplyStateTable.cpp:381
ripple::detail::ApplyViewBase::slesBegin
std::unique_ptr< sles_type::iter_base > slesBegin() const override
Definition: ApplyViewBase.cpp:77
ripple::detail::ApplyViewBase::rawErase
void rawErase(std::shared_ptr< SLE > const &sle) override
Delete an existing state item.
Definition: ApplyViewBase.cpp:154
ripple::detail::ApplyStateTable::read
std::shared_ptr< SLE const > read(ReadView const &base, Keylet const &k) const
Definition: ApplyStateTable.cpp:325
ripple::detail::ApplyStateTable::rawErase
void rawErase(ReadView const &base, std::shared_ptr< SLE > const &sle)
Definition: ApplyStateTable.cpp:405
ripple::detail::ApplyViewBase::insert
void insert(std::shared_ptr< SLE > const &sle) override
Insert a new state SLE.
Definition: ApplyViewBase.cpp:140
ripple::detail::ApplyViewBase::erase
void erase(std::shared_ptr< SLE > const &sle) override
Remove a peeked SLE.
Definition: ApplyViewBase.cpp:134
ripple::detail::ApplyViewBase::flags
ApplyFlags flags() const override
Returns the tx apply flags.
Definition: ApplyViewBase.cpp:122
ripple::ReadView
A view into a ledger.
Definition: ReadView.h:125
ripple
Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.
Definition: RCLCensorshipDetector.h:29
ripple::ReadView::sles_type
Definition: ReadView.h:135
ripple::ReadView::rules
virtual Rules const & rules() const =0
Returns the tx processing rules.
std
STL namespace.
ripple::detail::ApplyStateTable::update
void update(ReadView const &base, std::shared_ptr< SLE > const &sle)
Definition: ApplyStateTable.cpp:491
ripple::Rules
Rules controlling protocol behavior.
Definition: Rules.h:33
ripple::detail::ApplyViewBase::flags_
ApplyFlags flags_
Definition: ApplyViewBase.h:123
std::optional
ripple::detail::ApplyViewBase::read
std::shared_ptr< SLE const > read(Keylet const &k) const override
Return the state item associated with a key.
Definition: ApplyViewBase.cpp:71
ripple::detail::ApplyViewBase::peek
std::shared_ptr< SLE > peek(Keylet const &k) override
Prepare to modify the SLE associated with key.
Definition: ApplyViewBase.cpp:128
ripple::LedgerInfo
Information about the notional ledger backing the view.
Definition: ReadView.h:75
ripple::detail::ApplyViewBase::rules
Rules const & rules() const override
Returns the tx processing rules.
Definition: ApplyViewBase.cpp:52
ripple::detail::ApplyViewBase::txExists
bool txExists(key_type const &key) const override
Returns true if a tx exists in the tx map.
Definition: ApplyViewBase.cpp:108
ripple::detail::ApplyStateTable::peek
std::shared_ptr< SLE > peek(ReadView const &base, Keylet const &k)
Definition: ApplyStateTable.cpp:347
std::unique_ptr
STL class.
ripple::ReadView::open
virtual bool open() const =0
Returns true if this reflects an open ledger.
ripple::detail::ApplyViewBase::rawInsert
void rawInsert(std::shared_ptr< SLE > const &sle) override
Unconditionally insert a state item.
Definition: ApplyViewBase.cpp:160
ripple::detail::ApplyViewBase::slesUpperBound
std::unique_ptr< sles_type::iter_base > slesUpperBound(uint256 const &key) const override
Definition: ApplyViewBase.cpp:89
ripple::XRPAmount
Definition: XRPAmount.h:46
ripple::detail::ApplyViewBase::rawDestroyXRP
void rawDestroyXRP(XRPAmount const &feeDrops) override
Destroy XRP.
Definition: ApplyViewBase.cpp:172