rippled
NodeStoreScheduler.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_MAIN_NODESTORESCHEDULER_H_INCLUDED
21 #define RIPPLE_APP_MAIN_NODESTORESCHEDULER_H_INCLUDED
22 
23 #include <ripple/nodestore/Scheduler.h>
24 #include <ripple/core/JobQueue.h>
25 #include <ripple/core/Stoppable.h>
26 #include <atomic>
27 
28 namespace ripple {
29 
32  : public NodeStore::Scheduler
33  , public Stoppable
34 {
35 public:
36  NodeStoreScheduler (Stoppable& parent);
37 
38  // VFALCO NOTE This is a temporary hack to solve the problem
39  // of circular dependency.
40  //
41  void setJobQueue (JobQueue& jobQueue);
42 
43  void onStop () override;
44  void onChildrenStopped () override;
45  void scheduleTask (NodeStore::Task& task) override;
46  void onFetch (NodeStore::FetchReport const& report) override;
47  void onBatchWrite (NodeStore::BatchWriteReport const& report) override;
48 
49 private:
50  void doTask (NodeStore::Task& task);
51 
52  JobQueue* m_jobQueue {nullptr};
54 };
55 
56 } // ripple
57 
58 #endif
ripple::NodeStoreScheduler
A NodeStore::Scheduler which uses the JobQueue and implements the Stoppable API.
Definition: NodeStoreScheduler.h:31
ripple::NodeStoreScheduler::scheduleTask
void scheduleTask(NodeStore::Task &task) override
Schedules a task.
Definition: NodeStoreScheduler.cpp:45
ripple::NodeStoreScheduler::onFetch
void onFetch(NodeStore::FetchReport const &report) override
Reports completion of a fetch Allows the scheduler to monitor the node store's performance.
Definition: NodeStoreScheduler.cpp:74
ripple::NodeStoreScheduler::onBatchWrite
void onBatchWrite(NodeStore::BatchWriteReport const &report) override
Reports the completion of a batch write Allows the scheduler to monitor the node store's performance.
Definition: NodeStoreScheduler.cpp:82
ripple::NodeStoreScheduler::NodeStoreScheduler
NodeStoreScheduler(Stoppable &parent)
Definition: NodeStoreScheduler.cpp:25
ripple::NodeStore::FetchReport
Contains information about a fetch operation.
Definition: ripple/nodestore/Scheduler.h:30
ripple::NodeStoreScheduler::doTask
void doTask(NodeStore::Task &task)
Definition: NodeStoreScheduler.cpp:59
ripple::NodeStoreScheduler::onStop
void onStop() override
Override called when the stop notification is issued.
Definition: NodeStoreScheduler.cpp:35
ripple::NodeStoreScheduler::m_jobQueue
JobQueue * m_jobQueue
Definition: NodeStoreScheduler.h:52
ripple::Stoppable
Provides an interface for starting and stopping.
Definition: Stoppable.h:200
ripple::NodeStore::Task
Derived classes perform scheduled tasks.
Definition: Task.h:27
atomic
ripple::NodeStore::Scheduler
Scheduling for asynchronous backend activity.
Definition: ripple/nodestore/Scheduler.h:57
ripple::NodeStore::BatchWriteReport
Contains information about a batch write operation.
Definition: ripple/nodestore/Scheduler.h:41
ripple::JobQueue
A pool of threads to perform work.
Definition: JobQueue.h:56
ripple::NodeStoreScheduler::setJobQueue
void setJobQueue(JobQueue &jobQueue)
Definition: NodeStoreScheduler.cpp:30
ripple::NodeStoreScheduler::onChildrenStopped
void onChildrenStopped() override
Override called when all children have stopped.
Definition: NodeStoreScheduler.cpp:39
ripple
Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.
Definition: RCLCensorshipDetector.h:29
ripple::NodeStoreScheduler::m_taskCount
std::atomic< int > m_taskCount
Definition: NodeStoreScheduler.h:53