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 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247
// Copyright 2021 Protocol Labs.
// 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.
//! Async functions driving pending and established connections in the form of a task.
use super::concurrent_dial::ConcurrentDial;
use crate::{
connection::{
self, ConnectionError, ConnectionId, PendingInboundConnectionError,
PendingOutboundConnectionError,
},
transport::TransportError,
ConnectionHandler, Multiaddr, PeerId,
};
use futures::{
channel::{mpsc, oneshot},
future::{poll_fn, Either, Future},
SinkExt, StreamExt,
};
use libp2p_core::muxing::StreamMuxerBox;
use std::pin::Pin;
use void::Void;
/// Commands that can be sent to a task driving an established connection.
#[derive(Debug)]
pub(crate) enum Command<T> {
/// Notify the connection handler of an event.
NotifyHandler(T),
/// Gracefully close the connection (active close) before
/// terminating the task.
Close,
}
pub(crate) enum PendingConnectionEvent {
ConnectionEstablished {
id: ConnectionId,
output: (PeerId, StreamMuxerBox),
/// [`Some`] when the new connection is an outgoing connection.
/// Addresses are dialed in parallel. Contains the addresses and errors
/// of dial attempts that failed before the one successful dial.
outgoing: Option<(Multiaddr, Vec<(Multiaddr, TransportError<std::io::Error>)>)>,
},
/// A pending connection failed.
PendingFailed {
id: ConnectionId,
error: Either<PendingOutboundConnectionError, PendingInboundConnectionError>,
},
}
#[derive(Debug)]
#[allow(deprecated)]
pub(crate) enum EstablishedConnectionEvent<THandler: ConnectionHandler> {
/// A node we are connected to has changed its address.
AddressChange {
id: ConnectionId,
peer_id: PeerId,
new_address: Multiaddr,
},
/// Notify the manager of an event from the connection.
Notify {
id: ConnectionId,
peer_id: PeerId,
event: THandler::ToBehaviour,
},
/// A connection closed, possibly due to an error.
///
/// If `error` is `None`, the connection has completed
/// an active orderly close.
Closed {
id: ConnectionId,
peer_id: PeerId,
error: Option<ConnectionError<THandler::Error>>,
handler: THandler,
},
}
pub(crate) async fn new_for_pending_outgoing_connection(
connection_id: ConnectionId,
dial: ConcurrentDial,
abort_receiver: oneshot::Receiver<Void>,
mut events: mpsc::Sender<PendingConnectionEvent>,
) {
match futures::future::select(abort_receiver, Box::pin(dial)).await {
Either::Left((Err(oneshot::Canceled), _)) => {
let _ = events
.send(PendingConnectionEvent::PendingFailed {
id: connection_id,
error: Either::Left(PendingOutboundConnectionError::Aborted),
})
.await;
}
Either::Left((Ok(v), _)) => void::unreachable(v),
Either::Right((Ok((address, output, errors)), _)) => {
let _ = events
.send(PendingConnectionEvent::ConnectionEstablished {
id: connection_id,
output,
outgoing: Some((address, errors)),
})
.await;
}
Either::Right((Err(e), _)) => {
let _ = events
.send(PendingConnectionEvent::PendingFailed {
id: connection_id,
error: Either::Left(PendingOutboundConnectionError::Transport(e)),
})
.await;
}
}
}
pub(crate) async fn new_for_pending_incoming_connection<TFut>(
connection_id: ConnectionId,
future: TFut,
abort_receiver: oneshot::Receiver<Void>,
mut events: mpsc::Sender<PendingConnectionEvent>,
) where
TFut: Future<Output = Result<(PeerId, StreamMuxerBox), std::io::Error>> + Send + 'static,
{
match futures::future::select(abort_receiver, Box::pin(future)).await {
Either::Left((Err(oneshot::Canceled), _)) => {
let _ = events
.send(PendingConnectionEvent::PendingFailed {
id: connection_id,
error: Either::Right(PendingInboundConnectionError::Aborted),
})
.await;
}
Either::Left((Ok(v), _)) => void::unreachable(v),
Either::Right((Ok(output), _)) => {
let _ = events
.send(PendingConnectionEvent::ConnectionEstablished {
id: connection_id,
output,
outgoing: None,
})
.await;
}
Either::Right((Err(e), _)) => {
let _ = events
.send(PendingConnectionEvent::PendingFailed {
id: connection_id,
error: Either::Right(PendingInboundConnectionError::Transport(
TransportError::Other(e),
)),
})
.await;
}
}
}
pub(crate) async fn new_for_established_connection<THandler>(
connection_id: ConnectionId,
peer_id: PeerId,
mut connection: crate::connection::Connection<THandler>,
mut command_receiver: mpsc::Receiver<Command<THandler::FromBehaviour>>,
mut events: mpsc::Sender<EstablishedConnectionEvent<THandler>>,
) where
THandler: ConnectionHandler,
{
loop {
match futures::future::select(
command_receiver.next(),
poll_fn(|cx| Pin::new(&mut connection).poll(cx)),
)
.await
{
Either::Left((Some(command), _)) => match command {
Command::NotifyHandler(event) => connection.on_behaviour_event(event),
Command::Close => {
command_receiver.close();
let (handler, closing_muxer) = connection.close();
let error = closing_muxer.await.err().map(ConnectionError::IO);
let _ = events
.send(EstablishedConnectionEvent::Closed {
id: connection_id,
peer_id,
error,
handler,
})
.await;
return;
}
},
// The manager has disappeared; abort.
Either::Left((None, _)) => return,
Either::Right((event, _)) => {
match event {
Ok(connection::Event::Handler(event)) => {
let _ = events
.send(EstablishedConnectionEvent::Notify {
id: connection_id,
peer_id,
event,
})
.await;
}
Ok(connection::Event::AddressChange(new_address)) => {
let _ = events
.send(EstablishedConnectionEvent::AddressChange {
id: connection_id,
peer_id,
new_address,
})
.await;
}
Err(error) => {
command_receiver.close();
let (handler, _closing_muxer) = connection.close();
// Terminate the task with the error, dropping the connection.
let _ = events
.send(EstablishedConnectionEvent::Closed {
id: connection_id,
peer_id,
error: Some(error),
handler,
})
.await;
return;
}
}
}
}
}
}