rippled
ApplyViewBase.h
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 #ifndef RIPPLE_LEDGER_APPLYVIEWBASE_H_INCLUDED
21 #define RIPPLE_LEDGER_APPLYVIEWBASE_H_INCLUDED
22 
23 #include <ripple/basics/XRPAmount.h>
24 #include <ripple/ledger/ApplyView.h>
25 #include <ripple/ledger/OpenView.h>
26 #include <ripple/ledger/ReadView.h>
27 #include <ripple/ledger/detail/ApplyStateTable.h>
28 
29 namespace ripple {
30 namespace detail {
31 
32 class ApplyViewBase : public ApplyView, public RawView
33 {
34 public:
35  ApplyViewBase() = delete;
36  ApplyViewBase(ApplyViewBase const&) = delete;
38  operator=(ApplyViewBase&&) = delete;
40  operator=(ApplyViewBase const&) = delete;
41 
42  ApplyViewBase(ApplyViewBase&&) = default;
43 
44  ApplyViewBase(ReadView const* base, ApplyFlags flags);
45 
46  // ReadView
47  bool
48  open() const override;
49 
50  LedgerInfo const&
51  info() const override;
52 
53  Fees const&
54  fees() const override;
55 
56  Rules const&
57  rules() const override;
58 
59  bool
60  exists(Keylet const& k) const override;
61 
63  succ(
64  key_type const& key,
65  std::optional<key_type> const& last = std::nullopt) const override;
66 
68  read(Keylet const& k) const override;
69 
71  slesBegin() const override;
72 
74  slesEnd() const override;
75 
77  slesUpperBound(uint256 const& key) const override;
78 
80  txsBegin() const override;
81 
83  txsEnd() const override;
84 
85  bool
86  txExists(key_type const& key) const override;
87 
88  tx_type
89  txRead(key_type const& key) const override;
90 
91  // ApplyView
92 
94  flags() const override;
95 
97  peek(Keylet const& k) override;
98 
99  void
100  erase(std::shared_ptr<SLE> const& sle) override;
101 
102  void
103  insert(std::shared_ptr<SLE> const& sle) override;
104 
105  void
106  update(std::shared_ptr<SLE> const& sle) override;
107 
108  // RawView
109 
110  void
111  rawErase(std::shared_ptr<SLE> const& sle) override;
112 
113  void
114  rawInsert(std::shared_ptr<SLE> const& sle) override;
115 
116  void
117  rawReplace(std::shared_ptr<SLE> const& sle) override;
118 
119  void
120  rawDestroyXRP(XRPAmount const& feeDrops) override;
121 
122 protected:
124  ReadView const* base_;
126 };
127 
128 } // namespace detail
129 } // namespace ripple
130 
131 #endif
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
std::pair
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::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::detail::ApplyViewBase::operator=
ApplyViewBase & operator=(ApplyViewBase &&)=delete
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::ApplyView
Writeable view to a ledger, for applying a transaction.
Definition: ApplyView.h:134
ripple::detail::ApplyViewBase::ApplyViewBase
ApplyViewBase()=delete
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::RawView
Interface for ledger entry changes.
Definition: RawView.h:36
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::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::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::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
std::unique_ptr
STL class.
ripple::detail::ApplyViewBase
Definition: ApplyViewBase.h:32
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::ApplyStateTable
Definition: ApplyStateTable.h:36
ripple::detail::ApplyViewBase::rawDestroyXRP
void rawDestroyXRP(XRPAmount const &feeDrops) override
Destroy XRP.
Definition: ApplyViewBase.cpp:172