rename Provider trait to Gateway

Author: jxs

protocols/upnp/src/behaviour.rs

@@ -33,7 +33,7 @@ use std::{
 };
 
 use crate::{
-    provider::{Protocol, Provider},
+    gateway::{Gateway, Protocol},
     Config,
 };
 use futures::{future::BoxFuture, stream::FuturesUnordered, Future, FutureExt, StreamExt};
@@ -51,8 +51,8 @@ const MAPPING_DURATION: u64 = 3600;
 const MAPPING_TIMEOUT: u64 = MAPPING_DURATION / 2;
 
 /// Map a port on the gateway.
-async fn map_port<P: Provider + 'static>(
-    gateway: Arc<P::Gateway>,
+async fn map_port<P: Gateway + 'static>(
+    gateway: Arc<P>,
     mapping: Mapping,
     permanent: bool,
 ) -> Event {
@@ -72,17 +72,14 @@ async fn map_port<P: Provider + 'static>(
 }
 
 /// Remove a port mapping on the gateway.
-async fn remove_port_mapping<P: Provider + 'static>(
-    gateway: Arc<P::Gateway>,
-    mapping: Mapping,
-) -> Event {
+async fn remove_port_mapping<P: Gateway + 'static>(gateway: Arc<P>, mapping: Mapping) -> Event {
     match P::remove_port(gateway, mapping.protocol, mapping.internal_addr.port()).await {
         Ok(()) => Event::Removed(mapping),
         Err(err) => Event::RemovalFailure(mapping, err),
     }
 }
 
