openethereum/sync/src/io.rs

89 lines
2.8 KiB
Rust
Raw Normal View History

2016-02-05 13:40:41 +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/>.
2016-01-29 15:56:06 +01:00
use ethcore::client::BlockChainClient;
2016-01-13 15:10:48 +01:00
use util::{NetworkContext, PeerId, PacketId,};
2016-01-10 15:08:57 +01:00
use util::error::UtilError;
2016-01-29 15:56:06 +01:00
use ethcore::service::SyncMessage;
2016-01-10 23:37:09 +01:00
/// IO interface for the syning handler.
/// Provides peer connection management and an interface to the blockchain client.
// TODO: ratings
pub trait SyncIo {
2016-01-10 23:37:09 +01:00
/// Disable a peer
2016-01-14 19:03:48 +01:00
fn disable_peer(&mut self, peer_id: PeerId);
2016-02-02 14:54:46 +01:00
/// Disconnect peer
fn disconnect_peer(&mut self, peer_id: PeerId);
2016-01-10 23:37:09 +01:00
/// Respond to current request with a packet. Can be called from an IO handler for incoming packet.
2016-01-10 15:08:57 +01:00
fn respond(&mut self, packet_id: PacketId, data: Vec<u8>) -> Result<(), UtilError>;
2016-01-10 23:37:09 +01:00
/// Send a packet to a peer.
2016-01-10 15:08:57 +01:00
fn send(&mut self, peer_id: PeerId, packet_id: PacketId, data: Vec<u8>) -> Result<(), UtilError>;
2016-01-10 23:37:09 +01:00
/// Get the blockchain
fn chain(&self) -> &BlockChainClient;
2016-01-14 19:03:48 +01:00
/// Returns peer client identifier string
fn peer_info(&self, peer_id: PeerId) -> String {
peer_id.to_string()
}
2016-03-17 14:56:19 +01:00
/// Returns if the chain block queue empty
fn is_chain_queue_empty(&self) -> bool {
self.chain().queue_info().is_empty()
}
}
2016-01-13 15:10:48 +01:00
/// Wraps `NetworkContext` and the blockchain client
2016-01-21 16:48:37 +01:00
pub struct NetSyncIo<'s, 'h> where 'h: 's {
network: &'s NetworkContext<'h, SyncMessage>,
2016-01-21 23:33:52 +01:00
chain: &'s BlockChainClient
}
2016-01-21 16:48:37 +01:00
impl<'s, 'h> NetSyncIo<'s, 'h> {
2016-01-13 15:10:48 +01:00
/// Creates a new instance from the `NetworkContext` and the blockchain client reference.
2016-01-21 23:33:52 +01:00
pub fn new(network: &'s NetworkContext<'h, SyncMessage>, chain: &'s BlockChainClient) -> NetSyncIo<'s, 'h> {
NetSyncIo {
network: network,
chain: chain,
}
}
}
2016-01-21 16:48:37 +01:00
impl<'s, 'h> SyncIo for NetSyncIo<'s, 'h> {
2016-01-14 19:03:48 +01:00
fn disable_peer(&mut self, peer_id: PeerId) {
self.network.disable_peer(peer_id);
}
2016-02-02 14:54:46 +01:00
fn disconnect_peer(&mut self, peer_id: PeerId) {
self.network.disconnect_peer(peer_id);
}
2016-01-10 15:08:57 +01:00
fn respond(&mut self, packet_id: PacketId, data: Vec<u8>) -> Result<(), UtilError>{
self.network.respond(packet_id, data)
}
2016-01-10 15:08:57 +01:00
fn send(&mut self, peer_id: PeerId, packet_id: PacketId, data: Vec<u8>) -> Result<(), UtilError>{
self.network.send(peer_id, packet_id, data)
}
fn chain(&self) -> &BlockChainClient {
self.chain
}
2016-01-14 19:03:48 +01:00
fn peer_info(&self, peer_id: PeerId) -> String {
self.network.peer_info(peer_id)
}
}