Struct apalis_core::worker::prelude::Monitor

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

Available on crate feature worker only.

Represents a monitor for multiple instances of Recipient to Worker.

Keeps an address of each queue and periodically checks of their status When combined with the web feature, it can be used to manage the queues from a web ui.

Implementations

impl<T> Monitor<T>

pub fn new() -> Self

Build a new Monitor instance

impl Monitor<JoinHandle<Recipient<WorkerManagement>>>

pub fn register<W>(self, worker: W) -> Selfwhere
    W: Worker,

Register single worker instance of Worker

pub fn register_with_count<F, W: Worker>(self, count: usize, factory: F) -> Selfwhere
    F: Fn(usize) -> W,

Register multiple worker instances of Worker

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

Start monitor without listening for Ctrl + C TODO: add the signals feature

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

Start monitor listening for Ctrl + C

impl<K> Monitor<K>

pub fn event_handler<H>(self, handle: H) -> Selfwhere
    H: WorkerListener + 'static,

Attach a new WorkerListener instance to Monitor

Trait Implementations

impl Actor for Monitor<Recipient<WorkerManagement>>

fn on_start<'life0, 'life1, 'async_trait>(
    &'life0 mut self,
    _ctx: &'life1 mut Context<Self>
) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>where
    Self: 'async_trait,
    'life0: 'async_trait,
    'life1: 'async_trait,

At start hook of actor

fn mailbox_capacity(&self) -> usize

Capacity of worker queue

fn on_stop<'life0, 'life1, 'async_trait>(
    &'life0 mut self,
    _ctx: &'life1 mut Context<Self>
) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>where
    Self: 'async_trait,
    'life0: 'async_trait,
    'life1: 'async_trait,

At stop hook of actor

fn preinit(self) -> InitializedActor<Self>

Initilize actor with its address.

fn preinit_default() -> InitializedActor<Self>where
    Self: Default,

Initialize actor with default values

fn start<'async_trait>(
    self
) -> Pin<Box<dyn Future<Output = Addr<Self>> + Send + 'async_trait>>where
    Self: 'async_trait,

Starts an actor and returns its address

fn start_default<'async_trait>(
) -> Pin<Box<dyn Future<Output = Addr<Self>> + Send + 'async_trait>>where
    Self: Default + 'async_trait,

Starts an actor with default values and returns its address

impl<R> Debug for Monitor<R>

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

Formats the value using the given formatter.

impl<T> Default for Monitor<T>

fn default() -> Self

Returns the “default value” for a type.

impl Handler<WorkerMessage> for Monitor<Recipient<WorkerManagement>>

type Result = ()

Result of handler

fn handle<'life0, 'async_trait>(
    &'life0 mut self,
    msg: WorkerMessage
) -> Pin<Box<dyn Future<Output = Self::Result> + Send + 'async_trait>>where
    Self: 'async_trait,
    'life0: 'async_trait,

Message handler