Struct JobRunnerOptions

pub struct JobRunnerOptions { /* private fields */ }

Type used to build a job runner.

Implementations

impl JobRunnerOptions

pub fn new<F: Fn(CurrentJob) + Send + Sync + 'static>( pool: &Pool<Postgres>, f: F, ) -> Self

Begin constructing a new job runner using the specified connection pool, and the provided execution function.

pub fn set_concurrency( &mut self, min_concurrency: usize, max_concurrency: usize, ) -> &mut Self

Set the concurrency limits for this job runner. When the number of active jobs falls below the minimum, the runner will poll for more, up to the maximum.

The difference between the min and max will dictate the maximum batch size which can be received: larger batch sizes are more efficient.

pub fn set_channel_names<'a>( &'a mut self, channel_names: &[&str], ) -> &'a mut Self

Set the channel names which this job runner will subscribe to. If unspecified, the job runner will subscribe to all channels.

pub fn set_keep_alive(&mut self, keep_alive: bool) -> &mut Self

Choose whether to automatically keep jobs alive whilst they’re still running. Defaults to true.

pub async fn run(&self) -> Result<JobRunnerHandle, Error>

Start the job runner in the background. The job runner will stop when the returned handle is dropped.

pub async fn test_one(&self) -> Result<(), Error>

Run a single job and then return. Intended for use by tests. The job should have been spawned normally and be ready to run.

Trait Implementations

impl Clone for JobRunnerOptions

fn clone(&self) -> JobRunnerOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for JobRunnerOptions

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.