https://github.com/gunnarmorrigan/mqrstt
Pure rust async MQTTv5 client
https://github.com/gunnarmorrigan/mqrstt
async iot mqtt mqtt-client mqttv5 mqttv5-client network-programming rust
Last synced: 22 days ago
JSON representation
Pure rust async MQTTv5 client
- Host: GitHub
- URL: https://github.com/gunnarmorrigan/mqrstt
- Owner: GunnarMorrigan
- License: mpl-2.0
- Created: 2022-10-27T23:47:15.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-12-06T21:43:14.000Z (5 months ago)
- Last Synced: 2025-04-06T09:06:44.342Z (22 days ago)
- Topics: async, iot, mqtt, mqtt-client, mqttv5, mqttv5-client, network-programming, rust
- Language: Rust
- Homepage:
- Size: 711 KB
- Stars: 40
- Watchers: 1
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# `📟 MQRSTT`
[](https://crates.io/crates/mqrstt)
[](https://docs.rs/mqrstt)
[](https://deps.rs/repo/github/GunnarMorrigan/mqrstt)
[](https://app.codecov.io/gh/GunnarMorrigan/mqrstt)
`MQRSTT` is an MQTTv5 client that provides sync and async (smol and tokio) implementation.
Because this crate aims to be runtime agnostic the user is required to provide their own data stream.
The stream has to implement the smol or tokio [`AsyncRead`] and [`AsyncWrite`] traits.
## Features
- MQTT v5
- Runtime agnostic (Smol, Tokio)
- TLS/TCP
- Lean
- Keep alive depends on actual communication
- This tokio implemention has been fuzzed using cargo-fuzz!
### To do
- Even More testing
- Add TLS examples to repository
## MSRV
From 0.3 the tokio and smol variants will require MSRV: 1.75 due to async fn in trait feature.
## TCP & TLS Examples
### Notes:
- Your handler should not wait too long
- Create a new connection when an error or disconnect is encountered
- Handlers only get incoming packets
### Smol example:
```rust
use mqrstt::{
packets::{self, Packet},
AsyncEventHandler, MqttClient, NetworkBuilder, NetworkStatus,
};
pub struct PingPong {
pub client: MqttClient,
}
impl AsyncEventHandler for PingPong {
// Handlers only get INCOMING packets. This can change later.
async fn handle(&mut self, event: packets::Packet) {
match event {
Packet::Publish(p) => {
if let Ok(payload) = String::from_utf8(p.payload.to_vec()) {
if payload.to_lowercase().contains("ping") {
self.client.publish(p.topic.clone(), p.qos, p.retain, b"pong").await.unwrap();
println!("Received Ping, Send pong!");
}
}
}
Packet::ConnAck(_) => {
println!("Connected!")
}
_ => (),
}
}
}
fn main() {
smol::block_on(async {
let (mut network, client) = NetworkBuilder::new_from_client_id("mqrsttSmolExample").smol_network();
let stream = smol::net::TcpStream::connect(("broker.emqx.io", 1883)).await.unwrap();
let mut pingpong = PingPong { client: client.clone() };
network.connect(stream, &mut pingpong).await.unwrap();
// This subscribe is only processed when we run the network
client.subscribe("mqrstt").await.unwrap();
let task_handle = smol::spawn(async move {
let result = network.run(&mut pingpong).await;
(result, pingpong)
});
smol::Timer::after(std::time::Duration::from_secs(30)).await;
client.disconnect().await.unwrap();
let (result, _pingpong) = task_handle.await;
assert!(result.is_ok());
assert_eq!(result.unwrap(), NetworkStatus::OutgoingDisconnect);
});
}
```
### Tokio example:
```rust
use mqrstt::{
packets::{self, Packet},
AsyncEventHandler, MqttClient, NetworkBuilder, NetworkStatus,
};
use tokio::time::Duration;
pub struct PingPong {
pub client: MqttClient,
}
impl AsyncEventHandler for PingPong {
// Handlers only get INCOMING packets.
async fn handle(&mut self, event: packets::Packet) {
match event {
Packet::Publish(p) => {
if let Ok(payload) = String::from_utf8(p.payload.to_vec()) {
if payload.to_lowercase().contains("ping") {
self.client.publish(p.topic.clone(), p.qos, p.retain, b"pong").await.unwrap();
println!("Received Ping, Send pong!");
}
}
}
Packet::ConnAck(_) => {
println!("Connected!")
}
_ => (),
}
}
}
#[tokio::main]
async fn main() {
let (mut network, client) = NetworkBuilder::new_from_client_id("TokioTcpPingPongExample").tokio_network();
let stream = tokio::net::TcpStream::connect(("broker.emqx.io", 1883)).await.unwrap();
let stream = tokio::io::BufStream::new(stream);
let mut pingpong = PingPong { client: client.clone() };
network.connect(stream, &mut pingpong).await.unwrap();
client.subscribe("mqrstt").await.unwrap();
let network_handle = tokio::spawn(async move {
let result = network.run(&mut pingpong).await;
(result, pingpong)
});
tokio::time::sleep(Duration::from_secs(30)).await;
client.disconnect().await.unwrap();
let (result, _pingpong) = network_handle.await.unwrap();
assert!(result.is_ok());
assert_eq!(result.unwrap(), NetworkStatus::OutgoingDisconnect);
}
```
## FAQ
- Not much gets frequently asked, so please do! :)
- Open to feature requests
## License
Licensed under
* Mozilla Public License, Version 2.0, [(MPL-2.0)](https://choosealicense.com/licenses/mpl-2.0/)
## Contribution
Unless you explicitly state otherwise, any contribution intentionally
submitted for inclusion in the work by you, shall be licensed under MPL-2.0, without any additional terms or
conditions.