rippled
Manager.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_NODESTORE_MANAGER_H_INCLUDED
21 #define RIPPLE_NODESTORE_MANAGER_H_INCLUDED
22 
23 #include <ripple/nodestore/DatabaseRotating.h>
24 #include <ripple/nodestore/DatabaseShard.h>
25 #include <ripple/nodestore/Factory.h>
26 
27 namespace ripple {
28 namespace NodeStore {
29 
31 class Manager
32 {
33 public:
34  virtual ~Manager() = default;
35  Manager() = default;
36  Manager(Manager const&) = delete;
37  Manager&
38  operator=(Manager const&) = delete;
39 
41  static Manager&
42  instance();
43 
45  virtual void
46  insert(Factory& factory) = 0;
47 
49  virtual void
50  erase(Factory& factory) = 0;
51 
56  virtual Factory*
57  find(std::string const& name) = 0;
58 
62  Section const& parameters,
64  Scheduler& scheduler,
65  beast::Journal journal) = 0;
66 
97  std::string const& name,
99  Scheduler& scheduler,
100  int readThreads,
101  Stoppable& parent,
102  Section const& backendParameters,
103  beast::Journal journal) = 0;
104 };
105 
106 //------------------------------------------------------------------------------
107 
111  Section const& config,
112  std::size_t burstSize,
113  Scheduler& scheduler,
114  beast::Journal journal);
115 
116 } // namespace NodeStore
117 } // namespace ripple
118 
119 #endif
ripple::Section
Holds a collection of configuration values.
Definition: BasicConfig.h:43
ripple::NodeStore::Manager
Singleton for managing NodeStore factories and back ends.
Definition: Manager.h:31
ripple::NodeStore::Factory
Base class for backend factories.
Definition: Factory.h:32
ripple::NodeStore::make_Backend
std::unique_ptr< Backend > make_Backend(Section const &config, std::size_t burstSize, Scheduler &scheduler, beast::Journal journal)
Create a Backend.
Definition: ManagerImp.cpp:127
std::string
STL class.
ripple::NodeStore::Manager::make_Database
virtual std::unique_ptr< Database > make_Database(std::string const &name, std::size_t burstSize, Scheduler &scheduler, int readThreads, Stoppable &parent, Section const &backendParameters, beast::Journal journal)=0
Construct a NodeStore database.
ripple::NodeStore::Manager::erase
virtual void erase(Factory &factory)=0
Remove a factory.
ripple::NodeStore::Manager::operator=
Manager & operator=(Manager const &)=delete
ripple::Stoppable
Provides an interface for starting and stopping.
Definition: Stoppable.h:201
ripple::NodeStore::Manager::insert
virtual void insert(Factory &factory)=0
Add a factory.
ripple::NodeStore::Manager::~Manager
virtual ~Manager()=default
beast::Journal
A generic endpoint for log messages.
Definition: Journal.h:58
ripple::SizedItem::burstSize
@ burstSize
ripple::NodeStore::Scheduler
Scheduling for asynchronous backend activity.
Definition: ripple/nodestore/Scheduler.h:60
ripple::NodeStore::Manager::find
virtual Factory * find(std::string const &name)=0
Return a pointer to the matching factory if it exists.
ripple
Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.
Definition: RCLCensorshipDetector.h:29
ripple::NodeStore::Manager::make_Backend
virtual std::unique_ptr< Backend > make_Backend(Section const &parameters, std::size_t burstSize, Scheduler &scheduler, beast::Journal journal)=0
Create a backend.
std::size_t
ripple::NodeStore::Manager::instance
static Manager & instance()
Returns the instance of the manager singleton.
Definition: ManagerImp.cpp:119
std::unique_ptr
STL class.
ripple::NodeStore::Manager::Manager
Manager()=default