actix_mqtt_client/lib.rs
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 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651
//! # A MQTT client based on actix framework
//!
//! The `actix-mqtt-client` crate is a mqtt client based on the [actix](https://github.com/actix/actix) framework
//!
//! ## Basic usage and example
//!
//! First, create 2 actix actors, one for receiving publish messages, the other one for receiving error messages from the client, you can also create an optional actix actor for receiving the stop message:
//! ```rust
//! pub struct ErrorActor;
//!
//! impl actix::Actor for ErrorActor {
//! type Context = actix::Context<Self>;
//! }
//!
//! impl actix::Handler<ErrorMessage> for ErrorActor {
//! type Result = ();
//! fn handle(&mut self, error: ErrorMessage, _: &mut Self::Context) -> Self::Result {
//! log::error!("{}", error.0);
//! }
//! }
//!
//! pub struct MessageActor;
//!
//! impl actix::Actor for MessageActor {
//! type Context = actix::Context<Self>;
//! }
//!
//! impl actix::Handler<PublishMessage> for MessageActor {
//! type Result = ();
//! fn handle(
//! &mut self,
//! msg: PublishMessage,
//! _: &mut Self::Context,
//! ) -> Self::Result {
//! log::info!(
//! "Got message: id:{}, topic: {}, payload: {:?}",
//! msg.id,
//! msg.topic_name,
//! msg.payload
//! );
//! }
//! }
//! ```
//!
//! Then, connect to the server(using tokio) and use the read and write part of the stream along with the actors to create a [MqttClient](struct.MqttClient.html):
//! ```rust
//! use std::io::Error as IoError;
//! use std::net::SocketAddr;
//! use std::str::FromStr;
//! use std::time::Duration;
//! use actix::{Actor, Arbiter, System};
//! use env_logger;
//! use tokio::io::split;
//! use tokio::net::TcpStream;
//! use tokio::time::{sleep_until, Instant};
//! use actix_mqtt_client::client::{MqttClient, MqttOptions};
//!
//! let sys = System::new();
//! let socket_addr = SocketAddr::from_str("127.0.0.1:1883").unwrap();
//! sys.block_on(async move {
//! let result = async move {
//! let stream = TcpStream::connect(socket_addr).await?;
//! let (r, w) = split(stream);
//! log::info!("TCP connected");
//! let mut client = MqttClient::new(
//! r,
//! w,
//! String::from("test"),
//! MqttOptions::default(),
//! MessageActor.start().recipient(),
//! ErrorActor.start().recipient(),
//! None,
//! );
//! client.connect().await?;
//! // Waiting for the client to be connected
//! while !client.is_connected().await? {
//! let delay_time = Instant::now() + Duration::new(1, 0);
//! sleep_until(delay_time).await;
//! }
//! log::info!("MQTT connected");
//! log::info!("Subscribe");
//! client
//! .subscribe(String::from("test"), mqtt::QualityOfService::Level2)
//! .await?;
//! log::info!("Publish");
//! client
//! .publish(
//! String::from("test"),
//! mqtt::QualityOfService::Level0,
//! Vec::from("test".as_bytes()),
//! )
//! .await?;
//! log::info!("Wait for 10s");
//! let delay_time = Instant::now() + Duration::new(10, 0);
//! sleep_until(delay_time).await;
//! client
//! .publish(
//! String::from("test"),
//! mqtt::QualityOfService::Level1,
//! Vec::from("test2".as_bytes()),
//! )
//! .await?;
//! log::info!("Wait for 10s");
//! let delay_time = Instant::now() + Duration::new(10, 0);
//! sleep_until(delay_time).await;
//! client
//! .publish(
//! String::from("test"),
//! mqtt::QualityOfService::Level2,
//! Vec::from("test3".as_bytes()),
//! )
//! .await?;
//! log::info!("Wait for 10s");
//! let delay_time = Instant::now() + Duration::new(10, 0);
//! sleep_until(delay_time).await;
//! log::info!("Disconnect");
//! client.disconnect(false).await?;
//! log::info!("Check if disconnect is successful");
//! Ok(assert_eq!(true, client.is_disconnected())) as Result<(), IoError>
//! }
//! .await;
//! result.unwrap()
//! });
//! sys.run().unwrap();
//! ```
mod actors;
mod client;
mod consts;
pub use actix;
pub use futures;
pub use mqtt::QualityOfService;
pub use tokio;
pub use crate::actors::packets::PublishMessage;
pub use crate::actors::{ErrorMessage, StopMessage};
pub use crate::client::{MqttClient, MqttOptions};
#[cfg(test)]
mod tests {
pub struct ErrorActor;
impl actix::Actor for ErrorActor {
type Context = actix::Context<Self>;
}
impl actix::Handler<super::ErrorMessage> for ErrorActor {
type Result = ();
fn handle(&mut self, error: super::ErrorMessage, _: &mut Self::Context) -> Self::Result {
log::error!("{}", error.0);
}
}
pub struct MessageActor;
impl actix::Actor for MessageActor {
type Context = actix::Context<Self>;
}
impl actix::Handler<crate::actors::packets::PublishMessage> for MessageActor {
type Result = ();
fn handle(
&mut self,
msg: crate::actors::packets::PublishMessage,
_: &mut Self::Context,
) -> Self::Result {
log::info!(
"Got message: id:{}, topic: {}, payload: {:?}",
msg.id,
msg.topic_name,
msg.payload
);
}
}
#[test]
fn test_client() {
use std::io::Error as IoError;
use std::net::SocketAddr;
use std::str::FromStr;
use std::time::Duration;
use actix::{Actor, System};
use env_logger;
use tokio::io::split;
use tokio::net::TcpStream;
use tokio::time::{sleep_until, Instant};
use crate::client::{MqttClient, MqttOptions};
env_logger::init();
let sys = System::new();
let socket_addr = SocketAddr::from_str("127.0.0.1:1883").unwrap();
sys.block_on(async move {
let result = async move {
let stream = TcpStream::connect(socket_addr).await?;
let (r, w) = split(stream);
log::info!("TCP connected");
let mut client = MqttClient::new(
r,
w,
String::from("test"),
MqttOptions::default(),
MessageActor.start().recipient(),
ErrorActor.start().recipient(),
None,
);
client.connect().await?;
while !client.is_connected().await.unwrap() {
log::info!("Waiting for client to be connected");
let delay_time = Instant::now() + Duration::new(0, 100);
sleep_until(delay_time).await;
}
log::info!("MQTT connected");
log::info!("Subscribe");
client
.subscribe(String::from("test"), mqtt::QualityOfService::Level2)
.await?;
log::info!("Publish");
client
.publish(
String::from("test"),
mqtt::QualityOfService::Level0,
Vec::from("test".as_bytes()),
)
.await?;
log::info!("Wait for 1s");
let delay_time = Instant::now() + Duration::new(1, 0);
sleep_until(delay_time).await;
client
.publish(
String::from("test"),
mqtt::QualityOfService::Level1,
Vec::from("test2".as_bytes()),
)
.await?;
log::info!("Wait for 1s");
let delay_time = Instant::now() + Duration::new(1, 0);
sleep_until(delay_time).await;
client
.publish(
String::from("test"),
mqtt::QualityOfService::Level2,
Vec::from("test3".as_bytes()),
)
.await?;
log::info!("Wait for 1s");
let delay_time = Instant::now() + Duration::new(1, 0);
sleep_until(delay_time).await;
log::info!("Disconnect");
client.disconnect(false).await?;
log::info!("Check if disconnect is successful");
for _ in (0 as i32)..5 {
if client.is_disconnected() {
break;
}
let delay_time = Instant::now() + Duration::new(0, 200);
sleep_until(delay_time).await;
}
Ok(assert_eq!(true, client.is_disconnected())) as Result<(), IoError>
}
.await;
let r = result.unwrap();
System::current().stop();
r
});
sys.run().unwrap();
}
}
#[cfg(test)]
mod random_test {
use tokio::sync::mpsc::{channel, Sender};
pub struct ErrorActor;
impl actix::Actor for ErrorActor {
type Context = actix::Context<Self>;
}
impl actix::Handler<super::ErrorMessage> for ErrorActor {
type Result = ();
fn handle(&mut self, error: super::ErrorMessage, _: &mut Self::Context) -> Self::Result {
log::error!("{}", error.0);
}
}
pub struct MessageActor(Sender<(bool, Vec<u8>)>);
impl actix::Actor for MessageActor {
type Context = actix::Context<Self>;
}
impl actix::Handler<crate::actors::packets::PublishMessage> for MessageActor {
type Result = ();
fn handle(
&mut self,
msg: crate::actors::packets::PublishMessage,
_: &mut Self::Context,
) -> Self::Result {
log::info!(
"Got message: id:{}, topic: {}, payload: {:?}",
msg.id,
msg.topic_name,
msg.payload
);
self.0.try_send((false, msg.payload)).unwrap();
}
}
lazy_static::lazy_static! {
static ref PACKETS: std::sync::Mutex<std::collections::HashSet<Vec<u8>>> = std::sync::Mutex::new(std::collections::HashSet::new());
}
#[test]
fn test_random_publish_level0_cloned_client() {
use std::io::Error as IoError;
use std::net::SocketAddr;
use std::str::FromStr;
use std::time::Duration;
use actix::{Actor, Arbiter, System};
use env_logger;
use futures::stream::StreamExt;
use tokio::io::split;
use tokio::net::TcpStream;
use tokio::time::{sleep_until, Instant};
use tokio_stream::wrappers::ReceiverStream;
use crate::client::{MqttClient, MqttOptions};
env_logger::init();
let (sender, recv) = channel(100);
let sys = System::new();
let socket_addr = SocketAddr::from_str("127.0.0.1:1883").unwrap();
sys.block_on(async move {
let future = async move {
let result = async move {
let stream = TcpStream::connect(socket_addr).await?;
let (r, w) = split(stream);
let mut client = MqttClient::new(
r,
w,
String::from("test"),
MqttOptions::default(),
MessageActor(sender.clone()).start().recipient(),
ErrorActor.start().recipient(),
None,
);
client.connect().await?;
while !client.is_connected().await.unwrap() {
log::info!("Waiting for client to be connected");
let delay_time = Instant::now() + Duration::new(0, 100);
sleep_until(delay_time).await;
}
log::info!("Connected");
log::info!("Subscribe");
client
.subscribe(String::from("test"), mqtt::QualityOfService::Level0)
.await?;
async fn random_send(
client_id: i32,
client: MqttClient,
sender: Sender<(bool, Vec<u8>)>,
) {
let mut count: i32 = 0;
loop {
count += 1;
use rand::RngCore;
let mut data = [0u8; 32];
rand::thread_rng().fill_bytes(&mut data);
let payload = Vec::from(&data[..]);
log::info!("[{}:{}] Publish {:?}", client_id, count, payload);
sleep_until(Instant::now() + Duration::from_millis(100)).await;
sender.try_send((true, payload.clone())).unwrap();
client
.publish(
String::from("test"),
mqtt::QualityOfService::Level0,
payload,
)
.await
.unwrap();
}
}
for i in 0..5 {
let client_clone = client.clone();
let sender_clone = sender.clone();
let future = random_send(i, client_clone, sender_clone);
Arbiter::current().spawn(future);
}
Ok(()) as Result<(), IoError>
}
.await;
result.unwrap();
};
Arbiter::current().spawn(future);
let recv_future = async {
let result = async {
ReceiverStream::new(recv)
.fold((), |_, (is_send, payload)| async move {
let mut p = PACKETS.lock().unwrap();
if is_send {
p.insert(payload);
} else if p.contains(&payload) {
p.remove(&payload);
}
log::info!("Pending recv items: {}", p.len());
()
})
.await;
Ok(()) as Result<(), IoError>
}
.await;
result.unwrap()
};
Arbiter::current().spawn(recv_future);
});
sys.run().unwrap();
}
#[test]
fn test_random_publish_level0_created_client() {
use std::io::Error as IoError;
use std::net::SocketAddr;
use std::str::FromStr;
use std::time::Duration;
use actix::{Actor, Arbiter, System};
use env_logger;
use futures::stream::StreamExt;
use tokio::io::split;
use tokio::net::TcpStream;
use tokio::time::{sleep_until, Instant};
use tokio_stream::wrappers::ReceiverStream;
use crate::client::{MqttClient, MqttOptions};
env_logger::init();
async fn test_send(client_id: i32, sender: Sender<(bool, Vec<u8>)>) {
let socket_addr = SocketAddr::from_str("127.0.0.1:1883").unwrap();
async move {
let stream = TcpStream::connect(socket_addr).await?;
let (r, w) = split(stream);
let mut client = MqttClient::new(
r,
w,
format!("test_{}", client_id),
MqttOptions::default(),
MessageActor(sender.clone()).start().recipient(),
ErrorActor.start().recipient(),
None,
);
client.connect().await?;
while !client.is_connected().await.unwrap() {
log::info!("Waiting for client to be connected");
let delay_time = Instant::now() + Duration::new(0, 100);
sleep_until(delay_time).await;
}
log::info!("Connected");
log::info!("Subscribe");
client
.subscribe(String::from("test"), mqtt::QualityOfService::Level0)
.await?;
async fn random_send(
client_id: i32,
client: MqttClient,
sender: Sender<(bool, Vec<u8>)>,
) {
let mut count: i32 = 0;
loop {
count += 1;
use rand::RngCore;
let mut data = [0u8; 32];
rand::thread_rng().fill_bytes(&mut data);
let payload = Vec::from(&data[..]);
log::info!("[{}:{}] Publish {:?}", client_id, count, payload);
sleep_until(Instant::now() + Duration::from_millis(100)).await;
sender.try_send((true, payload.clone())).unwrap();
client
.publish(
String::from("test"),
mqtt::QualityOfService::Level0,
payload,
)
.await
.unwrap();
}
}
let future = random_send(client_id, client, sender);
Arbiter::current().spawn(future);
Ok(()) as Result<(), IoError>
}
.await
.unwrap();
}
let sys = System::new();
sys.block_on(async move {
let (sender, recv) = channel(100);
for i in 0..5 {
let future = test_send(i, sender.clone());
Arbiter::current().spawn(future);
}
let recv_future = async {
let result = async {
ReceiverStream::new(recv)
.fold((), |_, (is_send, payload)| async move {
let mut p = PACKETS.lock().unwrap();
if is_send {
p.insert(payload);
} else if p.contains(&payload) {
p.remove(&payload);
}
log::info!("Pending recv items: {}", p.len());
()
})
.await;
Ok(()) as Result<(), IoError>
}
.await;
result.unwrap()
};
Arbiter::current().spawn(recv_future);
});
sys.run().unwrap();
}
#[test]
fn test_random_publish_level2() {
use std::io::Error as IoError;
use std::net::SocketAddr;
use std::str::FromStr;
use std::time::Duration;
use actix::{Actor, Arbiter, System};
use env_logger;
use futures::stream::StreamExt;
use tokio::io::split;
use tokio::net::TcpStream;
use tokio::time::{sleep_until, Instant};
use tokio_stream::wrappers::ReceiverStream;
use crate::client::{MqttClient, MqttOptions};
env_logger::init();
let (sender, recv) = channel(100);
let sender_clone = sender.clone();
let sys = System::new();
sys.block_on(async move {
let socket_addr = SocketAddr::from_str("127.0.0.1:1883").unwrap();
let future = async move {
let result = async move {
let stream = TcpStream::connect(socket_addr).await?;
let (r, w) = split(stream);
let mut client = MqttClient::new(
r,
w,
String::from("test"),
MqttOptions::default(),
MessageActor(sender).start().recipient(),
ErrorActor.start().recipient(),
None,
);
client.connect().await?;
while !client.is_connected().await.unwrap() {
log::info!("Waiting for client to be connected");
let delay_time = Instant::now() + Duration::new(0, 100);
sleep_until(delay_time).await;
}
log::info!("Connected");
log::info!("Subscribe");
client
.subscribe(String::from("test"), mqtt::QualityOfService::Level2)
.await?;
futures::stream::repeat(())
.fold((client, sender_clone), |(client, sender), _| async {
use rand::RngCore;
let mut data = [0u8; 32];
rand::thread_rng().fill_bytes(&mut data);
let payload = Vec::from(&data[..]);
log::info!("Publish {:?}", payload);
sleep_until(Instant::now() + Duration::from_millis(10)).await;
sender.try_send((true, payload.clone())).unwrap();
client
.publish(
String::from("test"),
mqtt::QualityOfService::Level2,
payload,
)
.await
.unwrap();
(client, sender)
})
.await;
Ok(()) as Result<(), IoError>
}
.await;
result.unwrap()
};
Arbiter::current().spawn(future);
let recv_future = async {
let result = async {
ReceiverStream::new(recv)
.fold((), |_, (is_send, payload)| async move {
let mut p = PACKETS.lock().unwrap();
if is_send {
p.insert(payload);
} else if !p.contains(&payload) {
panic!("Multiple receive for level 2: {:?}", payload);
} else {
p.remove(&payload);
}
log::info!("Pending recv items: {}", p.len());
()
})
.await;
Ok(()) as Result<(), IoError>
}
.await;
result.unwrap()
};
Arbiter::current().spawn(recv_future);
});
sys.run().unwrap();
}
}