2017-04-17 19:55:43 +02:00
|
|
|
// Copyright (c) 2018 The Bitcoin Core developers
|
|
|
|
// Distributed under the MIT software license, see the accompanying
|
|
|
|
// file COPYING or http://www.opensource.org/licenses/mit-license.php.
|
|
|
|
|
|
|
|
#ifndef BITCOIN_INTERFACE_NODE_H
|
|
|
|
#define BITCOIN_INTERFACE_NODE_H
|
|
|
|
|
2017-04-17 20:23:14 +02:00
|
|
|
#include <netaddress.h> // For Network
|
|
|
|
|
2017-04-17 19:55:43 +02:00
|
|
|
#include <functional>
|
|
|
|
#include <memory>
|
|
|
|
#include <string>
|
|
|
|
|
2017-04-17 20:23:14 +02:00
|
|
|
class proxyType;
|
|
|
|
|
2017-04-17 19:55:43 +02:00
|
|
|
namespace interface {
|
|
|
|
|
|
|
|
class Handler;
|
|
|
|
|
|
|
|
//! Top-level interface for a bitcoin node (bitcoind process).
|
|
|
|
class Node
|
|
|
|
{
|
|
|
|
public:
|
|
|
|
virtual ~Node() {}
|
|
|
|
|
|
|
|
//! Set command line arguments.
|
|
|
|
virtual void parseParameters(int argc, const char* const argv[]) = 0;
|
|
|
|
|
2017-04-17 20:23:14 +02:00
|
|
|
//! Set a command line argument if it doesn't already have a value
|
|
|
|
virtual bool softSetArg(const std::string& arg, const std::string& value) = 0;
|
|
|
|
|
|
|
|
//! Set a command line boolean argument if it doesn't already have a value
|
|
|
|
virtual bool softSetBoolArg(const std::string& arg, bool value) = 0;
|
|
|
|
|
2017-04-17 19:55:43 +02:00
|
|
|
//! Load settings from configuration file.
|
|
|
|
virtual void readConfigFile(const std::string& conf_path) = 0;
|
|
|
|
|
|
|
|
//! Choose network parameters.
|
|
|
|
virtual void selectParams(const std::string& network) = 0;
|
|
|
|
|
|
|
|
//! Init logging.
|
|
|
|
virtual void initLogging() = 0;
|
|
|
|
|
|
|
|
//! Init parameter interaction.
|
|
|
|
virtual void initParameterInteraction() = 0;
|
|
|
|
|
|
|
|
//! Get warnings.
|
|
|
|
virtual std::string getWarnings(const std::string& type) = 0;
|
|
|
|
|
|
|
|
//! Initialize app dependencies.
|
|
|
|
virtual bool baseInitialize() = 0;
|
|
|
|
|
|
|
|
//! Start node.
|
|
|
|
virtual bool appInitMain() = 0;
|
|
|
|
|
|
|
|
//! Stop node.
|
|
|
|
virtual void appShutdown() = 0;
|
|
|
|
|
|
|
|
//! Start shutdown.
|
|
|
|
virtual void startShutdown() = 0;
|
|
|
|
|
2017-04-17 20:23:14 +02:00
|
|
|
//! Map port.
|
|
|
|
virtual void mapPort(bool use_upnp) = 0;
|
|
|
|
|
|
|
|
//! Get proxy.
|
|
|
|
virtual bool getProxy(Network net, proxyType& proxy_info) = 0;
|
|
|
|
|
2017-04-17 19:55:43 +02:00
|
|
|
//! Register handler for init messages.
|
|
|
|
using InitMessageFn = std::function<void(const std::string& message)>;
|
|
|
|
virtual std::unique_ptr<Handler> handleInitMessage(InitMessageFn fn) = 0;
|
|
|
|
};
|
|
|
|
|
|
|
|
//! Return implementation of Node interface.
|
|
|
|
std::unique_ptr<Node> MakeNode();
|
|
|
|
|
|
|
|
} // namespace interface
|
|
|
|
|
|
|
|
#endif // BITCOIN_INTERFACE_NODE_H
|