openethereum/util/src/network/mod.rs

133 lines
4.3 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/>.
//! Network and general IO module.
//!
2016-02-01 15:22:42 +01:00
//! Example usage for craeting a network service and adding an IO handler:
//!
//! ```rust
//! extern crate ethcore_util as util;
//! use util::*;
//!
//! struct MyHandler;
//!
//! #[derive(Clone)]
//! struct MyMessage {
//! data: u32
//! }
//!
//! impl NetworkProtocolHandler<MyMessage> for MyHandler {
//! fn initialize(&self, io: &NetworkContext<MyMessage>) {
//! io.register_timer(0, 1000);
//! }
//!
//! fn read(&self, io: &NetworkContext<MyMessage>, peer: &PeerId, packet_id: u8, data: &[u8]) {
//! println!("Received {} ({} bytes) from {}", packet_id, data.len(), peer);
//! }
//!
//! fn connected(&self, io: &NetworkContext<MyMessage>, peer: &PeerId) {
//! println!("Connected {}", peer);
//! }
//!
//! fn disconnected(&self, io: &NetworkContext<MyMessage>, peer: &PeerId) {
//! println!("Disconnected {}", peer);
//! }
//!
//! fn timeout(&self, io: &NetworkContext<MyMessage>, timer: TimerToken) {
//! println!("Timeout {}", timer);
//! }
//!
//! fn message(&self, io: &NetworkContext<MyMessage>, message: &MyMessage) {
//! println!("Message {}", message.data);
//! }
//! }
//!
//! fn main () {
2016-06-17 18:26:54 +02:00
//! let mut service = NetworkService::<MyMessage>::new(NetworkConfiguration::new_local()).expect("Error creating network service");
2016-02-01 15:22:42 +01:00
//! service.register_protocol(Arc::new(MyHandler), "myproto", &[1u8]);
2016-06-17 18:26:54 +02:00
//! service.start().expect("Error starting service");
2016-02-01 15:22:42 +01:00
//!
//! // Wait for quit condition
//! // ...
//! // Drop the service
//! }
//! ```
2015-12-02 12:07:46 +01:00
mod host;
mod connection;
mod handshake;
mod session;
mod discovery;
2015-12-17 11:42:30 +01:00
mod service;
mod error;
2016-02-12 09:52:32 +01:00
mod node_table;
2016-01-24 18:53:54 +01:00
mod stats;
2016-02-16 02:05:36 +01:00
mod ip_utils;
2016-01-24 18:53:54 +01:00
#[cfg(test)]
mod tests;
2015-12-17 11:42:30 +01:00
2016-01-21 16:48:37 +01:00
pub use network::host::PeerId;
pub use network::host::PacketId;
pub use network::host::NetworkContext;
pub use network::service::NetworkService;
pub use network::host::NetworkIoMessage;
2016-01-13 23:13:57 +01:00
pub use network::host::NetworkIoMessage::User as UserMessage;
2016-01-21 16:48:37 +01:00
pub use network::error::NetworkError;
2016-01-23 02:36:58 +01:00
pub use network::host::NetworkConfiguration;
2016-01-24 18:53:54 +01:00
pub use network::stats::NetworkStats;
2016-01-21 16:48:37 +01:00
use io::TimerToken;
2016-02-19 14:13:20 +01:00
pub use network::node_table::is_valid_node_url;
2015-12-17 11:42:30 +01:00
2016-02-13 22:57:39 +01:00
const PROTOCOL_VERSION: u32 = 4;
2015-12-30 12:23:36 +01:00
/// Network IO protocol handler. This needs to be implemented for each new subprotocol.
/// All the handler function are called from within IO event loop.
/// `Message` is the type for message data.
2016-01-21 16:48:37 +01:00
pub trait NetworkProtocolHandler<Message>: Sync + Send where Message: Send + Sync + Clone {
2016-01-13 13:56:48 +01:00
/// Initialize the handler
2016-01-21 16:48:37 +01:00
fn initialize(&self, _io: &NetworkContext<Message>) {}
2015-12-30 12:23:36 +01:00
/// Called when new network packet received.
2016-01-21 16:48:37 +01:00
fn read(&self, io: &NetworkContext<Message>, peer: &PeerId, packet_id: u8, data: &[u8]);
2015-12-30 12:23:36 +01:00
/// Called when new peer is connected. Only called when peer supports the same protocol.
2016-01-21 16:48:37 +01:00
fn connected(&self, io: &NetworkContext<Message>, peer: &PeerId);
2015-12-30 12:23:36 +01:00
/// Called when a previously connected peer disconnects.
2016-01-21 16:48:37 +01:00
fn disconnected(&self, io: &NetworkContext<Message>, peer: &PeerId);
/// Timer function called after a timeout created with `NetworkContext::timeout`.
2016-01-21 16:48:37 +01:00
fn timeout(&self, _io: &NetworkContext<Message>, _timer: TimerToken) {}
/// Called when a broadcasted message is received. The message can only be sent from a different IO handler.
2016-01-21 16:48:37 +01:00
fn message(&self, _io: &NetworkContext<Message>, _message: &Message) {}
2015-12-02 12:07:46 +01:00
}
2015-12-17 11:42:30 +01:00
/// Non-reserved peer modes.
#[derive(Clone, Debug, PartialEq, Eq)]
pub enum NonReservedPeerMode {
/// Accept them. This is the default.
Accept,
/// Deny them.
Deny,
}
impl NonReservedPeerMode {
/// Attempt to parse the peer mode from a string.
pub fn parse(s: &str) -> Option<Self> {
match s {
"accept" => Some(NonReservedPeerMode::Accept),
"deny" => Some(NonReservedPeerMode::Deny),
_ => None,
}
}
}