Skip to main content

Client

Struct Client 

Source
pub struct Client<T: Transport> { /* private fields */ }
Expand description

A connected client.

Implementations§

Source§

impl<T: Transport> Client<T>

Source

pub fn connect(io: T, opts: Options) -> Result<Self>

Send CONNECT over io and wait for the broker’s answer.

Source

pub fn session_present(&self) -> bool

Whether the broker kept a session for this client id.

Source

pub fn stats(&self) -> Stats

Source

pub fn publish( &mut self, topic: &str, payload: &[u8], qos: QoS, retain: bool, ) -> Result<()>

Publish a message. QoS 1 waits for the broker’s PUBACK; QoS 2 is not supported.

Source

pub fn subscribe(&mut self, filter: &str, qos: QoS) -> Result<()>

Subscribe to a topic filter (+ and # allowed) and wait for the SUBACK.

Source

pub fn unsubscribe(&mut self, filter: &str) -> Result<()>

Unsubscribe from a topic filter and wait for the UNSUBACK.

Source

pub fn poll(&mut self, wait: Duration) -> Result<Option<Message>>

Wait up to wait for a message. Also answers the broker’s acknowledgements and sends a PINGREQ when the connection has been idle, so call it at least every few seconds.

Source

pub fn disconnect(self) -> Result<T>

Say goodbye (no will message is sent) and give the transport back.

Trait Implementations§

Source§

impl<T: Debug + Transport> Debug for Client<T>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<T> Forget for Client<T>

§

impl<T> Freeze for Client<T>
where T: Freeze,

§

impl<T> Move for Client<T>

§

impl<T> RefUnwindSafe for Client<T>
where T: RefUnwindSafe,

§

impl<T> Send for Client<T>
where T: Send,

§

impl<T> Sync for Client<T>
where T: Sync,

§

impl<T> Unpin for Client<T>
where T: Unpin,

§

impl<T> UnsafeUnpin for Client<T>
where T: UnsafeUnpin,

§

impl<T> UnwindSafe for Client<T>
where T: UnwindSafe,

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>,

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

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

Source§

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.