      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

    // 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/>.

    //! Network and general IO module.
    //!
    //! Example usage for craeting a network service and adding an IO handler:
    //!
    //! ```rust
    //! extern crate ethcore_network as net;
    //! use net::*;
    //! use std::sync::Arc;
    //!
    //! struct MyHandler;
    //!
    //! impl NetworkProtocolHandler for MyHandler {
    //!		fn initialize(&self, io: &NetworkContext) {
    //!			io.register_timer(0, 1000);
    //!		}
    //!
    //!		fn read(&self, io: &NetworkContext, peer: &PeerId, packet_id: u8, data: &[u8]) {
    //!			println!("Received {} ({} bytes) from {}", packet_id, data.len(), peer);
    //!		}
    //!
    //!		fn connected(&self, io: &NetworkContext, peer: &PeerId) {
    //!			println!("Connected {}", peer);
    //!		}
    //!
    //!		fn disconnected(&self, io: &NetworkContext, peer: &PeerId) {
    //!			println!("Disconnected {}", peer);
    //!		}
    //! }
    //!
    //! fn main () {
    //! 	let mut service = NetworkService::new(NetworkConfiguration::new_local()).expect("Error creating network service");
    //! 	service.start().expect("Error starting service");
    //! 	service.register_protocol(Arc::new(MyHandler), *b"myp", 1, &[1u8]);
    //!
    //! 	// Wait for quit condition
    //! 	// ...
    //! 	// Drop the service
    //! }
    //! ```

    extern crate ethcore_io as io;
    extern crate ethcore_util as util;
    extern crate parking_lot;
    extern crate mio;
    extern crate tiny_keccak;
    extern crate crypto as rcrypto;
    extern crate rand;
    extern crate time;
    extern crate ansi_term; //TODO: remove this
    extern crate rustc_serialize;
    extern crate igd;
    extern crate libc;
    extern crate slab;
    extern crate ethkey;
    extern crate ethcrypto as crypto;
    extern crate rlp;
    extern crate bytes;

    #[macro_use]
    extern crate log;

    #[cfg(test)]
    extern crate ethcore_devtools as devtools;

    mod host;
    mod connection;
    mod handshake;
    mod session;
    mod discovery;
    mod service;
    mod error;
    mod node_table;
    mod stats;
    mod ip_utils;

    #[cfg(test)]
    mod tests;

    pub use host::{PeerId, PacketId, ProtocolId, NetworkContext, NetworkIoMessage, NetworkConfiguration};
    pub use service::NetworkService;
    pub use error::NetworkError;
    pub use stats::NetworkStats;
    pub use session::SessionInfo;

    use io::TimerToken;
    pub use node_table::{is_valid_node_url, NodeId};

    const PROTOCOL_VERSION: u32 = 4;

    /// 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: Sync + Send {
    	/// Initialize the handler
    	fn initialize(&self, _io: &NetworkContext) {}
    	/// Called when new network packet received.
    	fn read(&self, io: &NetworkContext, 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, peer: &PeerId);
    	/// Called when a previously connected peer disconnects.
    	fn disconnected(&self, io: &NetworkContext, peer: &PeerId);
    	/// Timer function called after a timeout created with `NetworkContext::timeout`.
    	fn timeout(&self, _io: &NetworkContext, _timer: TimerToken) {}
    }

    /// 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,
    		}
    	}
    }

    /// IP fiter
    #[derive(Clone, Debug, PartialEq, Eq, Copy)]
    pub enum AllowIP {
    	/// Connect to any address
    	All,
    	/// Connect to private network only
    	Private,
    	/// Connect to public network only
    	Public,
    }

# 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`)