This document describes an older version of Celery (2.1). For the latest stable version please go here.

Messaging - celery.messaging

Sending and Receiving Messages

class celery.messaging.BroadcastConsumer(*args, **kwargs)

Consume broadcast commands

auto_delete = False
consume(*args, **kwargs)
durable = True
exchange = 'celeryctl'
exchange_type = 'fanout'
no_ack = True
queue = 'celeryctl'
verify_exclusive()
class celery.messaging.BroadcastPublisher(connection, exchange=None, routing_key=None, **kwargs)

Publish broadcast commands

ReplyTo

alias of ControlReplyConsumer

auto_delete = False
durable = True
exchange = 'celeryctl'
exchange_type = 'fanout'
send(type, arguments, destination=None, reply_ticket=None)

Send broadcast command.

class celery.messaging.ConsumerSet(connection, from_dict=None, consumers=None, callbacks=None, **options)

ConsumerSet with an optional decode error callback.

For more information see carrot.messaging.ConsumerSet.

on_decode_error

Callback called if a message had decoding errors. The callback is called with the signature:

callback(message, exception)
on_decode_error = None
class celery.messaging.ControlReplyConsumer(connection, ticket, **kwargs)
auto_delete = True
collect(limit=None, timeout=1, callback=None)
durable = False
exchange = 'celerycrq'
exchange_type = 'direct'
exclusive = False
no_ack = True
class celery.messaging.ControlReplyPublisher(connection, exchange=None, routing_key=None, **kwargs)
auto_delete = True
delivery_mode = 'non-persistent'
durable = False
exchange = 'celerycrq'
exchange_type = 'direct'
class celery.messaging.EventConsumer(connection, queue=None, exchange=None, routing_key=None, **kwargs)

Consume events

auto_delete = False
durable = True
exchange = 'celeryevent'
exchange_type = 'direct'
no_ack = True
queue = 'celeryevent'
routing_key = 'celeryevent'
class celery.messaging.EventPublisher(connection, exchange=None, routing_key=None, **kwargs)

Publish events

auto_delete = False
delivery_mode = 2
durable = True
exchange = 'celeryevent'
exchange_type = 'direct'
routing_key = 'celeryevent'
serializer = 'json'
class celery.messaging.TaskConsumer(connection, queue=None, exchange=None, routing_key=None, **kwargs)

Consume tasks

exchange = 'celery'
exchange_type = 'direct'
queue = 'celery'
routing_key = 'celery'
class celery.messaging.TaskPublisher(*args, **kwargs)

Publish tasks.

auto_declare = False
declare()
delay_task(task_name, task_args=None, task_kwargs=None, countdown=None, eta=None, task_id=None, taskset_id=None, exchange=None, exchange_type=None, expires=None, **kwargs)

Delay task for execution by the celery nodes.

exchange = 'celery'
exchange_type = 'direct'
routing_key = 'celery'
serializer = 'pickle'
celery.messaging.establish_connection(hostname=None, userid=None, password=None, virtual_host=None, port=None, ssl=None, insist=None, connect_timeout=None, backend_cls=None, defaults=<module 'celery.conf' from '../celery/conf.py'>)

Establish a connection to the message broker.

celery.messaging.extract_msg_options(d)
celery.messaging.get_consumer_set(connection, queues=None, **options)

Get the carrot.messaging.ConsumerSet` for a queue configuration.

Defaults to the queues in CELERY_QUEUES.

celery.messaging.with_connection(fun)

Decorator for providing default message broker connection for functions supporting the connection and connect_timeout keyword arguments.

Previous topic

Task States - celery.states

Next topic

Contrib: Abortable tasks - celery.contrib.abortable

This Page