openethereum/ipc/rpc/src/interface.rs

63 lines
2.0 KiB
Rust
Raw Normal View History

2016-03-24 22:07:01 +01:00
// Copyright 2015, 2016 Ethcore (UK) Ltd.
// 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;
use std::sync::atomic::*;
2016-03-24 22:07:01 +01:00
pub trait IpcInterface<T> {
/// reads the message from io, dispatches the call and returns 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
/// deserialize the payload from the io `r` and invokes method specified by `method_num`
/// (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());
}
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-03-30 17:25:31 +02:00
/// IpcSocket
pub trait IpcSocket: Read + Write + Sync {
fn ready(&self) -> AtomicBool;
}
impl IpcSocket for ::devtools::TestSocket {
2016-03-30 17:25:31 +02:00
fn ready(&self) -> AtomicBool {
AtomicBool::new(true)
}
2016-03-24 22:07:01 +01:00
}