openethereum/ipc/rpc/src/interface.rs

107 lines
3.2 KiB
Rust
Raw Normal View History

// Copyright 2015-2017 Parity Technologies (UK) Ltd.
2016-03-24 22:07:01 +01:00
// This file is part of Parity.
// Parity 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.
// Parity is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
// You should have received a copy of the GNU General Public License
// along with Parity. If not, see <http://www.gnu.org/licenses/>.
//! IPC RPC interface
2016-03-30 17:25:31 +02:00
use std::io::{Read, Write};
use std::marker::Sync;
2016-04-07 22:18:48 +02:00
use semver::Version;
2016-03-30 17:25:31 +02:00
2016-07-12 10:33:20 +02:00
#[derive(Debug, PartialEq, Eq, Clone)]
2016-04-12 10:53:41 +02:00
/// Handshake for client and server to negotiate api/protocol version
2016-04-07 22:18:48 +02:00
pub struct Handshake {
2016-04-08 13:07:25 +02:00
pub protocol_version: Version,
pub api_version: Version,
2016-04-07 22:18:48 +02:00
}
2016-04-12 10:53:41 +02:00
/// Allows to configure custom version and custom handshake response for
/// ipc host
pub trait IpcConfig {
2016-04-12 10:53:41 +02:00
/// Current service api version
/// Should be increased if any of the methods changes signature
2016-04-07 22:18:48 +02:00
fn api_version() -> Version {
Version::parse("1.0.0").unwrap()
}
2016-04-12 12:05:13 +02:00
2016-04-12 10:53:41 +02:00
/// Current ipc protocol version
/// Should be increased only if signature of system methods changes
2016-04-07 22:18:48 +02:00
fn protocol_version() -> Version {
Version::parse("1.0.0").unwrap()
}
2016-04-12 12:05:13 +02:00
2016-04-12 10:53:41 +02:00
/// Default handshake requires exact versions match
2016-04-08 13:07:25 +02:00
fn handshake(handshake: &Handshake) -> bool {
handshake.protocol_version == Self::protocol_version() &&
handshake.api_version == Self::api_version()
}
}
2016-04-12 10:53:41 +02:00
/// Error in dispatching or invoking methods via IPC
2016-04-12 06:13:31 +02:00
#[derive(Debug)]
2016-04-08 13:07:25 +02:00
pub enum Error {
UnkownSystemCall,
ClientUnsupported,
2016-04-12 06:13:31 +02:00
RemoteServiceUnsupported,
HandshakeFailed,
2016-04-07 22:18:48 +02:00
}
2016-04-12 10:53:41 +02:00
/// Allows implementor to be attached to generic worker and dispatch rpc requests
/// over IPC
pub trait IpcInterface : IpcConfig {
2016-04-05 11:35:45 +02:00
/// reads the message from io, dispatches the call and returns serialized result
2016-03-30 17:25:31 +02:00
fn dispatch<R>(&self, r: &mut R) -> Vec<u8> where R: Read;
2016-04-03 22:39:49 +02:00
2016-04-08 13:07:25 +02:00
/// deserializes the payload from buffer, dispatches invoke and returns serialized result
2016-04-03 22:39:49 +02:00
/// (for non-blocking io)
2016-04-05 11:08:42 +02:00
fn dispatch_buf(&self, method_num: u16, buf: &[u8]) -> Vec<u8>;
}
2016-03-30 17:25:31 +02:00
/// serializes method invocation (method_num and parameters) to the stream specified by `w`
pub fn invoke<W>(method_num: u16, params: &Option<Vec<u8>>, w: &mut W) where W: Write {
// creating buffer to contain all message
let buf_len = match *params { None => 2, Some(ref val) => val.len() + 2 };
let mut buf = vec![0u8; buf_len];
2016-03-30 17:25:31 +02:00
// writing method_num as u16
2016-03-30 01:21:47 +02:00
buf[1] = (method_num & 255) as u8;
buf[0] = (method_num >> 8) as u8;
2016-03-30 17:25:31 +02:00
// serializing parameters only if provided with any
if params.is_some() {
buf[2..buf_len].clone_from_slice(params.as_ref().unwrap());
}
2016-04-12 10:34:56 +02:00
if w.write(&buf).unwrap() != buf_len
{
2016-03-30 17:25:31 +02:00
// if write was inconsistent
panic!("failed to write to socket");
}
}
2016-04-12 10:53:41 +02:00
/// IpcSocket, read/write generalization
pub trait IpcSocket: Read + Write + Sync + Send {
}
2016-04-12 10:53:41 +02:00
/// Basically something that needs only socket to be spawned
2016-04-12 09:18:39 +02:00
pub trait WithSocket<S: IpcSocket> {
fn init(socket: S) -> Self;
2016-03-24 22:07:01 +01:00
}
2016-04-12 09:18:39 +02:00
impl IpcSocket for ::devtools::TestSocket {}
impl IpcSocket for ::nanomsg::Socket {}