Struct igd::Gateway

pub struct Gateway {
    pub addr: SocketAddrV4,
    pub control_url: String,
}

This structure represents a gateway found by the search functions.

Fields

addr: SocketAddrV4

Socket address of the gateway

control_url: String

Control url of the device

Methods

impl Gateway

pub fn get_external_ip(&self) -> Result<Ipv4Addr, GetExternalIpError>

Get the external IP address of the gateway.

pub fn get_any_address(
    &self,
    protocol: PortMappingProtocol,
    local_addr: SocketAddrV4,
    lease_duration: u32,
    description: &str
) -> Result<SocketAddrV4, 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
) -> Result<u16, 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
) -> Result<(), 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
) -> Result<(), 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 ==.

fn ne(&self, other: &Gateway) -> 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].