rippled
TransactionAcquire.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_APP_LEDGER_TRANSACTIONACQUIRE_H_INCLUDED
21 #define RIPPLE_APP_LEDGER_TRANSACTIONACQUIRE_H_INCLUDED
22 
23 #include <ripple/app/main/Application.h>
24 #include <ripple/overlay/PeerSet.h>
25 #include <ripple/shamap/SHAMap.h>
26 
27 namespace ripple {
28 
29 // VFALCO TODO rename to PeerTxRequest
30 // A transaction set we are trying to acquire
31 class TransactionAcquire final
32  : public PeerSet,
33  public std::enable_shared_from_this<TransactionAcquire>,
34  public CountedObject<TransactionAcquire>
35 {
36 public:
38 
39  TransactionAcquire(Application& app, uint256 const& hash);
40  ~TransactionAcquire() = default;
41 
43  takeNodes(
44  const std::list<SHAMapNodeID>& IDs,
45  const std::list<Blob>& data,
46  std::shared_ptr<Peer> const&);
47 
48  void
49  init(int startPeers);
50 
51  void
52  stillNeed();
53 
54 private:
56  bool mHaveRoot;
57 
58  void
59  queueJob() override;
60 
61  void
62  onTimer(bool progress, ScopedLockType& peerSetLock) override;
63 
64  void
65  onPeerAdded(std::shared_ptr<Peer> const& peer) override
66  {
67  trigger(peer);
68  }
69 
70  void
71  done();
72 
73  void
74  addPeers(std::size_t limit);
75 
76  void
79  pmDowncast() override;
80 };
81 
82 } // namespace ripple
83 
84 #endif
ripple::TransactionAcquire::mHaveRoot
bool mHaveRoot
Definition: TransactionAcquire.h:56
ripple::Application
Definition: Application.h:97
ripple::SHAMapAddNode
Definition: SHAMapAddNode.h:28
ripple::TransactionAcquire::TransactionAcquire
TransactionAcquire(Application &app, uint256 const &hash)
Definition: TransactionAcquire.cpp:42
ripple::CountedObject
Tracks the number of instances of an object.
Definition: CountedObject.h:124
std::shared_ptr< TransactionAcquire >
std::list
STL class.
ripple::TransactionAcquire::queueJob
void queueJob() override
Queue a job to call invokeOnTimer().
Definition: TransactionAcquire.cpp:52
ripple::TransactionAcquire::trigger
void trigger(std::shared_ptr< Peer > const &)
Definition: TransactionAcquire.cpp:112
ripple::TransactionAcquire::addPeers
void addPeers(std::size_t limit)
Definition: TransactionAcquire.cpp:246
ripple::TransactionAcquire
Definition: TransactionAcquire.h:31
ripple::TransactionAcquire::pmDowncast
std::weak_ptr< PeerSet > pmDowncast() override
Return a weak pointer to this.
Definition: TransactionAcquire.cpp:106
ripple::startPeers
@ startPeers
Definition: InboundTransactions.cpp:36
ripple::TransactionAcquire::mMap
std::shared_ptr< SHAMap > mMap
Definition: TransactionAcquire.h:55
ripple::base_uint< 256 >
ripple::TransactionAcquire::onPeerAdded
void onPeerAdded(std::shared_ptr< Peer > const &peer) override
Hook called from addPeers().
Definition: TransactionAcquire.h:65
ripple::TransactionAcquire::onTimer
void onTimer(bool progress, ScopedLockType &peerSetLock) override
Hook called from invokeOnTimer().
Definition: TransactionAcquire.cpp:90
std::unique_lock< std::recursive_mutex >
std::enable_shared_from_this
ripple::TransactionAcquire::init
void init(int startPeers)
Definition: TransactionAcquire.cpp:253
std::weak_ptr
STL class.
ripple::TransactionAcquire::~TransactionAcquire
~TransactionAcquire()=default
ripple
Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.
Definition: RCLCensorshipDetector.h:29
ripple::TransactionAcquire::takeNodes
SHAMapAddNode takeNodes(const std::list< SHAMapNodeID > &IDs, const std::list< Blob > &data, std::shared_ptr< Peer > const &)
Definition: TransactionAcquire.cpp:177
ripple::PeerSet
Supports data retrieval by managing a set of peers.
Definition: PeerSet.h:48
ripple::TransactionAcquire::stillNeed
void stillNeed()
Definition: TransactionAcquire.cpp:263
std::size_t
ripple::TransactionAcquire::done
void done()
Definition: TransactionAcquire.cpp:61