libp2p_upnp/lib.rs
1// Copyright 2023 Protocol Labs.
2//
3// Permission is hereby granted, free of charge, to any person obtaining a
4// copy of this software and associated documentation files (the "Software"),
5// to deal in the Software without restriction, including without limitation
6// the rights to use, copy, modify, merge, publish, distribute, sublicense,
7// and/or sell copies of the Software, and to permit persons to whom the
8// Software is furnished to do so, subject to the following conditions:
9//
10// The above copyright notice and this permission notice shall be included in
11// all copies or substantial portions of the Software.
12//
13// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
14// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
18// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
19// DEALINGS IN THE SOFTWARE.
20
21//! Implementation of UPnP port mapping for libp2p.
22//!
23//! This crate provides a `tokio::Behaviour` which
24//! implements the [`libp2p_swarm::NetworkBehaviour`] trait.
25//! This struct will automatically try to map the ports externally to internal
26//! addresses on the gateway.
27
28#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
29
30#[cfg(feature = "tokio")]
31mod behaviour;
32#[cfg(feature = "tokio")]
33pub mod tokio;
34
35#[cfg(feature = "tokio")]
36pub use behaviour::Event;