Skip to main content

Module queue

Module queue 

Source
Expand description

Distributed queue management Copyright © 2025-2026 Wenze Wei. All Rights Reserved.

This file is part of Ri. The Ri project belongs to the Dunimd Team.

Licensed under the Apache License, Version 2.0 (the “License”); You may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

§Queue Module

This module provides a comprehensive queueing system for Ri, offering a unified interface with support for multiple backend implementations. It enables reliable message passing and task scheduling across distributed systems.

§Key Components

  • RiQueueModule: Main queue module implementing service module traits
  • RiQueueManager: Central queue management component
  • RiQueue: Unified queue interface implemented by all backends
  • RiQueueConfig: Configuration for queue behavior
  • RiQueueMessage: Message structure for queue operations
  • RiQueueConsumer: Interface for consuming messages from queues
  • RiQueueProducer: Interface for producing messages to queues
  • RiQueueBackendType: Enum defining supported queue backends
  • RiQueueStats: Statistics for queue monitoring

§Design Principles

  1. Unified Interface: Consistent API across all backend implementations
  2. Multiple Backends: Support for different queue storage options
  3. Async Support: Full async/await compatibility
  4. Reliable Delivery: Ensures messages are delivered reliably
  5. Configurable: Highly configurable queue behavior
  6. Service Module Integration: Implements service module traits for seamless integration
  7. Thread-safe: Safe for concurrent use across multiple threads
  8. Statistics Collection: Built-in queue statistics for monitoring

§Usage

use ri::prelude::*;
use serde::{Serialize, Deserialize};
 
#[derive(Debug, Serialize, Deserialize)]
struct Task {
    id: String,
    data: String,
}
 
async fn example() -> RiResult<()> {
    // Create queue configuration
    let queue_config = RiQueueConfig {
        enabled: true,
        backend_type: RiQueueBackendType::Memory,
        default_queue_name: "default".to_string(),
        max_retry_count: 3,
        retry_delay_ms: 1000,
        queue_url: "".to_string(), // Not needed for memory backend
    };
     
    // Create queue module
    let queue_module = RiQueueModule::new(queue_config);
     
    // Get queue manager
    let queue_manager = queue_module.queue_manager();
     
    // Get queue instance
    let queue = queue_manager.read().await.queue("example_queue").await?;
     
    // Create producer and consumer
    let producer = queue.producer().await?;
    let consumer = queue.consumer().await?;
     
    // Create a task message
    let task = Task {
        id: "task-123".to_string(),
        data: "Hello, Ri Queue!".to_string(),
    };
     
    // Send message to queue
    let message_id = producer.send(&task).await?;
    println!("Sent message with ID: {}", message_id);
     
    // Receive message from queue
    if let Some(message) = consumer.receive().await? {
        let received_task: Task = message.deserialize()?;
        println!("Received task: {:?}", received_task);
         
        // Acknowledge message
        message.ack().await?;
    }
     
    Ok(())
}

Re-exports§

pub use backends::*;

Modules§

backends
Copyright © 2025-2026 Wenze Wei. All Rights Reserved.

Structs§

RiDeadLetterConfig
Configuration for dead letter queue functionality.
RiQueueConfig
Main queue configuration structure.
RiQueueManager
Central queue management component.
RiQueueMessage
Message structure for queue operations.
RiQueueModule
Main queue module implementing the async service module trait.
RiQueueStats
Statistics for queue monitoring.
RiRetryPolicy
Configuration for message retry behavior.

Enums§

RiQueueBackendType
Enum representing supported queue backend types.
RiQueueError
Error types for queue operations.

Traits§

RiQueue
Main queue trait defining queue operations.
RiQueueConsumer
Trait for consuming messages from queues.
RiQueueProducer
Trait for producing messages to queues.