Struct celery::beat::Beat

pub struct Beat<Sb: SchedulerBackend> {
    pub name: String,
    pub scheduler: Scheduler,
    pub scheduler_backend: Sb,
    /* private fields */
}

A Beat app is used to send out scheduled tasks. This is the struct that is created with the beat! macro.

It drives execution by making the internal scheduler “tick”, and updates the list of scheduled tasks through a customizable scheduler backend.

Fields

name: String

scheduler: Scheduler

scheduler_backend: Sb

Implementations

impl Beat<LocalSchedulerBackend>

pub fn default_builder( name: &str, broker_url: &str ) -> BeatBuilder<LocalSchedulerBackend>

Get a BeatBuilder for creating a Beat app with a custom configuration and a default scheduler backend.

impl<Sb> Beat<Sb>where Sb: SchedulerBackend,

pub fn custom_builder( name: &str, broker_url: &str, scheduler_backend: Sb ) -> BeatBuilder<Sb>

Get a BeatBuilder for creating a Beat app with a custom configuration and a custom scheduler backend.

pub fn schedule_task<T, S>(&mut self, signature: Signature<T>, schedule: S)where T: Task + Clone + 'static, S: Schedule + 'static,

Schedule the execution of a task.

pub fn schedule_named_task<T, S>( &mut self, name: String, signature: Signature<T>, schedule: S )where T: Task + Clone + 'static, S: Schedule + 'static,

Schedule the execution of a task with the given name.

pub async fn start(&mut self) -> Result<(), BeatError>

Start the beat.