Merge a16b630 into 7736504

.github/workflows/commitlint.yml

@@ -3,12 +3,9 @@ on: [pull_request]
 
 jobs:
   lint:
-    if: github.repository_owner == 'maidsafe'
     runs-on: ubuntu-latest
-    env:
-      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
     steps:
       - uses: actions/checkout@v2
         with:
           fetch-depth: 0
-      - uses: wagoid/commitlint-github-action@f114310111fdbd07e99f47f9ca13d62b3ec98372
+      - uses: wagoid/commitlint-github-action@59203cb6ee1ce85035e6fe7b3aa878cf80653739

src/config.rs

@@ -36,7 +36,7 @@ pub const DEFAULT_INITIAL_RETRY_INTERVAL: Duration = Duration::from_millis(500);
 /// gives 5-6 retries in ~30 s total retry time.
 pub const DEFAULT_MAX_RETRY_INTERVAL: Duration = Duration::from_secs(15);
 
-/// Default for [`RetryConfig::retry_interval_multiplier`] (x1.5).
+/// Default for [`RetryConfig::retry_delay_multiplier`] (x1.5).
 ///
 /// Together with the default max and initial,
 /// gives 5-6 retries in ~30 s total retry time.

src/connections.rs

@@ -21,9 +21,18 @@ use tokio::sync::mpsc::{Receiver, Sender};
 use tokio::time::{timeout, Duration};
 use tracing::{trace, warn};
 
-/// Connection instance to a node which can be used to send messages to it
+/// A connection between two [`Endpoint`]s.
+///
+/// This is backed by an `Arc` and a small amount of metadata, so cloning is fairly cheap. The
+/// connection is also pooled, meaning the same underlying connection will be used when connecting
+/// multiple times to the same peer. If an error occurs on the connection, it will be removed from
+/// the pool. See the documentation of [`Endpoint::connect_to`] for more details about connection
+/// pooling.
+///
+/// [`Endpoint`]: crate::Endpoint
+/// [`Endpoint::connect_to`]: crate::Endpoint::connect_to
 #[derive(Clone)]
-pub(crate) struct Connection<I: ConnId> {
+pub struct Connection<I: ConnId> {
     quic_conn: quinn::Connection,
     remover: ConnectionRemover<I>,
 }
@@ -45,6 +54,11 @@ impl<I: ConnId> Connection<I> {
         Self { quic_conn, remover }
     }
 
+    /// Get the address of the connected peer.
+    pub fn remote_address(&self) -> SocketAddr {
+        self.quic_conn.remote_address()
+    }
+
     /// Priority default is 0. Both lower and higher can be passed in.
     pub(crate) async fn open_bi(
         &self,
@@ -81,10 +95,6 @@ impl<I: ConnId> Connection<I> {
         }
     }
 
-    pub(crate) fn remote_address(&self) -> SocketAddr {
-        self.quic_conn.remote_address()
-    }
-
     async fn handle_error<T, E>(&self, result: Result<T, E>) -> Result<T, E> {
         if result.is_err() {
             self.remover.remove().await