Struct FactoryArguments 

pub struct FactoryArguments<TKey, TMsg, TWorkerStart, TWorker, TRouter, TQueue>
where
    TKey: JobKey,
    TMsg: Message,
    TWorkerStart: Message,
    TWorker: Actor<Msg = WorkerMessage<TKey, TMsg>, Arguments = WorkerStartContext<TKey, TMsg, TWorkerStart>>,
    TRouter: Router<TKey, TMsg>,
    TQueue: Queue<TKey, TMsg>,
{
    pub worker_builder: Box<dyn WorkerBuilder<TWorker, TWorkerStart>>,
    pub num_initial_workers: usize,
    pub router: TRouter,
    pub queue: TQueue,
    pub discard_handler: Option<Arc<dyn DiscardHandler<TKey, TMsg>>>,
    pub discard_settings: DiscardSettings,
    pub dead_mans_switch: Option<DeadMansSwitchConfiguration>,
    pub capacity_controller: Option<Box<dyn WorkerCapacityController>>,
    pub lifecycle_hooks: Option<Box<dyn FactoryLifecycleHooks<TKey, TMsg>>>,
    pub stats: Option<Arc<dyn FactoryStatsLayer>>,
}

Arguments for configuring and starting a Factory actor instance.

Fields

worker_builder: Box<dyn WorkerBuilder<TWorker, TWorkerStart>>

The factory is responsible for spawning workers and re-spawning workers under failure scenarios. This means that it needs to understand how to build workers. The WorkerBuilder trait is used by the factory to construct new workers when needed.

num_initial_workers: usize

Number of (initial) workers in the factory

Default = 1 worker

router: TRouter

Message routing handler

queue: TQueue

Message queue implementation for the factory

discard_handler: Option<Arc<dyn DiscardHandler<TKey, TMsg>>>

Discard callback when a job is discarded.

Default is None

discard_settings: DiscardSettings

Maximum queue length. Any job arriving when the queue is at its max length will cause a job at the head or tail of the queue to be dropped (which is controlled by discard_mode).

• For factories using routing protocols like routing::QueuerRouting, routing::StickyQueuerRouting routing, these are applied to the factory’s internal queue.
• For all other routing non-factory-queueing protocols, this applies to the worker’s message queue

Default is DiscardSettings::None

dead_mans_switch: Option<DeadMansSwitchConfiguration>

Controls the “dead man’s” switching logic on the factory. Periodically the factory will scan for stuck workers. If detected, the worker information will be logged along with the current job key information. Optionally the worker can be killed and replaced by the factory

Default is None

capacity_controller: Option<Box<dyn WorkerCapacityController>>

Controls the parallel capacity of the worker pool by dynamically growing/shrinking the pool

Default is None

lifecycle_hooks: Option<Box<dyn FactoryLifecycleHooks<TKey, TMsg>>>

Lifecycle hooks provide access to points in the factory’s lifecycle for shutdown/startup/draining where user-defined logic can execute (and block factory lifecycle at critical points). For example, this means the factory won’t start accepting requests until the complete startup routine is completed.

Default is None

stats: Option<Arc<dyn FactoryStatsLayer>>

Defines the statistics collection layer for the factory. Useful for tracking factory properties.

Default is None

Implementations

impl<TKey, TMsg, TWorkerStart, TWorker, TRouter, TQueue> FactoryArguments<TKey, TMsg, TWorkerStart, TWorker, TRouter, TQueue>

where TKey: JobKey, TMsg: Message, TWorkerStart: Message, TWorker: Actor<Msg = WorkerMessage<TKey, TMsg>, Arguments = WorkerStartContext<TKey, TMsg, TWorkerStart>>, TRouter: Router<TKey, TMsg>, TQueue: Queue<TKey, TMsg>,

pub fn builder() -> FactoryArgumentsBuilder<TKey, TMsg, TWorkerStart, TWorker, TRouter, TQueue>

Create an instance of FactoryArguments using the builder syntax

Trait Implementations

impl<TKey, TMsg, TWorkerStart, TWorker, TRouter, TQueue> Debug for FactoryArguments<TKey, TMsg, TWorkerStart, TWorker, TRouter, TQueue>

where TKey: JobKey, TMsg: Message, TWorkerStart: Message, TWorker: Actor<Msg = WorkerMessage<TKey, TMsg>, Arguments = WorkerStartContext<TKey, TMsg, TWorkerStart>>, TRouter: Router<TKey, TMsg>, TQueue: Queue<TKey, TMsg>,

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

Formats the value using the given formatter.