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 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345
#![forbid(unsafe_code, unreachable_pub, unused_must_use)]
#![warn(missing_docs)]
#![allow(dead_code)]
//! Poster-rs is an asynchronous, runtime agnostic, zero-copy MQTT 5 library,
//! designed having operation locality in mind.
//!
//! ## Set up
//! Firstly, choose your async runtime. Ready? Lets go!
//!
//! In the below example we will use Tokio.
//!
//! ```no_run
//! use std::error::Error;
//! use poster::{prelude::*, ConnectOpts, Context};
//! use tokio::net::TcpStream;
//! use tokio_util::compat::{TokioAsyncReadCompatExt, TokioAsyncWriteCompatExt};
//!
//! #[tokio::main(flavor = "current_thread")]
//! async fn main() -> Result<(), Box<dyn Error>> {
//! let (mut ctx, mut handle) = Context::new();
//!
//! let ctx_task = tokio::spawn(async move {
//! // Set up a connection using your async framework of choice. We will need a read end, which is
//! // AsyncRead, and write end, which is AsyncWrite, so we split the TcpStream
//! // into ReadHalf and WriteHalf pair.
//! let (rx, tx) = TcpStream::connect("127.0.0.1:1883").await?.into_split();
//!
//! // Pass (ReadHalf, WriteHalf) pair into the context and connect with the broker on
//! // the protocol level.
//! ctx.set_up((rx.compat(), tx.compat_write())).connect(ConnectOpts::new()).await?;
//!
//! // Awaiting the Context::run invocation will block the current task.
//! if let Err(err) = ctx.run().await {
//! eprintln!("[context] Error occured: \"{}\", exiting...", err);
//! } else {
//! println!("[context] Context exited.");
//! }
//!
//! Ok::<(), Box<dyn Error + Send + Sync>>(())
//! });
//!
//! /* ... */
//!
//! ctx_task.await?;
//! Ok(())
//! }
//! ```
//!
//! At this point, our [context](crate::Context) is up and running.
//!
//! Let's break down the above example.
//! `poster-rs` is a runtime agnostic library, which means that all the asynchronous operations are abstracted
//! using traits from the `futures-rs` crate. The result of this approach is that connection with the broker
//! must be established manually and the library only cares about receving ([AsyncRead](https://docs.rs/futures/latest/futures/io/trait.AsyncRead.html),
//! [AsyncWrite](https://docs.rs/futures/latest/futures/io/trait.AsyncWrite.html)) pair during the context creation.
//! This pair is usually obtained using some sort of `split` functions on streams/sockets in the networking libraries.
//! (See [tokio](https://docs.rs/tokio/latest/tokio/net/struct.TcpStream.html#method.into_split), [smol](https://docs.rs/smol/latest/smol/io/fn.split.html))
//!
//! [new](Context::new) factory method gives us ([Context], [ContextHandle]) tuple. [Context] is responsible
//! for handling the traffic between the client and the server. [ContextHandle] however, is a [cloneable](Clone) handle
//! to the [Context] actor and is used to perform all the MQTT operations.
//!
//! Method [run](crate::Context::run) blocks the task (on .await) until one of the following conditions is met:
//! 1. Graceful disconnection is performed (using [ContextHandle::disconnect](crate::ContextHandle::disconnect) method).
//! The result is then ().
//! 2. Error occurs, resulting in [MqttError](crate::error::MqttError). This may be the result of socket closing,
//! receiving DISCONNECT from the server, etc.
//!
//! ## Publishing
//!
//! Publishing is performed via the [publish](crate::ContextHandle::publish) method.
//!
//! ```no_run
//! # use std::error::Error;
//! # use poster::{prelude::*, *};
//! # use tokio::net::TcpStream;
//! # use tokio_util::compat::{TokioAsyncReadCompatExt, TokioAsyncWriteCompatExt};
//! #
//! # #[tokio::main(flavor = "current_thread")]
//! # async fn main() -> Result<(), Box<dyn Error>> {
//! # let (mut ctx, mut handle) = Context::new();
//! # let ctx_task = tokio::spawn(async move {
//! # let (rx, tx) = TcpStream::connect("127.0.0.1:1883").await?.into_split();
//! # ctx.set_up((rx.compat(), tx.compat_write())).connect(ConnectOpts::new()).await?;
//! # ctx.run().await?;
//! # Ok::<(), Box<dyn Error + Send + Sync>>(())
//! # });
//! #
//! // ...
//! let opts = PublishOpts::new().topic_name("topic").payload("hello there".as_bytes());
//! handle.publish(opts).await?;
//! #
//! # ctx_task.await?;
//! # Ok(())
//! # }
//! ```
//!
//! See [PublishOpts](crate::PublishOpts).
//!
//! ## Subscriptions
//!
//! Subscriptions are represented as async streams, obtained via the [stream](crate::SubscribeRsp::stream) method.
//! The general steps of subscribing are:
//! - await the invocation of [subscribe](crate::ContextHandle::subscribe) method
//! - validate the result (optionally)
//! - use [stream](crate::SubscribeRsp::stream) method in order to create a stream for
//! the subscription.
//!
//! Note that under the hood, the library uses subscription identifiers to group subscriptions.
//!
//! See [SubscribeOpts](crate::SubscribeOpts).
//!
//! ```no_run
//! # use std::{error::Error, str};
//! # use poster::{prelude::*, *};
//! # use tokio::net::TcpStream;
//! # use tokio_util::compat::{TokioAsyncReadCompatExt, TokioAsyncWriteCompatExt};
//! #
//! # #[tokio::main(flavor = "current_thread")]
//! # async fn main() -> Result<(), Box<dyn Error>> {
//! # let (mut ctx, mut handle) = Context::new();
//! # let ctx_task = tokio::spawn(async move {
//! # let (rx, tx) = TcpStream::connect("127.0.0.1:1883").await?.into_split();
//! # ctx.set_up((rx.compat(), tx.compat_write())).connect(ConnectOpts::new()).await?;
//! # ctx.run().await?;
//! # Ok::<(), Box<dyn Error + Send + Sync>>(())
//! # });
//! #
//! // ...
//! let opts = SubscribeOpts::new().subscription("topic", SubscriptionOpts::new());
//! let rsp = handle.subscribe(opts).await?;
//! let mut subscription = rsp.stream();
//!
//! while let Some(msg) = subscription.next().await {
//! println!("topic: {}; payload: {}", msg.topic_name(), str::from_utf8(msg.payload()).unwrap());
//! }
//! #
//! # ctx_task.await?;
//! # Ok(())
//! # }
//! ```
//!
//! User may subscribe to multiple topics in one subscription request.
//!
//! ```no_run
//! # use std::{error::Error, str};
//! # use poster::{prelude::*, *};
//! # use tokio::net::TcpStream;
//! # use tokio_util::compat::{TokioAsyncReadCompatExt, TokioAsyncWriteCompatExt};
//! #
//! # #[tokio::main(flavor = "current_thread")]
//! # async fn main() -> Result<(), Box<dyn Error>> {
//! # let (mut ctx, mut handle) = Context::new();
//! # let ctx_task = tokio::spawn(async move {
//! # let (rx, tx) = TcpStream::connect("127.0.0.1:1883").await?.into_split();
//! # ctx.set_up((rx.compat(), tx.compat_write())).connect(ConnectOpts::new()).await?;
//! # ctx.run().await?;
//! # Ok::<(), Box<dyn Error + Send + Sync>>(())
//! # });
//! #
//! // ...
//! let opts = SubscribeOpts::new()
//! .subscription("topic1", SubscriptionOpts::new())
//! .subscription("topic2", SubscriptionOpts::new());
//!
//! let mut subscription = handle.subscribe(opts).await?.stream();
//!
//! while let Some(msg) = subscription.next().await {
//! println!("topic: {}; payload: {}", msg.topic_name(), str::from_utf8(msg.payload()).unwrap());
//! }
//! #
//! # ctx_task.await?;
//! # Ok(())
//! # }
//! ```
//!
//! Each subscription may be customized using the [SubscriptionOpts](crate::SubscriptionOpts).
//!
//! ```no_run
//! # use std::{error::Error, str};
//! # use poster::{prelude::*, *};
//! # use tokio::net::TcpStream;
//! # use tokio_util::compat::{TokioAsyncReadCompatExt, TokioAsyncWriteCompatExt};
//! #
//! # #[tokio::main(flavor = "current_thread")]
//! # async fn main() -> Result<(), Box<dyn Error>> {
//! # let (mut ctx, mut handle) = Context::new();
//! # let ctx_task = tokio::spawn(async move {
//! # let (rx, tx) = TcpStream::connect("127.0.0.1:1883").await?.into_split();
//! # ctx.set_up((rx.compat(), tx.compat_write())).connect(ConnectOpts::new()).await?;
//! # ctx.run().await?;
//! # Ok::<(), Box<dyn Error + Send + Sync>>(())
//! # });
//! #
//! let opts = SubscribeOpts::new()
//! .subscription("topic", SubscriptionOpts::new().maximum_qos(QoS::AtLeastOnce));
//! #
//! # ctx_task.await?;
//! # Ok(())
//! # }
//! ```
//!
//! [SubscribeRsp](crate::SubscribeRsp) struct represents the result of the subscription request. In order to access
//! per-topic reason codes, [payload](crate::SubscribeRsp::payload) method is used:
//!
//! ```no_run
//! # use std::{error::Error, str};
//! # use poster::{prelude::*, reason::SubackReason, *};
//! # use tokio::net::TcpStream;
//! # use tokio_util::compat::{TokioAsyncReadCompatExt, TokioAsyncWriteCompatExt};
//! #
//! # #[tokio::main(flavor = "current_thread")]
//! # async fn main() -> Result<(), Box<dyn Error>> {
//! # let (mut ctx, mut handle) = Context::new();
//! # let ctx_task = tokio::spawn(async move {
//! # let (rx, tx) = TcpStream::connect("127.0.0.1:1883").await?.into_split();
//! # ctx.set_up((rx.compat(), tx.compat_write())).connect(ConnectOpts::new()).await?;
//! # ctx.run().await?;
//! # Ok::<(), Box<dyn Error + Send + Sync>>(())
//! # });
//! #
//! # let opts = SubscribeOpts::new();
//! // ...
//! let rsp = handle.subscribe(opts).await?;
//! let all_ok = rsp.payload().iter().copied().all(|reason| reason == SubackReason::GranteedQoS2);
//! #
//! # ctx_task.await?;
//! # Ok(())
//! # }
//! ```
//!
//! ## Unsubscribing
//!
//! Unsubscribing is performed by the [unsubscribe](crate::ContextHandle::unsubscribe) method.
//! Note that it does NOT close the subscription stream (it could lead to logic errors).
//!
//! ```no_run
//! # use std::{error::Error, str};
//! # use poster::{prelude::*, *};
//! # use tokio::net::TcpStream;
//! # use tokio_util::compat::{TokioAsyncReadCompatExt, TokioAsyncWriteCompatExt};
//! #
//! # #[tokio::main(flavor = "current_thread")]
//! # async fn main() -> Result<(), Box<dyn Error>> {
//! # let (mut ctx, mut handle) = Context::new();
//! # let ctx_task = tokio::spawn(async move {
//! # let (rx, tx) = TcpStream::connect("127.0.0.1:1883").await?.into_split();
//! # ctx.set_up((rx.compat(), tx.compat_write())).connect(ConnectOpts::new()).await?;
//! # ctx.run().await?;
//! # Ok::<(), Box<dyn Error + Send + Sync>>(())
//! # });
//! // ...
//! let opts = UnsubscribeOpts::new().topic_filter("topic");
//! let rsp = handle.unsubscribe(opts).await?;
//! #
//! # ctx_task.await?;
//! # Ok(())
//! # }
//! ```
//!
//! As with subscribing, per topic reason codes can be obtained by the [payload](crate::UnsubscribeRsp::payload) method.
//!
//! See [UnsubscribeOpts](crate::UnsubscribeOpts).
//!
//! ## Keep alive and ping
//!
//! If the [keep_alive](crate::ConnectOpts::keep_alive) interval is set during the connection request,
//! the user must use the [ping](crate::ContextHandle::ping) method periodically.
//!
//! ## Disconnection
//!
//! Disconnection may be initiated either by user or the broker. When initiated by the broker, the [run](crate::Context::run) method
//! returns [Disconnected](crate::error::Disconnected) error.
//!
//! Graceful disconnection may be also performed by the user by using [disconnect](crate::ContextHandle::disconnect) method.
//! When disconnection is finished, [run](crate::Context::run) method returns ().
//!
//! ```no_run
//! # use std::{error::Error, str};
//! # use poster::{prelude::*, *};
//! # use tokio::net::TcpStream;
//! # use tokio_util::compat::{TokioAsyncReadCompatExt, TokioAsyncWriteCompatExt};
//! #
//! # #[tokio::main(flavor = "current_thread")]
//! # async fn main() -> Result<(), Box<dyn Error>> {
//! # let (mut ctx, mut handle) = Context::new();
//! # let ctx_task = tokio::spawn(async move {
//! # let (rx, tx) = TcpStream::connect("127.0.0.1:1883").await?.into_split();
//! # ctx.set_up((rx.compat(), tx.compat_write())).connect(ConnectOpts::new()).await?;
//! # ctx.run().await?;
//! # Ok::<(), Box<dyn Error + Send + Sync>>(())
//! # });
//! #
//! // ...
//! handle.disconnect(DisconnectOpts::new()).await?;
//! #
//! # ctx_task.await?;
//! # Ok(())
//! # }
//! ```
//!
//! See [DisconnectOpts](crate::DisconnectOpts).
//!
//! ## Error handling
//!
//! The main library error type is [MqttError](crate::error::MqttError) enum found in [error] module.
//!
//! ## TLS/SSL
//!
//! TLS/SSL libraries are available out there with AsyncRead, AsyncWrite TLS/SSL streams. These may be
//! supplied to the [set_up](crate::Context::set_up) method. The library does not handle encription on its own.
//!
mod client;
mod codec;
mod core;
mod io;
pub use crate::client::*;
pub use crate::codec::RetainHandling;
pub use crate::core::{QoS, UserProperties};
/// Reason codes for different operations.
///
pub mod reason {
pub use crate::codec::{
AuthReason, ConnectReason, DisconnectReason, PubackReason, PubcompReason, PubrecReason,
PubrelReason, SubackReason, UnsubackReason,
};
}
/// Library error types.
///
pub mod error {
pub use crate::client::error::*;
pub use crate::core::error::*;
}
/// Reexports.
///
pub mod prelude {
pub use either::Either;
pub use futures::stream::{Stream, StreamExt};
}