9d9d377fce* IPC 2.0 * Use nano::locked for confirmation subscriber vector * Remove unused local * Update toml tests, fix some const issues * Some access permission improvements * Comments and nano::locked improvements * Guilherme review feedback: formatting, advanced cmake flags, disallow deny for roles * Wesley feedback * Try to please win build on CI * Add generated file to git ignore * install api/flatbuffers/* depending on platform * correct path for api in MacOS app * add api to docker image Co-authored-by: Russel Waters <vaelstrom@gmail.com>
95 lines
2.2 KiB
C++
95 lines
2.2 KiB
C++
#pragma once
|
|
|
|
#include <nano/boost/asio/deadline_timer.hpp>
|
|
|
|
#include <string>
|
|
|
|
namespace nano
|
|
{
|
|
namespace ipc
|
|
{
|
|
/**
|
|
* The IPC framing format is simple: preamble followed by an encoding specific payload.
|
|
* Preamble is uint8_t {'N', encoding_type, reserved, reserved}. Reserved bytes MUST be zero.
|
|
* @note This is intentionally not an enum class as the values are only used as vector indices.
|
|
*/
|
|
enum preamble_offset
|
|
{
|
|
/** Always 'N' */
|
|
lead = 0,
|
|
/** One of the payload_encoding values */
|
|
encoding = 1,
|
|
/** Always zero */
|
|
reserved_1 = 2,
|
|
/** Always zero */
|
|
reserved_2 = 3,
|
|
};
|
|
|
|
/** Abstract base type for sockets, implementing timer logic and a close operation */
|
|
class socket_base
|
|
{
|
|
public:
|
|
socket_base (boost::asio::io_context & io_ctx_a);
|
|
virtual ~socket_base () = default;
|
|
|
|
/** Close socket */
|
|
virtual void close () = 0;
|
|
|
|
/**
|
|
* Start IO timer.
|
|
* @param timeout_a Seconds to wait. To wait indefinitely, use std::chrono::seconds::max ()
|
|
*/
|
|
void timer_start (std::chrono::seconds timeout_a);
|
|
void timer_expired ();
|
|
void timer_cancel ();
|
|
|
|
private:
|
|
/** IO operation timer */
|
|
boost::asio::deadline_timer io_timer;
|
|
};
|
|
|
|
/**
|
|
* Payload encodings.
|
|
*/
|
|
enum class payload_encoding : uint8_t
|
|
{
|
|
/**
|
|
* Request is preamble followed by 32-bit BE payload length and payload bytes.
|
|
* Response is 32-bit BE payload length followed by payload bytes.
|
|
*/
|
|
json_v1 = 0x1,
|
|
|
|
/** Request/response is same as json_v1, but exposes unsafe RPC's */
|
|
json_v1_unsafe = 0x2,
|
|
|
|
/**
|
|
* Request is preamble followed by 32-bit BE payload length and payload bytes.
|
|
* Response is 32-bit BE payload length followed by payload bytes.
|
|
* Payloads must be flatbuffer encoded.
|
|
*/
|
|
flatbuffers = 0x3,
|
|
|
|
/** JSON -> Flatbuffers -> JSON */
|
|
flatbuffers_json = 0x4
|
|
};
|
|
|
|
/** IPC transport interface */
|
|
class transport
|
|
{
|
|
public:
|
|
virtual void stop () = 0;
|
|
virtual ~transport () = default;
|
|
};
|
|
|
|
/** The domain socket file is attempted to be removed at both startup and shutdown. */
|
|
class dsock_file_remover final
|
|
{
|
|
public:
|
|
dsock_file_remover (std::string const & file_a);
|
|
~dsock_file_remover ();
|
|
|
|
private:
|
|
std::string filename;
|
|
};
|
|
}
|
|
}
|