mqtt5 0.31.2

Complete MQTT v5.0 platform with high-performance async client and full-featured broker supporting TCP, TLS, WebSocket, authentication, bridging, and resource monitoring
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
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

//! Message queuing for offline MQTT clients
//!
//! Handles queuing of messages for clients that are temporarily offline.

use super::{QueuedMessage, Storage, StorageBackend};
use crate::error::Result;
use crate::packet::publish::PublishPacket;
use crate::QoS;
use tracing::debug;

/// Message queue manager for offline clients
pub struct MessageQueue<B: StorageBackend> {
    storage: Storage<B>,
}

impl<B: StorageBackend + 'static> MessageQueue<B> {
    /// Create new message queue manager
    #[must_use]
    pub fn new(storage: Storage<B>) -> Self {
        Self { storage }
    }

    /// Queue message for offline client.
    ///
    /// # Errors
    /// Returns an error if the storage backend fails.
    pub async fn enqueue(
        &self,
        client_id: &str,
        packet: PublishPacket,
        qos: QoS,
        packet_id: Option<u16>,
    ) -> Result<()> {
        let message = QueuedMessage::new(packet, client_id.to_string(), qos, packet_id);

        debug!("Queueing message for offline client: {}", client_id);
        self.storage.queue_message(message).await
    }

    /// Get all queued messages for client.
    ///
    /// # Errors
    /// Returns an error if the storage backend fails.
    pub async fn dequeue_all(&self, client_id: &str) -> Result<Vec<QueuedMessage>> {
        let messages = self.storage.get_queued_messages(client_id).await?;

        if !messages.is_empty() {
            debug!(
                "Retrieved {} queued messages for client: {}",
                messages.len(),
                client_id
            );

            // Remove messages from storage after retrieval
            self.storage.remove_queued_messages(client_id).await?;
        }

        Ok(messages)
    }

    /// Get count of queued messages for client.
    ///
    /// # Errors
    /// Returns an error if the storage backend fails.
    pub async fn count(&self, client_id: &str) -> Result<usize> {
        let messages = self.storage.get_queued_messages(client_id).await?;
        Ok(messages.len())
    }

    /// Clear all queued messages for client.
    ///
    /// # Errors
    /// Returns an error if the storage backend fails.
    pub async fn clear(&self, client_id: &str) -> Result<()> {
        debug!("Clearing all queued messages for client: {}", client_id);
        self.storage.remove_queued_messages(client_id).await
    }

    /// Check if client has queued messages.
    ///
    /// # Errors
    /// Returns an error if the storage backend fails.
    pub async fn has_messages(&self, client_id: &str) -> Result<bool> {
        let count = self.count(client_id).await?;
        Ok(count > 0)
    }
}