Struct ServerConfig 

pub struct ServerConfig {

    pub server_name: String,
    pub worker_count: usize,
    pub polling_interval: Duration,
    pub job_timeout: Duration,
    pub queues: Vec<String>,
    pub auto_start: bool,
    pub fetch_batch_size: usize,
    pub enable_scheduler: bool,
    pub scheduler_poll_interval: Duration,
    pub shutdown_timeout: Duration,
    pub stale_processing_after: Duration,
    pub enable_recurring: bool,
    pub recurring_poll_interval: Duration,
    pub enable_cleanup: bool,
    pub cleanup_interval: Duration,
    pub succeeded_ttl: Duration,
    pub failed_ttl: Duration,
    pub enable_heartbeat: bool,
    pub heartbeat_interval: Duration,
    pub dead_server_timeout: Duration,
}

Configuration for the background job server

Fields

server_name: String

Server name identifier

worker_count: usize

Number of worker threads to run

polling_interval: Duration

Polling interval for checking new jobs

job_timeout: Duration

Timeout for job execution

queues: Vec<String>

Queues to process (empty means all queues)

auto_start: bool

Whether the server should start automatically

fetch_batch_size: usize

Maximum number of jobs to fetch per polling cycle

enable_scheduler: bool

Enable the job scheduler

scheduler_poll_interval: Duration

Scheduler polling interval

shutdown_timeout: Duration

Grace period given to in-flight workers after stop() cancels the shutdown token. Workers that haven’t completed their current job by then are aborted and the jobs will need lock-expiry / stale-processing recovery to be picked up again.

stale_processing_after: Duration

A Processing job is treated as stranded (and re-queued on startup) once its started_at is older than this threshold. Default: 5 minutes.

This should comfortably exceed the typical job_timeout so a worker that’s still alive isn’t fighting with the recovery sweep.

enable_recurring: bool

Enable the recurring-job poller that materializes due RecurringJob templates.

recurring_poll_interval: Duration

Poll interval for the recurring-job poller. Defaults to 5 seconds so minute-granularity crons fire promptly without hammering storage.

enable_cleanup: bool

Enable the background cleanup worker that deletes rows whose expires_at is in the past.

cleanup_interval: Duration

Interval between cleanup sweeps. Defaults to 1 minute.

succeeded_ttl: Duration

TTL stamped onto successfully-completed jobs. Defaults to 24 hours.

failed_ttl: Duration

TTL stamped onto permanently-failed jobs. Defaults to 7 days.

enable_heartbeat: bool

Enable the server heartbeat + dead-peer reclaim worker (D1).

When enabled, this server registers itself in the storage-level server registry, bumps its last_heartbeat on every heartbeat_interval, and periodically scans for peers whose heartbeat has gone stale. Dead peers’ in-flight Processing jobs are actively reclaimed back to Enqueued.

Disabled by default so single-server deployments don’t pay for an unused registry.

heartbeat_interval: Duration

How often to bump this server’s last_heartbeat row. Defaults to 10 seconds.

dead_server_timeout: Duration

A peer is treated as dead once its last_heartbeat is older than this threshold. Defaults to 60 seconds — should comfortably exceed heartbeat_interval so brief slowdowns don’t trigger reclaim.

Implementations

impl ServerConfig

pub fn new(server_name: impl Into<String>) -> Self

Create a new server configuration

pub fn worker_count(self, count: usize) -> Self

Set the number of workers

pub fn polling_interval(self, interval: Duration) -> Self

Set the polling interval

pub fn job_timeout(self, timeout: Duration) -> Self

Set the job timeout

pub fn queues(self, queues: Vec<String>) -> Self

Set the queues to process

pub fn fetch_batch_size(self, size: usize) -> Self

Set the fetch batch size

pub fn enable_scheduler(self, enable: bool) -> Self

Enable or disable the scheduler

pub fn shutdown_timeout(self, timeout: Duration) -> Self

Set how long stop() waits for in-flight workers before aborting.

pub fn stale_processing_after(self, threshold: Duration) -> Self

Set the staleness threshold for re-queuing stranded Processing jobs on startup.

pub fn enable_recurring(self, enable: bool) -> Self

Enable or disable the recurring-job poller.

pub fn recurring_poll_interval(self, interval: Duration) -> Self

Set the recurring-job poll interval.

pub fn enable_cleanup(self, enable: bool) -> Self

Enable or disable the background cleanup worker.

pub fn cleanup_interval(self, interval: Duration) -> Self

Set the cleanup-worker sweep interval.

pub fn succeeded_ttl(self, ttl: Duration) -> Self

Set the TTL stamped onto successfully-completed jobs.

pub fn failed_ttl(self, ttl: Duration) -> Self

Set the TTL stamped onto permanently-failed jobs.

pub fn enable_heartbeat(self, enable: bool) -> Self

Enable or disable the heartbeat + dead-peer reclaim worker.

pub fn heartbeat_interval(self, interval: Duration) -> Self

Set the heartbeat bump interval.

pub fn dead_server_timeout(self, timeout: Duration) -> Self

Set the peer-dead staleness threshold.

Trait Implementations

impl Clone for ServerConfig

fn clone(&self) -> ServerConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ServerConfig

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

Formats the value using the given formatter.

impl Default for ServerConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ServerConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ServerConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.