-/// A [`Provider::Gateway`] event.
+/// A [`Gateway`] event.
 #[derive(Debug)]
 enum Event {
     /// Port was successfully mapped.
@@ -136,18 +133,18 @@ enum MappingState {
     Permanent,
 }
 
-/// Current state of the UPnP [`Provider::Gateway`].
-enum GatewayState<P: Provider> {
-    Searching(BoxFuture<'static, Result<(P::Gateway, Ipv4Addr), Box<dyn std::error::Error>>>),
-    Available((Arc<P::Gateway>, Ipv4Addr)),
+/// Current state of the UPnP [`Gateway`].
+enum GatewayState<P: Gateway> {
+    Searching(BoxFuture<'static, Result<(P, Ipv4Addr), Box<dyn std::error::Error>>>),
+    Available((Arc<P>, Ipv4Addr)),
     GatewayNotFound,
 }
 
 /// A `NetworkBehaviour` for UPnP port mapping. Automatically tries to map the external port
 /// to an internal address on the gateway on a `FromSwarm::NewListenAddr`.
 pub struct Behaviour<P>
 where
-    P: Provider,
+    P: Gateway,
 {
     /// Gateway config.
     config: Config,
@@ -163,7 +160,7 @@ where
 
 impl<P> Default for Behaviour<P>
 where
-    P: Provider + 'static,
+    P: Gateway + 'static,
 {
     fn default() -> Self {
         Self::new(Config::default())
@@ -172,13 +169,13 @@ where
 
 impl<P> Behaviour<P>
 where
-    P: Provider + 'static,
+    P: Gateway + 'static,
 {
     /// Builds a new `UPnP` behaviour.
     pub fn new(config: Config) -> Self {
         Self {
             config,
-            state: GatewayState::Searching(P::search_gateway(config).boxed()),
+            state: GatewayState::Searching(P::search(config).boxed()),
             mappings: Default::default(),
             pending_events: Default::default(),
         }
@@ -187,7 +184,7 @@ where
 
 impl<P> NetworkBehaviour for Behaviour<P>
 where
-    P: Provider + 'static,
+    P: Gateway + 'static,
 {
     type ConnectionHandler = dummy::ConnectionHandler;
 

protocols/upnp/src/provider.rs renamed to protocols/upnp/src/gateway.rs

@@ -53,25 +53,19 @@ impl fmt::Display for Protocol {
 
 /// The interface for non-blocking UPnP I/O providers.
 #[async_trait]
-pub trait Provider {
-    /// The gateway of  obtained from [`Provider::search_gateway`].
-    type Gateway: Send + Sync;
-
+pub trait Gateway: Sized + Send + Sync {
     /// Search for the gateway endpoint on the local network.
-    async fn search_gateway(config: Config) -> Result<(Self::Gateway, Ipv4Addr), Box<dyn Error>>;
+    async fn search(config: Config) -> Result<(Self, Ipv4Addr), Box<dyn Error>>;
 
     /// Add the input port mapping on the gateway so that traffic is forwarded to the input address.
     async fn add_port(
-        _: Arc<Self::Gateway>,
+        _: Arc<Self>,
         protocol: Protocol,
         addr: SocketAddrV4,
         duration: Duration,
     ) -> Result<(), Box<dyn Error>>;
 
     /// Remove port mapping on the gateway.
-    async fn remove_port(
-        _: Arc<Self::Gateway>,
-        protocol: Protocol,
-        port: u16,
-    ) -> Result<(), Box<dyn Error>>;
+    async fn remove_port(_: Arc<Self>, protocol: Protocol, port: u16)
+        -> Result<(), Box<dyn Error>>;
 }

protocols/upnp/src/provider/async_std.rs renamed to protocols/upnp/src/gateway/async_std.rs

@@ -34,14 +34,9 @@ use igd_async_std::{
     PortMappingProtocol, SearchOptions,
 };
 
-#[doc(hidden)]
-pub struct Provider;
-
 #[async_trait]
-impl super::Provider for Provider {
-    type Gateway = Gateway;
-
-    async fn search_gateway(config: Config) -> Result<(Self::Gateway, Ipv4Addr), Box<dyn Error>> {
+impl super::Gateway for Gateway {
+    async fn search(config: Config) -> Result<(Self, Ipv4Addr), Box<dyn Error>> {
         let options = SearchOptions {
             bind_addr: config.bind_addr,
             broadcast_address: config.broadcast_addr,
@@ -53,7 +48,7 @@ impl super::Provider for Provider {
     }
 
     async fn add_port(
-        gateway: Arc<Self::Gateway>,
+        gateway: Arc<Self>,
         protocol: Protocol,
         addr: SocketAddrV4,
         duration: Duration,
@@ -75,7 +70,7 @@ impl super::Provider for Provider {
     }
 
     async fn remove_port(
-        gateway: Arc<Self::Gateway>,
+        gateway: Arc<Self>,
         protocol: Protocol,
         port: u16,
     ) -> Result<(), Box<dyn Error>> {
@@ -91,4 +86,4 @@ impl super::Provider for Provider {
 }
 
 /// The type of a [`Behaviour`] using the `async-io` implementation.
-pub type Behaviour = crate::behaviour::Behaviour<Provider>;
+pub type Behaviour = crate::behaviour::Behaviour<Gateway>;

protocols/upnp/src/provider/tokio.rs renamed to protocols/upnp/src/gateway/tokio.rs

@@ -34,14 +34,9 @@ use igd::{
     PortMappingProtocol, SearchOptions,
 };
 
-#[doc(hidden)]
-pub struct Provider;
-
 #[async_trait]
-impl super::Provider for Provider {
-    type Gateway = Gateway;
-
-    async fn search_gateway(config: Config) -> Result<(Self::Gateway, Ipv4Addr), Box<dyn Error>> {
+impl super::Gateway for Gateway {
+    async fn search(config: Config) -> Result<(Self, Ipv4Addr), Box<dyn Error>> {
         let options = SearchOptions {
             bind_addr: config.bind_addr,
             broadcast_address: config.broadcast_addr,
@@ -53,7 +48,7 @@ impl super::Provider for Provider {
     }
 
     async fn add_port(
-        gateway: Arc<Self::Gateway>,
+        gateway: Arc<Self>,
         protocol: Protocol,
         addr: SocketAddrV4,
         duration: Duration,
@@ -75,7 +70,7 @@ impl super::Provider for Provider {
     }
 
     async fn remove_port(
-        gateway: Arc<Self::Gateway>,
+        gateway: Arc<Self>,
         protocol: Protocol,
         port: u16,
     ) -> Result<(), Box<dyn Error>> {
@@ -91,4 +86,4 @@ impl super::Provider for Provider {
 }
 
 /// The type of a [`Behaviour`] using the `tokio` implementation.
-pub type Behaviour = crate::behaviour::Behaviour<Provider>;
+pub type Behaviour = crate::behaviour::Behaviour<Gateway>;

protocols/upnp/src/lib.rs

@@ -28,17 +28,17 @@
 #![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
 
 mod behaviour;
-mod provider;
+mod gateway;
 
 use std::{
     net::{Ipv4Addr, SocketAddr, SocketAddrV4},
     time::Duration,
 };
 
 #[cfg(feature = "async-std")]
-pub use provider::async_std;
+pub use gateway::async_std;
 #[cfg(feature = "tokio")]
-pub use provider::tokio;
+pub use gateway::tokio;
 
 /// The configuration for UPnP capabilities for libp2p.
 #[derive(Clone, Copy, Debug)]