Struct JobQueue

pub struct JobQueue<DB: Database> {
    pub pool: Pool<DB>,
    /* private fields */
}

A generic job queue implementation that works with multiple database backends.

This struct provides a database-agnostic interface to the job queue functionality. The actual database operations are delegated to database-specific implementations based on the type parameter DB.

Examples

use hammerwork::{JobQueue, Job, queue::DatabaseQueue};
use serde_json::json;

// Create a PostgreSQL-backed queue
let pool = sqlx::PgPool::connect("postgresql://localhost/hammerwork").await?;
let queue = JobQueue::new(pool);

// Create and enqueue a job
let job = Job::new("email_queue".to_string(), json!({"to": "user@example.com"}));
let job_id = queue.enqueue(job).await?;

Fields

pool: Pool<DB>

Implementations

impl<DB: Database> JobQueue<DB>

pub fn new(pool: Pool<DB>) -> Self

Creates a new job queue with the given database connection pool.

Arguments

• pool - A database connection pool for the specific database backend

Examples

use hammerwork::JobQueue;

let pool = sqlx::PgPool::connect("postgresql://localhost/hammerwork").await?;
let queue = JobQueue::new(pool);

pub async fn set_throttle( &self, queue_name: &str, config: ThrottleConfig, ) -> Result<()>

Set throttling configuration for a specific queue.

This is a convenience method that stores the throttling configuration in memory for use by workers.

Arguments

• queue_name - The name of the queue to configure
• config - The throttling configuration

Examples

use hammerwork::{JobQueue, rate_limit::ThrottleConfig};
use std::time::Duration;

let pool = sqlx::PgPool::connect("postgresql://localhost/hammerwork").await?;
let queue = JobQueue::new(pool);

let config = ThrottleConfig::new()
    .max_concurrent(5)
    .rate_per_minute(100);

queue.set_throttle("email_queue", config).await?;

pub async fn get_throttle(&self, queue_name: &str) -> Option<ThrottleConfig>

Get throttling configuration for a specific queue.

Arguments

• queue_name - The name of the queue

Returns

The throttling configuration if it exists, otherwise None.

pub async fn remove_throttle(&self, queue_name: &str) -> Result<()>

Remove throttling configuration for a specific queue.

Arguments

• queue_name - The name of the queue

pub async fn get_all_throttles(&self) -> HashMap<String, ThrottleConfig>

Get all throttling configurations.

Returns

A map of queue names to their throttling configurations.

pub fn get_pool(&self) -> &Pool<DB>

Get a reference to the underlying database connection pool.

This method provides access to the database pool for advanced use cases that require direct database operations or integration with other components.

Examples

use hammerwork::JobQueue;

let queue = JobQueue::new(pool);

// Access the pool for advanced operations
let pool_ref = &queue.pool;
let pool_clone = queue.pool.clone();

// Use the pool for custom queries or integration with other components
let row_count: (i64,) = sqlx::query_as("SELECT COUNT(*) FROM hammerwork_jobs")
    .fetch_one(&queue.pool)
    .await?;

println!("Total jobs in database: {}", row_count.0);