      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

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

    use std::collections::HashMap;
    use network::{NetworkContext, PeerId, PacketId, NetworkError, SessionInfo, ProtocolId};
    use util::Bytes;
    use ethcore::client::BlockChainClient;
    use ethcore::header::BlockNumber;
    use ethcore::snapshot::SnapshotService;
    use parking_lot::RwLock;

    /// IO interface for the syncing handler.
    /// Provides peer connection management and an interface to the blockchain client.
    // TODO: ratings
    pub trait SyncIo {
    	/// Disable a peer
    	fn disable_peer(&mut self, peer_id: PeerId);
    	/// Disconnect peer
    	fn disconnect_peer(&mut self, peer_id: PeerId);
    	/// Respond to current request with a packet. Can be called from an IO handler for incoming packet.
    	fn respond(&mut self, packet_id: PacketId, data: Vec<u8>) -> Result<(), NetworkError>;
    	/// Send a packet to a peer.
    	fn send(&mut self, peer_id: PeerId, packet_id: PacketId, data: Vec<u8>) -> Result<(), NetworkError>;
    	/// Send a packet to a peer using specified protocol.
    	fn send_protocol(&mut self, protocol: ProtocolId, peer_id: PeerId, packet_id: PacketId, data: Vec<u8>) -> Result<(), NetworkError>;
    	/// Get the blockchain
    	fn chain(&self) -> &BlockChainClient;
    	/// Get the snapshot service.
    	fn snapshot_service(&self) -> &SnapshotService;
    	/// Returns peer identifier string
    	fn peer_info(&self, peer_id: PeerId) -> String {
    		peer_id.to_string()
    	}
    	/// Returns information on p2p session
    	fn peer_session_info(&self, peer_id: PeerId) -> Option<SessionInfo>;
    	/// Maximum mutually supported ETH protocol version
    	fn eth_protocol_version(&self, peer_id: PeerId) -> u8;
    	/// Maximum mutually supported version of a gien protocol.
    	fn protocol_version(&self, protocol: &ProtocolId, peer_id: PeerId) -> u8;
    	/// Returns if the chain block queue empty
    	fn is_chain_queue_empty(&self) -> bool {
    		self.chain().queue_info().is_empty()
    	}
    	/// Check if the session is expired
    	fn is_expired(&self) -> bool;
    	/// Return sync overlay
    	fn chain_overlay(&self) -> &RwLock<HashMap<BlockNumber, Bytes>>;
    }

    /// Wraps `NetworkContext` and the blockchain client
    pub struct NetSyncIo<'s, 'h> where 'h: 's {
    	network: &'s NetworkContext<'h>,
    	chain: &'s BlockChainClient,
    	snapshot_service: &'s SnapshotService,
    	chain_overlay: &'s RwLock<HashMap<BlockNumber, Bytes>>,
    }

    impl<'s, 'h> NetSyncIo<'s, 'h> {
    	/// Creates a new instance from the `NetworkContext` and the blockchain client reference.
    	pub fn new(network: &'s NetworkContext<'h>,
    		chain: &'s BlockChainClient,
    		snapshot_service: &'s SnapshotService,
    		chain_overlay: &'s RwLock<HashMap<BlockNumber, Bytes>>) -> NetSyncIo<'s, 'h> {
    		NetSyncIo {
    			network: network,
    			chain: chain,
    			snapshot_service: snapshot_service,
    			chain_overlay: chain_overlay,
    		}
    	}
    }

    impl<'s, 'h> SyncIo for NetSyncIo<'s, 'h> {
    	fn disable_peer(&mut self, peer_id: PeerId) {
    		self.network.disable_peer(peer_id);
    	}

    	fn disconnect_peer(&mut self, peer_id: PeerId) {
    		self.network.disconnect_peer(peer_id);
    	}

    	fn respond(&mut self, packet_id: PacketId, data: Vec<u8>) -> Result<(), NetworkError>{
    		self.network.respond(packet_id, data)
    	}

    	fn send(&mut self, peer_id: PeerId, packet_id: PacketId, data: Vec<u8>) -> Result<(), NetworkError>{
    		self.network.send(peer_id, packet_id, data)
    	}

    	fn send_protocol(&mut self, protocol: ProtocolId, peer_id: PeerId, packet_id: PacketId, data: Vec<u8>) -> Result<(), NetworkError>{
    		self.network.send_protocol(protocol, peer_id, packet_id, data)
    	}

    	fn chain(&self) -> &BlockChainClient {
    		self.chain
    	}

    	fn chain_overlay(&self) -> &RwLock<HashMap<BlockNumber, Bytes>> {
    		self.chain_overlay
    	}

    	fn snapshot_service(&self) -> &SnapshotService {
    		self.snapshot_service
    	}

    	fn peer_session_info(&self, peer_id: PeerId) -> Option<SessionInfo> {
    		self.network.session_info(peer_id)
    	}

    	fn is_expired(&self) -> bool {
    		self.network.is_expired()
    	}

    	fn eth_protocol_version(&self, peer_id: PeerId) -> u8 {
    		self.network.protocol_version(self.network.subprotocol_name(), peer_id).unwrap_or(0)
    	}

    	fn protocol_version(&self, protocol: &ProtocolId, peer_id: PeerId) -> u8 {
    		self.network.protocol_version(*protocol, peer_id).unwrap_or(0)
    	}

    	fn peer_info(&self, peer_id: PeerId) -> String {
    		self.network.peer_client_version(peer_id)
    	}
    }

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