Struct ProcessorConfig

#[non_exhaustive]
pub struct ProcessorConfig {
    pub num_workers: usize,
    pub balance_strategy: BalanceStrategy,
    pub queue_configs: BTreeMap<String, QueueConfig>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

num_workers: usize

The number of Sidekiq workers that can run at the same time. Adjust as needed based on your workload and resource (cpu/memory/etc) usage.

This config value controls how many workers are spawned to handle the queues provided to Processor::new. These workers will be shared across all of these queues.

If your workload is largely CPU-bound (computationally expensive), this should probably match your CPU count. This is the default.

If your workload is largely IO-bound (e.g. reading from a DB, making web requests and waiting for responses, etc), this can probably be quite a bit higher than your CPU count.

balance_strategy: BalanceStrategy

The strategy for balancing the priority of fetching queues’ jobs from Redis. Defaults to BalanceStrategy::RoundRobin.

The Redis API used to fetch jobs (brpop) checks queues for jobs in the order the queues are provided. This means that if the first queue in the list provided to Processor::new always has an item, the other queues will never have their jobs run. To mitigate this, a BalanceStrategy can be provided to allow ensuring that no queue is starved indefinitely.

queue_configs: BTreeMap<String, QueueConfig>

Queue-specific configurations. The queues specified in this field do not need to match the list of queues provided to Processor::new.

Implementations

impl ProcessorConfig

pub fn num_workers(self, num_workers: usize) -> Self

pub fn balance_strategy(self, balance_strategy: BalanceStrategy) -> Self

pub fn queue_config(self, queue: String, config: QueueConfig) -> Self

Trait Implementations

impl Clone for ProcessorConfig

fn clone(&self) -> ProcessorConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for ProcessorConfig

fn default() -> Self

Returns the “default value” for a type.