openethereum/util/src/io/mod.rs

130 lines
4.0 KiB
Rust
Raw Normal View History

2016-01-12 17:33:40 +01:00
/// General IO module.
///
/// Example usage for craeting a network service and adding an IO handler:
///
/// ```rust
2016-01-13 13:56:48 +01:00
/// extern crate ethcore_util;
/// use ethcore_util::*;
2016-01-12 17:33:40 +01:00
///
/// struct MyHandler;
///
2016-01-22 00:47:45 +01:00
/// #[derive(Clone)]
2016-01-13 13:56:48 +01:00
/// struct MyMessage {
/// data: u32
/// }
2016-01-12 17:33:40 +01:00
///
2016-01-13 13:56:48 +01:00
/// impl IoHandler<MyMessage> for MyHandler {
2016-01-22 00:47:45 +01:00
/// fn initialize(&self, io: &IoContext<MyMessage>) {
/// io.register_timer(0, 1000).unwrap();
2016-01-12 17:33:40 +01:00
/// }
///
2016-01-22 00:47:45 +01:00
/// fn timeout(&self, _io: &IoContext<MyMessage>, timer: TimerToken) {
2016-01-12 17:33:40 +01:00
/// println!("Timeout {}", timer);
/// }
///
2016-01-22 00:47:45 +01:00
/// fn message(&self, _io: &IoContext<MyMessage>, message: &MyMessage) {
2016-01-13 13:56:48 +01:00
/// println!("Message {}", message.data);
2016-01-12 17:33:40 +01:00
/// }
2016-01-13 13:56:48 +01:00
/// }
2016-01-12 17:33:40 +01:00
///
/// fn main () {
2016-01-13 13:56:48 +01:00
/// let mut service = IoService::<MyMessage>::start().expect("Error creating network service");
2016-01-22 00:47:45 +01:00
/// service.register_handler(Arc::new(MyHandler)).unwrap();
2016-01-12 17:33:40 +01:00
///
/// // Wait for quit condition
/// // ...
/// // Drop the service
/// }
/// ```
mod service;
2016-01-21 16:48:37 +01:00
mod worker;
use mio::{EventLoop, Token};
2016-01-12 17:33:40 +01:00
#[derive(Debug)]
2016-01-19 17:02:01 +01:00
/// TODO [arkpar] Please document me
2016-01-12 17:33:40 +01:00
pub enum IoError {
2016-01-19 17:02:01 +01:00
/// TODO [arkpar] Please document me
2016-01-12 17:33:40 +01:00
Mio(::std::io::Error),
}
2016-01-21 16:48:37 +01:00
impl<Message> From<::mio::NotifyError<service::IoMessage<Message>>> for IoError where Message: Send + Clone {
2016-01-13 13:56:48 +01:00
fn from(_err: ::mio::NotifyError<service::IoMessage<Message>>) -> IoError {
2016-01-12 17:33:40 +01:00
IoError::Mio(::std::io::Error::new(::std::io::ErrorKind::ConnectionAborted, "Network IO notification error"))
}
}
/// Generic IO handler.
/// All the handler function are called from within IO event loop.
/// `Message` type is used as notification data
2016-01-21 16:48:37 +01:00
pub trait IoHandler<Message>: Send + Sync where Message: Send + Sync + Clone + 'static {
/// Initialize the handler
2016-01-21 16:48:37 +01:00
fn initialize(&self, _io: &IoContext<Message>) {}
/// Timer function called after a timeout created with `HandlerIo::timeout`.
2016-01-21 16:48:37 +01:00
fn timeout(&self, _io: &IoContext<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: &IoContext<Message>, _message: &Message) {}
/// Called when an IO stream gets closed
2016-01-21 16:48:37 +01:00
fn stream_hup(&self, _io: &IoContext<Message>, _stream: StreamToken) {}
/// Called when an IO stream can be read from
2016-01-21 16:48:37 +01:00
fn stream_readable(&self, _io: &IoContext<Message>, _stream: StreamToken) {}
/// Called when an IO stream can be written to
2016-01-21 16:48:37 +01:00
fn stream_writable(&self, _io: &IoContext<Message>, _stream: StreamToken) {}
/// Register a new stream with the event loop
fn register_stream(&self, _stream: StreamToken, _reg: Token, _event_loop: &mut EventLoop<IoManager<Message>>) {}
/// Re-register a stream with the event loop
fn update_stream(&self, _stream: StreamToken, _reg: Token, _event_loop: &mut EventLoop<IoManager<Message>>) {}
2016-01-22 18:13:59 +01:00
/// Deregister a stream. Called whenstream is removed from event loop
fn deregister_stream(&self, _stream: StreamToken, _event_loop: &mut EventLoop<IoManager<Message>>) {}
}
2016-01-19 17:02:01 +01:00
/// TODO [arkpar] Please document me
pub use io::service::TimerToken;
/// TODO [arkpar] Please document me
pub use io::service::StreamToken;
/// TODO [arkpar] Please document me
2016-01-21 16:48:37 +01:00
pub use io::service::IoContext;
2016-01-19 17:02:01 +01:00
/// TODO [arkpar] Please document me
pub use io::service::IoService;
2016-01-19 17:02:01 +01:00
/// TODO [arkpar] Please document me
pub use io::service::IoChannel;
2016-01-19 17:02:01 +01:00
/// TODO [arkpar] Please document me
pub use io::service::IoManager;
2016-01-19 17:02:01 +01:00
/// TODO [arkpar] Please document me
pub use io::service::TOKENS_PER_HANDLER;
2016-01-12 17:33:40 +01:00
2016-01-13 13:56:48 +01:00
#[cfg(test)]
mod tests {
2016-01-22 00:47:45 +01:00
use std::sync::Arc;
2016-01-13 13:56:48 +01:00
use io::*;
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 IoHandler<MyMessage> for MyHandler {
2016-01-22 00:47:45 +01:00
fn initialize(&self, io: &IoContext<MyMessage>) {
io.register_timer(0, 1000).unwrap();
2016-01-13 13:56:48 +01:00
}
2016-01-22 00:47:45 +01:00
fn timeout(&self, _io: &IoContext<MyMessage>, timer: TimerToken) {
2016-01-13 13:56:48 +01:00
println!("Timeout {}", timer);
}
2016-01-22 00:47:45 +01:00
fn message(&self, _io: &IoContext<MyMessage>, message: &MyMessage) {
2016-01-13 13:56:48 +01:00
println!("Message {}", message.data);
}
}
#[test]
fn test_service_register_handler () {
let mut service = IoService::<MyMessage>::start().expect("Error creating network service");
2016-01-22 00:47:45 +01:00
service.register_handler(Arc::new(MyHandler)).unwrap();
2016-01-13 13:56:48 +01:00
}
}