Struct Gateway

pub struct Gateway<P> {
    pub addr: SocketAddr,
    pub root_url: String,
    pub control_url: String,
    pub control_schema_url: String,
    pub control_schema: HashMap<String, Vec<String>>,
    pub provider: P,
}

This structure represents a gateway found by the search functions.

Fields

addr: SocketAddr

Socket address of the gateway

root_url: String

Root url of the device

control_url: String

Control url of the device

control_schema_url: String

Url to get schema data from

control_schema: HashMap<String, Vec<String>>

Control schema for all actions

provider: P

Executor provider

Implementations

impl<P: Provider> Gateway<P>

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

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

pub async fn get_any_address( &self, protocol: PortMappingProtocol, local_addr: SocketAddr, lease_duration: u32, description: &str, ) -> Result<SocketAddr, 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 async fn add_any_port( &self, protocol: PortMappingProtocol, local_addr: SocketAddr, 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 async fn add_port( &self, protocol: PortMappingProtocol, external_port: u16, local_addr: SocketAddr, 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 async fn remove_port( &self, protocol: PortMappingProtocol, external_port: u16, ) -> Result<(), RemovePortError>

Remove a port mapping.

pub async fn get_generic_port_mapping_entry( &self, index: u32, ) -> Result<PortMappingEntry, GetGenericPortMappingEntryError>

Get one port mapping entry

Gets one port mapping entry by its index. Not all existing port mappings might be visible to this client. If the index is out of bound, GetGenericPortMappingEntryError::SpecifiedArrayIndexInvalid will be returned

Trait Implementations

impl<P: Clone> Clone for Gateway<P>

fn clone(&self) -> Gateway<P>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<P: Debug> Debug for Gateway<P>

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

Formats the value using the given formatter.

impl<P> Display for Gateway<P>

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

Formats the value using the given formatter.

impl<P> Hash for Gateway<P>

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<P> PartialEq for Gateway<P>

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<P> Eq for Gateway<P>