Struct JobQueue 

pub struct JobQueue<J> { /* private fields */ }

The queue; cheap to clone, all clones are the same queue

Implementations

impl<J> JobQueue<J>

where J: Serialize + DeserializeOwned + Clone + Send + Sync + 'static,

pub fn new(config: QueueConfig) -> Self

An empty queue, or the one saved in persist_to’s file. Jobs that were running when the file was written are pending again.

pub fn enqueue(&self, payload: J) -> JobId

Add a job to run as soon as a worker is free

pub fn enqueue_with(&self, payload: J, options: EnqueueOptions) -> Enqueued

pub fn stats(&self) -> Stats

Counters

pub fn get(&self, id: JobId) -> Option<JobRecord<J>>

A job that is waiting, running or dead

pub fn dead_jobs(&self) -> Vec<JobRecord<J>>

Jobs that ran out of attempts (or failed fatally), oldest first

pub fn retry_dead(&self, id: JobId) -> bool

Give a dead job a fresh start; false if there is no such dead job

pub fn delete_dead(&self, id: JobId) -> bool

Remove a dead job for good; false if there is no such dead job

pub async fn run<F, Fut>(&self, shutdown: Shutdown, workers: usize, handler: F)

where F: Fn(Job<J>) -> Fut + Send + Sync + 'static, Fut: Future<Output = Result<(), JobError>> + Send + 'static,

Run workers workers until shutdown fires; returns when the jobs that were in flight have finished and the queue has been saved.

Typically called from App::background. A handler that panics counts as a failed attempt.

pub async fn persist_now(&self)

Write the queue to its file now (also done automatically while running)

Trait Implementations

impl<J> Clone for JobQueue<J>

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.