pub struct TelemetryClient { /* private fields */ }
Expand description

The telemetry client for reporting telemetry data over MQTT.

Implementations§

source§

impl TelemetryClient

source

pub fn new( mqtt: Minimq<'static, NetworkReference, SystemTimer, NamedBroker<NetworkReference>>, prefix: &str, metadata: &'static ApplicationMetadata ) -> Self

Construct a new telemetry client.

§Args
  • mqtt - The MQTT client
  • prefix - The device prefix to use for MQTT telemetry reporting.
§Returns

A new telemetry client.

source

pub fn publish<T: Serialize>(&mut self, telemetry: &T)

Publish telemetry over MQTT

§Note

Telemetry is reported in a “best-effort” fashion. Failure to transmit telemetry will cause it to be silently dropped.

§Args
  • telemetry - The telemetry to report
source

pub fn update(&mut self)

Update the telemetry client

§Note

This function is provided to force the underlying MQTT state machine to process incoming and outgoing messages. Without this, the client will never connect to the broker. This should be called regularly.

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.