// Copyright 2019 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 crate::{ either::EitherOutput, protocols_handler::{ KeepAlive, SubstreamProtocol, ProtocolsHandler, ProtocolsHandlerEvent, ProtocolsHandlerUpgrErr, IntoProtocolsHandler }, swarm::{NetworkBehaviour, NetworkBehaviourAction, NetworkBehaviourEventProcess}, upgrade::{InboundUpgrade, OutboundUpgrade, DeniedUpgrade, EitherUpgrade}, PeerId, Multiaddr, nodes::ConnectedPoint, swarm::PollParameters, }; use futures::prelude::*; use std::error; /// Implementation of `NetworkBehaviour` that can be either in the disabled or enabled state. /// /// The state can only be chosen at initialization. pub struct Toggle { inner: Option, } impl From> for Toggle { fn from(inner: Option) -> Self { Toggle { inner } } } impl NetworkBehaviour for Toggle where TBehaviour: NetworkBehaviour { type ProtocolsHandler = ToggleIntoProtoHandler; type OutEvent = TBehaviour::OutEvent; fn new_handler(&mut self) -> Self::ProtocolsHandler { ToggleIntoProtoHandler { inner: self.inner.as_mut().map(|i| i.new_handler()) } } fn addresses_of_peer(&mut self, peer_id: &PeerId) -> Vec { self.inner.as_mut().map(|b| b.addresses_of_peer(peer_id)).unwrap_or_else(Vec::new) } fn inject_connected(&mut self, peer_id: PeerId, endpoint: ConnectedPoint) { if let Some(inner) = self.inner.as_mut() { inner.inject_connected(peer_id, endpoint) } } fn inject_disconnected(&mut self, peer_id: &PeerId, endpoint: ConnectedPoint) { if let Some(inner) = self.inner.as_mut() { inner.inject_disconnected(peer_id, endpoint) } } fn inject_replaced(&mut self, peer_id: PeerId, closed_endpoint: ConnectedPoint, new_endpoint: ConnectedPoint) { if let Some(inner) = self.inner.as_mut() { inner.inject_replaced(peer_id, closed_endpoint, new_endpoint) } } fn inject_node_event( &mut self, peer_id: PeerId, event: <::Handler as ProtocolsHandler>::OutEvent ) { if let Some(inner) = self.inner.as_mut() { inner.inject_node_event(peer_id, event); } } fn inject_addr_reach_failure(&mut self, peer_id: Option<&PeerId>, addr: &Multiaddr, error: &dyn error::Error) { if let Some(inner) = self.inner.as_mut() { inner.inject_addr_reach_failure(peer_id, addr, error) } } fn inject_dial_failure(&mut self, peer_id: &PeerId) { if let Some(inner) = self.inner.as_mut() { inner.inject_dial_failure(peer_id) } } fn inject_new_listen_addr(&mut self, addr: &Multiaddr) { if let Some(inner) = self.inner.as_mut() { inner.inject_new_listen_addr(addr) } } fn inject_expired_listen_addr(&mut self, addr: &Multiaddr) { if let Some(inner) = self.inner.as_mut() { inner.inject_expired_listen_addr(addr) } } fn inject_new_external_addr(&mut self, addr: &Multiaddr) { if let Some(inner) = self.inner.as_mut() { inner.inject_new_external_addr(addr) } } fn poll(&mut self, params: &mut PollParameters<'_>) -> Async::Handler as ProtocolsHandler>::InEvent, Self::OutEvent>> { if let Some(inner) = self.inner.as_mut() { inner.poll(params) } else { Async::NotReady } } } impl NetworkBehaviourEventProcess for Toggle where TBehaviour: NetworkBehaviourEventProcess { fn inject_event(&mut self, event: TEvent) { if let Some(inner) = self.inner.as_mut() { inner.inject_event(event); } } } /// Implementation of `IntoProtocolsHandler` that can be in the disabled state. pub struct ToggleIntoProtoHandler { inner: Option, } impl IntoProtocolsHandler for ToggleIntoProtoHandler where TInner: IntoProtocolsHandler { type Handler = ToggleProtoHandler; fn into_handler(self, remote_peer_id: &PeerId) -> Self::Handler { ToggleProtoHandler { inner: self.inner.map(|h| h.into_handler(remote_peer_id)) } } } /// Implementation of `ProtocolsHandler` that can be in the disabled state. pub struct ToggleProtoHandler { inner: Option, } impl ProtocolsHandler for ToggleProtoHandler where TInner: ProtocolsHandler, { type InEvent = TInner::InEvent; type OutEvent = TInner::OutEvent; type Error = TInner::Error; type Substream = TInner::Substream; type InboundProtocol = EitherUpgrade; type OutboundProtocol = TInner::OutboundProtocol; type OutboundOpenInfo = TInner::OutboundOpenInfo; fn listen_protocol(&self) -> SubstreamProtocol { if let Some(inner) = self.inner.as_ref() { inner.listen_protocol().map_upgrade(EitherUpgrade::A) } else { SubstreamProtocol::new(EitherUpgrade::B(DeniedUpgrade)) } } fn inject_fully_negotiated_inbound( &mut self, out: >::Output ) { let out = match out { EitherOutput::First(out) => out, EitherOutput::Second(v) => void::unreachable(v), }; self.inner.as_mut().expect("Can't receive an inbound substream if disabled; QED") .inject_fully_negotiated_inbound(out) } fn inject_fully_negotiated_outbound( &mut self, out: >::Output, info: Self::OutboundOpenInfo ) { self.inner.as_mut().expect("Can't receive an outbound substream if disabled; QED") .inject_fully_negotiated_outbound(out, info) } fn inject_event(&mut self, event: Self::InEvent) { self.inner.as_mut().expect("Can't receive events if disabled; QED") .inject_event(event) } fn inject_dial_upgrade_error(&mut self, info: Self::OutboundOpenInfo, err: ProtocolsHandlerUpgrErr<>::Error>) { self.inner.as_mut().expect("Can't receive an outbound substream if disabled; QED") .inject_dial_upgrade_error(info, err) } fn connection_keep_alive(&self) -> KeepAlive { self.inner.as_ref().map(|h| h.connection_keep_alive()) .unwrap_or(KeepAlive::No) } fn poll( &mut self, ) -> Poll< ProtocolsHandlerEvent, Self::Error, > { if let Some(inner) = self.inner.as_mut() { inner.poll() } else { Ok(Async::NotReady) } } }