Struct igd::tokio::Gateway

pub struct Gateway { /* fields omitted */ }

This structure represents a gateway found by the search functions.

Methods

impl Gateway

pub fn new(addr: SocketAddrV4, control_url: String, handle: Handle) -> Gateway

Create a new Gateway for a given Handle to a control loop

pub fn get_external_ip(
    &self
) -> Box<dyn Future<Item = Ipv4Addr, Error = GetExternalIpError>>

Get the external IP address of the gateway in a tokio compatible way

pub fn get_any_address(
    &self,
    protocol: PortMappingProtocol,
    local_addr: SocketAddrV4,
    lease_duration: u32,
    description: &str
) -> Box<dyn Future<Item = SocketAddrV4, Error = AddAnyPortError>>

Get an external socket address with our external ip and any port. This is a convenience function that calls get_external_ip followed by add_any_port

The local_addr is the address where the traffic is sent to. The lease_duration parameter is in seconds. A value of 0 is infinite.

Returns

The external address that was mapped on success. Otherwise an error.

pub fn add_any_port(
    &self,
    protocol: PortMappingProtocol,
    local_addr: SocketAddrV4,
    lease_duration: u32,
    description: &str
) -> Box<dyn Future<Item = u16, Error = AddAnyPortError>>

Add a port mapping.with any external port.

The local_addr is the address where the traffic is sent to. The lease_duration parameter is in seconds. A value of 0 is infinite.

Returns

The external port that was mapped on success. Otherwise an error.

pub fn add_port(
    &self,
    protocol: PortMappingProtocol,
    external_port: u16,
    local_addr: SocketAddrV4,
    lease_duration: u32,
    description: &str
) -> Box<dyn Future<Item = (), Error = AddPortError>>

Add a port mapping.

The local_addr is the address where the traffic is sent to. The lease_duration parameter is in seconds. A value of 0 is infinite.

pub fn remove_port(
    &self,
    protocol: PortMappingProtocol,
    external_port: u16
) -> Box<dyn Future<Item = (), Error = RemovePortError>>

Remove a port mapping.

Trait Implementations

impl Clone for Gateway

fn clone(&self) -> Gateway

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Eq for Gateway

impl PartialEq<Gateway> for Gateway

fn eq(&self, other: &Gateway) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Display for Gateway

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

Formats the value using the given formatter.

impl Debug for Gateway

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

Formats the value using the given formatter.

impl Hash for Gateway

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].