Struct tinkerforge::ip_connection::IpConnectionRequestSender

pub struct IpConnectionRequestSender { /* fields omitted */ }

The IP connection request sender is a cloneable object created by a IP connection. The sender can send requests to connected devices and can be shared across threads by cloning.

Implementations

impl IpConnectionRequestSender

pub fn connect<T: ToSocketAddrs>(
    &self,
    addr: T
) -> Receiver<Result<(), ConnectError>>

Creates a TCP/IP connection to the given addr. addr can be any object which implements ToSocketAddrs, for example a tuple of a hostname and a port. The address can refer to a Brick Daemon or to a WIFI/Ethernet Extension.

Devices can only be controlled when the connection was established successfully.

Returns a receiver, which will receive either () or an ConnectError if there is no Brick Daemon or WIFI/Ethernet Extension listening at the given host and port.

pub fn disconnect(&self) -> Receiver<Result<(), DisconnectErrorNotConnected>>

Disconnects the TCP/IP connection from the Brick Daemon or the WIFI/Ethernet Extension.

pub fn get_connect_callback_receiver(&self) -> Receiver<ConnectReason>

This event is triggered whenever the IP Connection got connected to a Brick Daemon or to a WIFI/Ethernet Extension.

pub fn get_disconnect_callback_receiver(&self) -> Receiver<DisconnectReason>

This event is triggered whenever the IP Connection got disconnected from a Brick Daemon or to a WIFI/Ethernet Extension.

pub fn get_timeout(&self) -> Duration

Returns the timeout as set by set_timeout

pub fn set_timeout(&mut self, timeout: Duration)

Sets the timeout for getters and for setters for which the response expected flag is activated.

Default timeout is 2,5s.

pub fn get_connection_state(&self) -> ConnectionState

Queries the current connection state.

pub fn get_auto_reconnect(&self) -> bool

Returns true if auto-reconnect is enabled, false otherwise.

pub fn set_auto_reconnect(&mut self, auto_reconnect_enabled: bool)

Enables or disables auto-reconnect. If auto-reconnect is enabled, the IP Connection will try to reconnect to the previously given host and port, if the currently existing connection is lost. Therefore, auto-reconnect only does something after a successful connect call.

Default value is true.

pub fn enumerate(&self)

Broadcasts an enumerate request. All devices will respond with an enumerate event.

pub fn get_enumerate_callback_receiver(
    &self
) -> ConvertingCallbackReceiver<EnumerateResponse>

This receiver receives enumerate events, as described here.

pub fn authenticate(
    &self,
    secret: &str
) -> Result<ConvertingReceiver<()>, AuthenticateError>

Performs an authentication handshake with the connected Brick Daemon or WIFI/Ethernet Extension. If the handshake succeeds the connection switches from non-authenticated to authenticated state and communication can continue as normal. If the handshake fails then the connection gets closed. Authentication can fail if the wrong secret was used or if authentication is not enabled at all on the Brick Daemon or the WIFI/Ethernet Extension.

See the authentication tutorial for more information.

New in version 2.1.0.

Trait Implementations

impl Clone for IpConnectionRequestSender

fn clone(&self) -> IpConnectionRequestSender

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for IpConnectionRequestSender

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

Formats the value using the given formatter.

impl GetRequestSender for &IpConnectionRequestSender

fn get_rs(&self) -> IpConnectionRequestSender