Struct background_jobs_core::ProcessorMap

pub struct ProcessorMap<S>where
    S: Clone,{ /* private fields */ }

A type for storing the relationships between processor names and the processor itself

Processors must be registered with the ProcessorMap in the initialization phase of an application before workers are spawned in order to handle queued jobs.

Implementations

impl<S> ProcessorMap<S>where
    S: Clone + Send + Sync + 'static,

pub fn new(state: S) -> Self

Intialize a ProcessorMap

The state passed into this method will be passed to all jobs executed through this ProcessorMap. The state argument could be useful for containing a hook into something like r2d2, or the address of an actor in an actix-based system.

pub fn register_processor<P>(&mut self, processor: P)where
    P: Processor<S> + Send + Sync + 'static,

Register a Processor with this ProcessorMap.

ProcessorMaps are useless if no processors are registerd before workers are spawned, so make sure to register all your processors up-front.

pub fn process_job(
    &self,
    job: JobInfo
) -> impl Future<Item = JobInfo, Error = ()>

Process a given job

This should not be called from outside implementations of a backgoround-jobs runtime. It is intended for internal use.