openethereum/util/src/network/mod.rs

136 lines
4.2 KiB
Rust
Raw Normal View History

/// Network and general IO module.
///
/// Example usage for craeting a network service and adding an IO handler:
///
/// ```rust
/// extern crate ethcore_util as util;
2016-01-13 13:56:48 +01:00
/// use util::*;
///
/// struct MyHandler;
///
2016-01-22 00:47:45 +01:00
/// #[derive(Clone)]
2016-01-13 13:56:48 +01:00
/// struct MyMessage {
/// data: u32
/// }
///
/// impl NetworkProtocolHandler<MyMessage> for MyHandler {
2016-01-22 00:47:45 +01:00
/// fn initialize(&self, io: &NetworkContext<MyMessage>) {
/// io.register_timer(0, 1000);
/// }
///
2016-01-22 00:47:45 +01:00
/// fn read(&self, io: &NetworkContext<MyMessage>, peer: &PeerId, packet_id: u8, data: &[u8]) {
/// println!("Received {} ({} bytes) from {}", packet_id, data.len(), peer);
/// }
///
2016-01-22 00:47:45 +01:00
/// fn connected(&self, io: &NetworkContext<MyMessage>, peer: &PeerId) {
/// println!("Connected {}", peer);
/// }
///
2016-01-22 00:47:45 +01:00
/// fn disconnected(&self, io: &NetworkContext<MyMessage>, peer: &PeerId) {
/// println!("Disconnected {}", peer);
/// }
///
2016-01-22 00:47:45 +01:00
/// fn timeout(&self, io: &NetworkContext<MyMessage>, timer: TimerToken) {
/// println!("Timeout {}", timer);
/// }
///
2016-01-22 00:47:45 +01:00
/// fn message(&self, io: &NetworkContext<MyMessage>, message: &MyMessage) {
2016-01-13 13:56:48 +01:00
/// println!("Message {}", message.data);
/// }
/// }
///
/// fn main () {
2016-01-13 13:56:48 +01:00
/// let mut service = NetworkService::<MyMessage>::start().expect("Error creating network service");
2016-01-22 00:47:45 +01:00
/// service.register_protocol(Arc::new(MyHandler), "myproto", &[1u8]);
///
/// // 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;
mod node;
2015-12-17 11:42:30 +01:00
2016-01-19 17:02:01 +01:00
/// TODO [arkpar] Please document me
2016-01-21 16:48:37 +01:00
pub use network::host::PeerId;
2016-01-19 17:02:01 +01:00
/// TODO [arkpar] Please document me
2016-01-21 16:48:37 +01:00
pub use network::host::PacketId;
2016-01-19 17:02:01 +01:00
/// TODO [arkpar] Please document me
2016-01-21 16:48:37 +01:00
pub use network::host::NetworkContext;
2016-01-19 17:02:01 +01:00
/// TODO [arkpar] Please document me
2016-01-21 16:48:37 +01:00
pub use network::service::NetworkService;
/// TODO [arkpar] Please document me
2016-01-21 16:48:37 +01:00
pub use network::host::NetworkIoMessage;
2016-01-19 17:02:01 +01:00
/// TODO [arkpar] Please document me
2016-01-13 23:13:57 +01:00
pub use network::host::NetworkIoMessage::User as UserMessage;
2016-01-19 17:02:01 +01:00
/// TODO [arkpar] Please document me
2016-01-21 16:48:37 +01:00
pub use network::error::NetworkError;
2016-01-21 16:48:37 +01:00
use io::TimerToken;
2015-12-17 11:42:30 +01:00
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
2016-01-22 00:47:45 +01:00
#[test]
fn test_net_service() {
use std::sync::Arc;
struct MyHandler;
#[derive(Clone)]
struct MyMessage {
data: u32
}
impl NetworkProtocolHandler<MyMessage> for MyHandler {
fn initialize(&self, io: &NetworkContext<MyMessage>) {
io.register_timer(0, 1000).unwrap();
}
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);
}
}
let mut service = NetworkService::<MyMessage>::start().expect("Error creating network service");
service.register_protocol(Arc::new(MyHandler), "myproto", &[1u8]).unwrap();
}