Bitcoin Core 31.99.0
P2P Digital Currency
ipc.h
Go to the documentation of this file.
1// Copyright (c) 2021-present The Bitcoin Core developers
2// Distributed under the MIT software license, see the accompanying
3// file COPYING or http://www.opensource.org/licenses/mit-license.php.
4
5#ifndef BITCOIN_INTERFACES_IPC_H
6#define BITCOIN_INTERFACES_IPC_H
7
8#include <functional>
9#include <memory>
10#include <string>
11#include <typeindex>
12
13namespace ipc {
14struct Context;
15} // namespace ipc
16
17namespace interfaces {
18class Init;
19
50class Ipc
51{
52public:
53 virtual ~Ipc() = default;
54
56 virtual std::unique_ptr<Init> spawnProcess(const char* exe_name) = 0;
57
61 virtual bool startSpawnedProcess(int argc, char* argv[], int& exit_status) = 0;
62
68 virtual std::unique_ptr<Init> connectAddress(std::string& address) = 0;
69
72 virtual void listenAddress(std::string& address) = 0;
73
75 virtual void disconnectIncoming() = 0;
76
79 template<typename Interface>
80 void addCleanup(Interface& iface, std::function<void()> cleanup)
81 {
82 addCleanup(typeid(Interface), &iface, std::move(cleanup));
83 }
84
86 virtual ipc::Context& context() = 0;
87
88protected:
91 virtual void addCleanup(std::type_index type, void* iface, std::function<void()> cleanup) = 0;
92};
93
95std::unique_ptr<Ipc> MakeIpc(const char* exe_name, const char* process_argv0, Init& init);
96} // namespace interfaces
97
98#endif // BITCOIN_INTERFACES_IPC_H
int exit_status
Definition: init.h:13
Initial interface created when a process is first started, and used to give and get access to other i...
Definition: init.h:32
Interface providing access to interprocess-communication (IPC) functionality.
Definition: ipc.h:51
virtual ipc::Context & context()=0
IPC context struct accessor (see struct definition for more description).
virtual std::unique_ptr< Init > spawnProcess(const char *exe_name)=0
Spawn a child process returning pointer to its Init interface.
virtual void listenAddress(std::string &address)=0
Listen on a socket address exposing this process's init interface to clients.
virtual void disconnectIncoming()=0
Disconnect any incoming connections that are still connected.
virtual bool startSpawnedProcess(int argc, char *argv[], int &exit_status)=0
If this is a spawned process, block and handle requests from the parent process by forwarding them to...
virtual ~Ipc()=default
virtual void addCleanup(std::type_index type, void *iface, std::function< void()> cleanup)=0
Internal implementation of public addCleanup method (above) as a type-erased virtual function,...
void addCleanup(Interface &iface, std::function< void()> cleanup)
Add cleanup callback to remote interface that will run when the interface is deleted.
Definition: ipc.h:80
virtual std::unique_ptr< Init > connectAddress(std::string &address)=0
Connect to a socket address and return a pointer to its Init interface.
Definition: basic.cpp:8
std::unique_ptr< Ipc > MakeIpc(const char *exe_name, const char *process_argv0, Init &init)
Return implementation of Ipc interface.
Definition: interfaces.cpp:135
Definition: ipc.h:13
Context struct used to give IPC protocol implementations or implementation hooks access to applicatio...
Definition: context.h:15