      1
      2
      3
      4
      5
      6
      7
      8
      9
     10
     11
     12
     13
     14
     15
     16
     17
     18
     19
     20
     21
     22
     23
     24
     25
     26
     27
     28
     29
     30
     31
     32
     33
     34
     35
     36
     37
     38
     39
     40
     41
     42
     43
     44
     45
     46
     47
     48
     49
     50
     51
     52
     53
     54
     55
     56
     57
     58
     59
     60
     61
     62
     63
     64
     65
     66
     67
     68
     69
     70
     71
     72
     73
     74
     75
     76
     77
     78
     79
     80
     81
     82
     83
     84
     85
     86
     87
     88
     89
     90
     91
     92
     93
     94
     95
     96
     97
     98
     99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    141
    142
    143
    144
    145
    146
    147
    148
    149
    150
    151
    152
    153
    154
    155
    156
    157
    158
    159
    160
    161
    162
    163
    164
    165
    166
    167
    168
    169
    170
    171
    172

    // Copyright 2015-2017 Parity Technologies (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/>.

    //! General IO module.
    //!
    //! Example usage for creating a network service and adding an IO handler:
    //!
    //! ```rust
    //! extern crate ethcore_io;
    //! use ethcore_io::*;
    //! use std::sync::Arc;
    //!
    //! struct MyHandler;
    //!
    //! #[derive(Clone)]
    //! struct MyMessage {
    //! 	data: u32
    //! }
    //!
    //! impl IoHandler<MyMessage> for MyHandler {
    //! 	fn initialize(&self, io: &IoContext<MyMessage>) {
    //!			io.register_timer(0, 1000).unwrap();
    //!		}
    //!
    //!		fn timeout(&self, _io: &IoContext<MyMessage>, timer: TimerToken) {
    //!			println!("Timeout {}", timer);
    //!		}
    //!
    //!		fn message(&self, _io: &IoContext<MyMessage>, message: &MyMessage) {
    //!			println!("Message {}", message.data);
    //!		}
    //! }
    //!
    //! fn main () {
    //! 	let mut service = IoService::<MyMessage>::start().expect("Error creating network service");
    //! 	service.register_handler(Arc::new(MyHandler)).unwrap();
    //!
    //! 	// Wait for quit condition
    //! 	// ...
    //! 	// Drop the service
    //! }
    //! ```

    extern crate mio;
    #[macro_use]
    extern crate log as rlog;
    extern crate slab;
    extern crate crossbeam;
    extern crate parking_lot;

    mod service;
    mod worker;
    mod panics;

    use mio::{Token};
    use mio::deprecated::{EventLoop, NotifyError};
    use std::fmt;

    pub use worker::LOCAL_STACK_SIZE;

    #[derive(Debug)]
    /// IO Error
    pub enum IoError {
    	/// Low level error from mio crate
    	Mio(::std::io::Error),
    	/// Error concerning the Rust standard library's IO subsystem.
    	StdIo(::std::io::Error),
    }

    impl fmt::Display for IoError {
    	fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
    		// just defer to the std implementation for now.
    		// we can refine the formatting when more variants are added.
    		match *self {
    			IoError::Mio(ref std_err) => std_err.fmt(f),
    			IoError::StdIo(ref std_err) => std_err.fmt(f),
    		}
    	}
    }

    impl From<::std::io::Error> for IoError {
    	fn from(err: ::std::io::Error) -> IoError {
    		IoError::StdIo(err)
    	}
    }

    impl<Message> From<NotifyError<service::IoMessage<Message>>> for IoError where Message: Send + Clone {
    	fn from(_err: NotifyError<service::IoMessage<Message>>) -> IoError {
    		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
    pub trait IoHandler<Message>: Send + Sync where Message: Send + Sync + Clone + 'static {
    	/// Initialize the handler
    	fn initialize(&self, _io: &IoContext<Message>) {}
    	/// Timer function called after a timeout created with `HandlerIo::timeout`.
    	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.
    	fn message(&self, _io: &IoContext<Message>, _message: &Message) {}
    	/// Called when an IO stream gets closed
    	fn stream_hup(&self, _io: &IoContext<Message>, _stream: StreamToken) {}
    	/// Called when an IO stream can be read from
    	fn stream_readable(&self, _io: &IoContext<Message>, _stream: StreamToken) {}
    	/// Called when an IO stream can be written to
    	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>>) {}
    	/// Deregister a stream. Called whenstream is removed from event loop
    	fn deregister_stream(&self, _stream: StreamToken, _event_loop: &mut EventLoop<IoManager<Message>>) {}
    }

    pub use service::TimerToken;
    pub use service::StreamToken;
    pub use service::IoContext;
    pub use service::IoService;
    pub use service::IoChannel;
    pub use service::IoManager;
    pub use service::TOKENS_PER_HANDLER;
    pub use panics::{PanicHandler, MayPanic, OnPanicListener, ForwardPanic};

    #[cfg(test)]
    mod tests {

    	use std::sync::Arc;
    	use super::*;

    	struct MyHandler;

    	#[derive(Clone)]
    	struct MyMessage {
    		data: u32
    	}

    	impl IoHandler<MyMessage> for MyHandler {
    		fn initialize(&self, io: &IoContext<MyMessage>) {
    			io.register_timer(0, 1000).unwrap();
    		}

    		fn timeout(&self, _io: &IoContext<MyMessage>, timer: TimerToken) {
    			println!("Timeout {}", timer);
    		}

    		fn message(&self, _io: &IoContext<MyMessage>, message: &MyMessage) {
    			println!("Message {}", message.data);
    		}
    	}

    	#[test]
    	fn test_service_register_handler () {
    		let service = IoService::<MyMessage>::start().expect("Error creating network service");
    		service.register_handler(Arc::new(MyHandler)).unwrap();
    	}

    }

# Help

## Keyboard Shortcuts

?
  Show this help dialog
S
  Focus the search field
⇤
  Move up in search results
⇥
  Move down in search results
⏎
  Go to active search result
+
  Collapse/expand all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)