1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
|
//! # License
//!
//! Copyright (C) 2017 Amagicom AB
//!
//! This program is free software: you can redistribute it and/or modify it under the terms of the
//! GNU General Public License as published by the Free Software Foundation, either version 3 of
//! the License, or (at your option) any later version.
#![deny(rust_2018_idioms)]
use futures::Future;
use std::{io, thread};
use jsonrpc_core::{MetaIoHandler, Metadata};
use jsonrpc_ipc_server::{MetaExtractor, NoopExtractor, SecurityAttributes, Server, ServerBuilder};
use std::fmt;
/// An Id created by the Ipc server that the client can use to connect to it
pub type IpcServerId = String;
#[derive(err_derive::Error, Debug)]
pub enum Error {
#[error(display = "Unable to start IPC server")]
StartServerError(#[error(cause)] io::Error),
#[error(display = "IPC server thread panicked and never returned a start result")]
ServerThreadPanicError,
#[error(display = "Error in IPC server")]
IpcServerError(#[error(cause)] io::Error),
#[error(display = "Unable to set permissions for IPC endpoint")]
PermissionsError(#[error(cause)] io::Error),
}
pub struct IpcServer {
path: String,
server: Server,
}
impl IpcServer {
pub fn start<M: Metadata + Default>(
handler: MetaIoHandler<M>,
path: &str,
) -> Result<Self, Error> {
Self::start_with_metadata(handler, NoopExtractor, path)
}
pub fn start_with_metadata<M, E>(
handler: MetaIoHandler<M>,
meta_extractor: E,
path: &str,
) -> Result<Self, Error>
where
M: Metadata + Default,
E: MetaExtractor<M>,
{
let security_attributes =
SecurityAttributes::allow_everyone_create().map_err(Error::PermissionsError)?;
let server = ServerBuilder::with_meta_extractor(handler, meta_extractor)
.set_security_attributes(security_attributes)
.start(path)
.map_err(Error::StartServerError)
.and_then(|(fut, start, server)| {
thread::spawn(move || tokio::run(fut));
if let Some(error) = start
.wait()
.map_err(|_cancelled| Error::ServerThreadPanicError)?
{
return Err(Error::IpcServerError(error));
}
Ok(server)
})
.map(|server| IpcServer {
path: path.to_owned(),
server,
})?;
#[cfg(unix)]
{
use std::{fs, os::unix::fs::PermissionsExt};
fs::set_permissions(&path, PermissionsExt::from_mode(0o766))
.map_err(Error::PermissionsError)?;
}
Ok(server)
}
/// Returns the uds/named pipe path this `IpcServer` is listening on.
pub fn path(&self) -> &str {
&self.path
}
/// Creates a handle bound to this `IpcServer` that can be used to shut it down.
pub fn close_handle(&self) -> CloseHandle {
CloseHandle(self.server.close_handle())
}
/// Consumes the server and waits for it to finish. Get a `CloseHandle` before calling this
/// if you want to be able to shut the server down.
pub fn wait(self) {
self.server.wait();
}
}
// FIXME: This custom impl is because `Server` does not implement `Debug` yet:
// https://github.com/paritytech/jsonrpc/pull/195
impl fmt::Debug for IpcServer {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.debug_struct("IpcServer")
.field("path", &self.path)
.finish()
}
}
#[derive(Clone)]
pub struct CloseHandle(jsonrpc_ipc_server::CloseHandle);
impl CloseHandle {
pub fn close(self) {
self.0.close();
}
}
|
