Struct apalis_core::monitor::Monitor

pub struct Monitor<E> { /* private fields */ }

A monitor for coordinating and managing a collection of workers.

Implementations

impl<E: Executor + Send + Sync + 'static> Monitor<E>

pub fn register<Strm, Serv: Service<JobRequest<J>>, J: Job + 'static, W: Worker<J, Service = Serv, Source = Strm> + 'static>( self, worker: W ) -> Selfwhere <Serv as Service<JobRequest<J>>>::Future: Send,

Registers a worker with the monitor.

Arguments

• worker - The worker to register.

Returns

The monitor instance, with the worker added to the collection.

pub fn register_with_count<Strm, Serv: Service<JobRequest<J>>, J: Job + 'static, W: Worker<J, Service = Serv, Source = Strm> + 'static, Call: Fn(u16) -> W>( self, count: u16, caller: Call ) -> Selfwhere <Serv as Service<JobRequest<J>>>::Future: Send,

Registers multiple workers with the monitor.

Arguments

• count - The number of workers to register.
• caller - A function that returns a new worker instance for each index.

Returns

The monitor instance, with all workers added to the collection.

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

Sets a timeout duration for the monitor’s shutdown process.

Arguments

• duration - The timeout duration.

Returns

The monitor instance, with the shutdown timeout duration set.

pub async fn run_with_signal<S: Future<Output = Result<()>>>( self, signal: S ) -> Result<()>

Runs the monitor and all its registered workers until they have all completed or a shutdown signal is received.

Arguments

• signal - A Future that resolves when a shutdown signal is received.

Errors

If the monitor fails to shutdown gracefully, an std::io::Error will be returned.

pub async fn run(self) -> Result<()>

Runs the monitor and all its registered workers until they have all completed.

Errors

If the monitor fails to shutdown gracefully, an std::io::Error will be returned.

Remarks

If a timeout has been set using the shutdown_timeout method, the monitor will wait for all workers to complete up to the timeout duration before exiting. If the timeout is reached and workers have not completed, the monitor will log a warning message and exit forcefully.

impl Monitor<TokioExecutor>

pub fn new() -> Self

Creates a new monitor instance.

Returns

A new monitor instance, with an empty collection of workers.

pub fn executor<E: Executor>(self, executor: E) -> Monitor<E>

Sets a custom executor for the monitor, allowing the usage of another runtime apart from Tokio. The executor must implement the Executor trait.

Trait Implementations

impl<E: Executor> Debug for Monitor<E>

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

Formats the value using the given formatter.

impl<E: Executor + Default> Default for Monitor<E>

fn default() -> Self

Returns the “default value” for a type.