mirror of
https://github.com/bitcoin/bitcoin.git
synced 2026-04-12 08:37:58 +02:00
6a54834895
This allows `bitcoin-cli` to connect to the node via IPC instead TCP to execute RPC methods in an upcoming commit.
82 lines
3.6 KiB
C++
82 lines
3.6 KiB
C++
// Copyright (c) 2021-present 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_INTERFACES_INIT_H
|
|
#define BITCOIN_INTERFACES_INIT_H
|
|
|
|
#include <interfaces/chain.h>
|
|
#include <interfaces/echo.h>
|
|
#include <interfaces/mining.h>
|
|
#include <interfaces/node.h>
|
|
#include <interfaces/rpc.h>
|
|
#include <interfaces/wallet.h>
|
|
|
|
#include <memory>
|
|
|
|
namespace node {
|
|
struct NodeContext;
|
|
} // namespace node
|
|
|
|
namespace interfaces {
|
|
class Ipc;
|
|
|
|
//! Initial interface created when a process is first started, and used to give
|
|
//! and get access to other interfaces (Node, Chain, Wallet, etc).
|
|
//!
|
|
//! There is a different Init interface implementation for each process
|
|
//! (bitcoin-gui, bitcoin-node, bitcoin-wallet, bitcoind, bitcoin-qt) and each
|
|
//! implementation can implement the make methods for interfaces it supports.
|
|
//! The default make methods all return null.
|
|
class Init
|
|
{
|
|
public:
|
|
virtual ~Init() = default;
|
|
virtual std::unique_ptr<Node> makeNode() { return nullptr; }
|
|
virtual std::unique_ptr<Chain> makeChain() { return nullptr; }
|
|
virtual std::unique_ptr<Mining> makeMining() { return nullptr; }
|
|
virtual std::unique_ptr<WalletLoader> makeWalletLoader(Chain& chain) { return nullptr; }
|
|
virtual std::unique_ptr<Echo> makeEcho() { return nullptr; }
|
|
virtual std::unique_ptr<Rpc> makeRpc() { return nullptr; }
|
|
virtual Ipc* ipc() { return nullptr; }
|
|
virtual bool canListenIpc() { return false; }
|
|
virtual const char* exeName() { return nullptr; }
|
|
virtual void makeMiningOld2() { throw std::runtime_error("Old mining interface (@2) not supported. Please update your client!"); }
|
|
};
|
|
|
|
//! Return implementation of Init interface for the node process. If the argv
|
|
//! indicates that this is a child process spawned to handle requests from a
|
|
//! parent process, this blocks and handles requests, then returns null and a
|
|
//! status code to exit with. If this returns non-null, the caller can start up
|
|
//! normally and use the Init object to spawn and connect to other processes
|
|
//! while it is running.
|
|
std::unique_ptr<Init> MakeNodeInit(node::NodeContext& node, int argc, char* argv[], int& exit_status);
|
|
|
|
//! Return implementation of Init interface for the wallet process.
|
|
std::unique_ptr<Init> MakeWalletInit(int argc, char* argv[], int& exit_status);
|
|
|
|
//! Return implementation of Init interface for the gui process.
|
|
std::unique_ptr<Init> MakeGuiInit(int argc, char* argv[]);
|
|
|
|
//! Return implementation of Init interface for a basic IPC client that doesn't
|
|
//! provide any IPC services itself.
|
|
//!
|
|
//! When an IPC client connects to a socket or spawns a process, it gets a pointer
|
|
//! to an Init object allowing it to create objects and threads on the remote
|
|
//! side of the IPC connection. But the client also needs to provide a local Init
|
|
//! object to allow the remote side of the connection to create objects and
|
|
//! threads on this side. This function just returns a basic Init object
|
|
//! allowing remote connections to only create local threads, not other objects
|
|
//! (because its Init::make* methods return null.)
|
|
//!
|
|
//! @param exe_name Current executable name, which is just passed to the IPC
|
|
//! system and used for logging.
|
|
//!
|
|
//! @param process_argv0 Optional string containing argv[0] value passed to
|
|
//! main(). This is passed to the IPC system and used to locate binaries by
|
|
//! relative path if subprocesses are spawned.
|
|
std::unique_ptr<Init> MakeBasicInit(const char* exe_name, const char* process_argv0="");
|
|
} // namespace interfaces
|
|
|
|
#endif // BITCOIN_INTERFACES_INIT_H
|