Struct Client 

pub struct Client { /* private fields */ }

Port mapping client.

Implementations

impl Client

pub fn new(config: Config) -> Self

Create a new port mapping client.

pub fn with_metrics(config: Config, metrics: Arc<Metrics>) -> Self

Creates a new port mapping client with a previously created metrics collector.

pub fn with_observer( config: Config, metrics: Arc<Metrics>, observer: Observer, ) -> Self

Create a client whose discovery, lease and release transitions are observed.

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

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 async fn deactivate_and_wait(&self)

Deactivate and acknowledge completion of lease cleanup. Observer events distinguish successful release from a gateway error.

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

Watch the external address for changes in the mappings.

pub fn metrics(&self) -> &Arc<Metrics>

Returns the metrics collected by the service.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Self

Returns a duplicate 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.

impl Default for Client

fn default() -> Self

Returns the “default value” for a type.