Struct Celery

pub struct Celery {
    pub name: String,
    pub hostname: String,
    pub broker: Box<dyn Broker>,
    pub default_queue: String,
    pub task_options: TaskOptions,
    /* private fields */
}

A Celery app is used to produce or consume tasks asynchronously. This is the struct that is created with the app! macro.

Fields

name: String

An arbitrary, human-readable name for the app.

hostname: String

Node name of the app.

broker: Box<dyn Broker>

The app’s broker.

default_queue: String

The default queue to send and receive from.

task_options: TaskOptions

Default task options.

Implementations

impl Celery

pub async fn display_pretty(&self)

Print a pretty ASCII art logo and configuration settings.

This is useful and fun to print from a worker application right after the Celery app is initialized.

pub async fn send_task<T: Task>( &self, task_sig: Signature<T>, ) -> Result<AsyncResult, CeleryError>

Send a task to a remote worker. Returns an AsyncResult with the task ID of the task if it was successfully sent.

pub async fn register_task<T: Task + 'static>(&self) -> Result<(), CeleryError>

Register a task.

pub async fn close(&self) -> Result<(), CeleryError>

Close channels and connections.

pub async fn consume(self: &Arc<Self>) -> Result<(), CeleryError>

Consume tasks from the default queue.

pub async fn consume_from( self: &Arc<Self>, queues: &[&str], ) -> Result<(), CeleryError>

Consume tasks from any number of queues.