136 lines
4.2 KiB
Rust
136 lines
4.2 KiB
Rust
/// Network and general IO module.
|
|
///
|
|
/// 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 () {
|
|
/// let mut service = NetworkService::<MyMessage>::start().expect("Error creating network service");
|
|
/// service.register_protocol(Arc::new(MyHandler), "myproto", &[1u8]);
|
|
///
|
|
/// // Wait for quit condition
|
|
/// // ...
|
|
/// // Drop the service
|
|
/// }
|
|
/// ```
|
|
mod host;
|
|
mod connection;
|
|
mod handshake;
|
|
mod session;
|
|
mod discovery;
|
|
mod service;
|
|
mod error;
|
|
mod node;
|
|
|
|
/// TODO [arkpar] Please document me
|
|
pub use network::host::PeerId;
|
|
/// TODO [arkpar] Please document me
|
|
pub use network::host::PacketId;
|
|
/// TODO [arkpar] Please document me
|
|
pub use network::host::NetworkContext;
|
|
/// TODO [arkpar] Please document me
|
|
pub use network::service::NetworkService;
|
|
/// TODO [arkpar] Please document me
|
|
pub use network::host::NetworkIoMessage;
|
|
/// TODO [arkpar] Please document me
|
|
pub use network::host::NetworkIoMessage::User as UserMessage;
|
|
/// TODO [arkpar] Please document me
|
|
pub use network::error::NetworkError;
|
|
|
|
use io::TimerToken;
|
|
|
|
/// 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.
|
|
pub trait NetworkProtocolHandler<Message>: Sync + Send where Message: Send + Sync + Clone {
|
|
/// Initialize the handler
|
|
fn initialize(&self, _io: &NetworkContext<Message>) {}
|
|
/// Called when new network packet received.
|
|
fn read(&self, io: &NetworkContext<Message>, peer: &PeerId, packet_id: u8, data: &[u8]);
|
|
/// Called when new peer is connected. Only called when peer supports the same protocol.
|
|
fn connected(&self, io: &NetworkContext<Message>, peer: &PeerId);
|
|
/// Called when a previously connected peer disconnects.
|
|
fn disconnected(&self, io: &NetworkContext<Message>, peer: &PeerId);
|
|
/// Timer function called after a timeout created with `NetworkContext::timeout`.
|
|
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.
|
|
fn message(&self, _io: &NetworkContext<Message>, _message: &Message) {}
|
|
}
|
|
|
|
|
|
#[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();
|
|
}
|