Struct iroh_net::portmapper::Client

pub struct Client { /* private fields */ }

Port mapping client.

Implementations

impl Client

pub async fn default() -> Self

Creates a client that uses the default configuration.

See Config::default.

pub async fn new(config: Config) -> Self

Create a new port mapping client.

pub fn probe(&self) -> Receiver<Result<ProbeOutput, String>>

Request a probe to the port mapping protocols.

Returns the oneshot::Receiver used to obtain the result of the probe.

pub fn procure_mapping(&self)

Try to get a mapping for the last local port if there isn’t one already.

pub fn update_local_port(&self, local_port: NonZeroU16)

Update the local port.

If the port changes, this will trigger a port mapping attempt.

pub fn deactivate(&self)

Deactivate port mapping.

pub fn watch_external_address(&self) -> Receiver<Option<SocketAddrV4>>

Watch the external address for changes in the mappings.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.