diff --git a/protocols/identify/src/lib.rs b/protocols/identify/src/lib.rs index 3684177f71f..4d8f862e9bb 100644 --- a/protocols/identify/src/lib.rs +++ b/protocols/identify/src/lib.rs @@ -83,10 +83,12 @@ extern crate void; pub use self::id_transport::IdentifyTransport; pub use self::periodic_id_handler::{PeriodicIdentification, PeriodicIdentificationEvent}; +pub use self::periodic_id_layer::{PeriodicIdentifyBehaviour, PeriodicIdentifyBehaviourEvent}; pub use self::protocol::{IdentifyInfo, IdentifyOutput}; pub use self::protocol::{IdentifyProtocolConfig, IdentifySender}; mod id_transport; mod periodic_id_handler; +mod periodic_id_layer; mod protocol; mod structs_proto; diff --git a/protocols/identify/src/periodic_id_layer.rs b/protocols/identify/src/periodic_id_layer.rs new file mode 100644 index 00000000000..54a36c83e37 --- /dev/null +++ b/protocols/identify/src/periodic_id_layer.rs @@ -0,0 +1,111 @@ +// Copyright 2018 Parity Technologies (UK) Ltd. +// +// Permission is hereby granted, free of charge, to any person obtaining a +// copy of this software and associated documentation files (the "Software"), +// to deal in the Software without restriction, including without limitation +// the rights to use, copy, modify, merge, publish, distribute, sublicense, +// and/or sell copies of the Software, and to permit persons to whom the +// Software is furnished to do so, subject to the following conditions: +// +// The above copyright notice and this permission notice shall be included in +// all copies or substantial portions of the Software. +// +// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS +// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +// DEALINGS IN THE SOFTWARE. + +use futures::prelude::*; +use libp2p_core::nodes::{ConnectedPoint, NetworkBehavior, NetworkBehaviorAction}; +use libp2p_core::{nodes::protocols_handler::ProtocolsHandler, Multiaddr, PeerId}; +use std::{collections::VecDeque, marker::PhantomData}; +use tokio_io::{AsyncRead, AsyncWrite}; +use {IdentifyInfo, PeriodicIdentification, PeriodicIdentificationEvent}; + +/// Network behaviour that automatically identifies nodes periodically, and returns information +/// about them. +pub struct PeriodicIdentifyBehaviour { + /// Events that need to be produced outside when polling.. + events: VecDeque, + /// Marker to pin the generics. + marker: PhantomData, +} + +impl PeriodicIdentifyBehaviour { + /// Creates a `PeriodicIdentifyBehaviour`. + pub fn new() -> Self { + PeriodicIdentifyBehaviour { + events: VecDeque::new(), + marker: PhantomData, + } + } +} + +impl NetworkBehavior for PeriodicIdentifyBehaviour +where + TSubstream: AsyncRead + AsyncWrite + Send + Sync + 'static, +{ + type ProtocolsHandler = PeriodicIdentification; + type OutEvent = PeriodicIdentifyBehaviourEvent; + + fn new_handler(&mut self) -> Self::ProtocolsHandler { + PeriodicIdentification::new() + } + + fn inject_connected(&mut self, _: PeerId, _: ConnectedPoint) {} + + fn inject_disconnected(&mut self, _: &PeerId, _: ConnectedPoint) {} + + fn inject_node_event( + &mut self, + peer_id: PeerId, + event: ::OutEvent, + ) { + match event { + PeriodicIdentificationEvent::Identified { + info, + observed_addr, + } => { + self.events + .push_back(PeriodicIdentifyBehaviourEvent::Identified { + peer_id: peer_id, + info: info, + observed_addr: observed_addr, + }); + } + _ => (), // TODO: exhaustive pattern + } + } + + fn poll( + &mut self, + ) -> Async< + NetworkBehaviorAction< + ::InEvent, + Self::OutEvent, + >, + > { + if let Some(event) = self.events.pop_front() { + return Async::Ready(NetworkBehaviorAction::GenerateEvent(event)); + } + + Async::NotReady + } +} + +/// Event generated by the `PeriodicIdentifyBehaviour`. +#[derive(Debug, Clone)] +pub enum PeriodicIdentifyBehaviourEvent { + /// We obtained identification information from the remote + Identified { + /// Peer that has been successfully identified. + peer_id: PeerId, + /// Information of the remote. + info: IdentifyInfo, + /// Address the remote observes us as. + observed_addr: Multiaddr, + }, +}