Struct Client 

pub struct Client { /* private fields */ }

Fundamentum IoT Async Client

Implementations

impl Client

pub async fn new(settings: ClientSettings) -> Result<Self, Error>

Create new FundamentumIoTAsyncClient. Input argument should be the FundamentumIoTSettings. Returns a tuple where the first element is the FundamentumIoTAsyncClient, and the second element is a new tuple with the eventloop and incoming event sender. This tuple should be sent as an argument to the async_event_loop_listener.

Errors

If the creation failed then the result returns an error FundamentumIoTError

pub async fn run(&self) -> Result<(), Error>

Run the client’s background task.

This task continuously polls the underlying even loop which ensures messages are exchanged between this client and the broker.

Nothing will be exchanged until this task is run.

Errors

Returns an error::Error if a fatal MQTT connection error occurs that cannot be retried or recovered from. The underlying ConnectionError is considered fatal if it matches one of the following MQTT connection refusal codes:

• ProtocolError
• UnsupportedProtocolVersion
• ClientIdentifierNotValid
• BadUserNamePassword
• NotAuthorized
• Banned
• BadAuthenticationMethod
• UseAnotherServer
• ServerMoved

In these cases, the client will terminate with an error. For all other connection errors (such as temporary network issues), the client will attempt to reconnect automatically (backoff).

Any error returned by this function indicates that the client can no longer function and requires user intervention.

pub async fn subscribe_config(&self, qos: QoS) -> Result<(), ClientError>

Subscribe to device’s config channel

Reference

• registries/{REGISTRY_ID}/devices/{DEVICE_SN}/config

Errors

Returns ClientError if the request failed

pub async fn subscribe_portforward(&self, qos: QoS) -> Result<(), ClientError>

Subscribe to device’s port forward channel

Reference

• registries/{REGISTRY_ID}/devices/{DEVICE_SN}/portforward/tx

Errors

Returns ClientError if the request failed

pub async fn subscribe_commands(&self, qos: QoS) -> Result<(), ClientError>

Subscribe to device’s commands channel

Reference

• registries/{REGISTRY_ID}/devices/{DEVICE_SN}/commands

Errors

Returns ClientError if the request failed

pub async fn subscribe_actions(&self, qos: QoS) -> Result<(), ClientError>

Subscribe to device’s actions channel

Reference

• registries/{REGISTRY_ID}/devices/{DEVICE_SN}/actions

Errors

Returns ClientError if the request failed

pub fn get_receiver(&self) -> Receiver<Message>

Get a receiver of the incoming messages. Send this to any function that wants to read the incoming messages from IoT Core.

Note that it is very important that your retrieve your receiver prior to any subscribe_ of interest. Otherwise, you most likely won’t receive messages sent to you in between this call and prior subscriptions.

This is of particular importance for messages returned as a result to your subscription.

pub fn get_client(self) -> AsyncClient

If you want to use the Rumqttc AsyncClient and EventLoop manually, this method can be used to get the AsyncClient.

pub fn status_stream(&self) -> ClientStatusStream

Monitor our client’s statuses over time.

The returned ClientStatusStream is a futures::Stream of ClientStatus that can also provide the most recent status through its current method.

Returns

The streamable monitor instance.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Publisher for Client

type Error = Error

Error type related to a failed publish.

async fn publish_with<P: Publishable + Send>( &self, publishable: P, options: PublishOptions, ) -> Result<(), Self::Error>

Publish the publishable structure with PublishOptions overriding all other options, including the Publishable::publish_overrides(). If no options are provided, fallback options shall be used.

fn publish<P>( &self, publishable: P, ) -> impl Future<Output = Result<(), Self::Error>> + Send

where P: Publishable + Send + 'static,

Publish the publishable structure without overriding PublishOptions.