masaka 0.1.0

A highly modular, no-std async MQTT client
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44

#[cfg(feature = "tokio")]
mod tokio;
#[cfg(feature = "tokio")]
pub use tokio::TcpTransport;

#[cfg(feature = "embassy")]
mod embassy;
#[cfg(feature = "embassy")]
pub use embassy::TcpTransport;

#[cfg(test)]
mod mock;
#[cfg(test)]
pub use mock::MockTransport;

use embedded_io_async::{Read, Write};

use crate::error::TransportError;

/// An abstract transport for MQTT connections.
///
/// This allows the MQTT client to be generic over different network stacks.
#[allow(async_fn_in_trait)]
pub trait MqttTransport: Read<Error = TransportError> + Write<Error = TransportError> {
    /// Closes the connection gracefully.
    ///
    /// Should be safe to call multiple times.
    async fn close(&mut self) -> Result<(), TransportError>;

    /// Checks if the connection is active.
    ///
    /// Returns `true` if the transport can send and receive data.
    fn is_connected(&self) -> bool;

    /// Returns the local address of the connection, if available.
    fn local_addr(&self) -> Option<&str> {
        None
    }

    /// Returns the remote address of the connection, if available.
    fn remote_addr(&self) -> Option<&str> {
        None
    }
}