Struct JobQueue 

pub struct JobQueue<K: JobKind> { /* private fields */ }

The queue: one worker, one job at a time, FIFO, deduplicated by subject.

Implementations

impl<K: JobKind> JobQueue<K>

pub fn new(kind: K) -> Self

A queue over kind. No lane is started until something is enqueued.

pub fn next_job_id(&self) -> String

The job id the next enqueue would use, without enqueuing.

For a kind that has to name the job before it exists. A purge takes the account’s lockout before enqueuing — that is what makes the lockout a fact by the time Accounts.Purge returns — and the lockout’s holder has to be the job id, or the release could not tell this job’s lockout from anybody else’s.

Minted from the same counter JobQueue::enqueue uses, so an id handed out here and never used simply leaves a gap. A gap in a job-id sequence costs nothing; two jobs sharing an id would make the release ambiguous.

pub fn enqueue(&self, order: K::Order) -> Job<K>

Ask for the order’s subject to be worked on, and return without working on it.

Returns the job now responsible for the subject: a new one, or the one already queued or running. Never enqueues a second job for a subject that has one live.

pub fn enqueue_as(&self, order: K::Order, job_id: String) -> Job<K>

JobQueue::enqueue under an id taken from JobQueue::next_job_id earlier.

The caller must not assume this id is the one that ends up responsible: if a job for the same subject is already live, that one is returned and this order’s id is never used. Accounts.Purge handles exactly that by reading the gate back out of the table rather than trusting the one it wrote.

pub fn status(&self, key: &str) -> Option<Job<K>>

The job the queue is holding for key, if it still has one.

pub fn peak_in_flight(&self) -> usize

The highest number of jobs of this kind that have ever been running together.

Must be 1 after any amount of traffic — that is the invariant this module exists for, and this is how a test sees it rather than infers it. 0 before anything has run.

pub fn runs(&self) -> u64

How many times the kind’s run has been called — i.e. how much work actually happened. The applied output the dedup gate asserts on.

pub fn stop(&self)

Run nothing more after the job in flight, and refuse new jobs by name. For tests and the box’s stop; the lane’s worker ends when the last handle of the queue goes.

pub fn jera_stats(&self) -> Option<ChainStats>

The queue’s jera lane, counted: its done and failed jobs (A32-14). None before the first job, when no lane has started.

Trait Implementations

impl<K: JobKind> Clone for JobQueue<K>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.