Struct WorkerShutdownConfig 

pub struct WorkerShutdownConfig {
    pub listen_os_shutdown_signals: bool,
    pub grace_period: Duration,
    pub interrupted_job_retry_delay: Duration,
    pub shutdown_signal: Option<ShutdownSignal>,
}

Worker shutdown behavior.

These options apply to ordinary graceful shutdown, even when worker recovery heartbeat/sweeping is disabled.

Fields

listen_os_shutdown_signals: bool

Whether to install OS-level shutdown signal handlers.

grace_period: Duration

Time to let in-flight tasks finish after a shutdown signal.

interrupted_job_retry_delay: Duration

Delay before a shutdown-aborted job is eligible to run again.

shutdown_signal: Option<ShutdownSignal>

Custom application shutdown signal.

Implementations

impl WorkerShutdownConfig

pub fn listen_os_shutdown_signals(self, value: bool) -> Self

pub fn grace_period(self, value: Duration) -> Self

pub fn interrupted_job_retry_delay(self, value: Duration) -> Self

pub fn shutdown_signal( self, signal: impl Future<Output = ()> + Send + 'static, ) -> Self

Sets a custom application shutdown signal.

The future should complete when the host application requests shutdown. The worker still owns graceful draining after the signal is received.

Trait Implementations

impl Clone for WorkerShutdownConfig

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WorkerShutdownConfig

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

Formats the value using the given formatter.

impl Default for WorkerShutdownConfig

fn default() -> Self

Returns the “default value” for a type.