This document describes the current stable version of Kombu (4.3). For development docs, go here.
Carrot Compatibility - kombu.compat
¶
Carrot compatibility interface.
See https://pypi.org/project/carrot/ for documentation.
Publisher¶
Replace with kombu.Producer
.
-
class
kombu.compat.
Publisher
(connection, exchange=None, routing_key=None, exchange_type=None, durable=None, auto_delete=None, channel=None, **kwargs)[source]¶ Carrot compatible producer.
-
auto_declare
= True¶
-
auto_delete
= False¶
-
backend
¶
-
channel
¶
-
compression
= None¶
-
connection
¶
-
declare
()¶ Declare the exchange.
Note
This happens automatically at instantiation when the
auto_declare
flag is enabled.
-
durable
= True¶
-
exchange
= u''¶
-
exchange_type
= u'direct'¶
-
maybe_declare
(entity, retry=False, **retry_policy)¶ Declare exchange if not already declared during this session.
-
on_return
= None¶
-
publish
(body, routing_key=None, delivery_mode=None, mandatory=False, immediate=False, priority=0, content_type=None, content_encoding=None, serializer=None, headers=None, compression=None, exchange=None, retry=False, retry_policy=None, declare=None, expiration=None, **properties)¶ Publish message to the specified exchange.
Parameters: - body (Any) – Message body.
- routing_key (str) – Message routing key.
- delivery_mode (enum) – See
delivery_mode
. - mandatory (bool) – Currently not supported.
- immediate (bool) – Currently not supported.
- priority (int) – Message priority. A number between 0 and 9.
- content_type (str) – Content type. Default is auto-detect.
- content_encoding (str) – Content encoding. Default is auto-detect.
- serializer (str) – Serializer to use. Default is auto-detect.
- compression (str) – Compression method to use. Default is none.
- headers (Dict) – Mapping of arbitrary headers to pass along with the message body.
- exchange (kombu.entity.Exchange, str) – Override the exchange. Note that this exchange must have been declared.
- declare (Sequence[EntityT]) – Optional list of required entities
that must have been declared before publishing the message.
The entities will be declared using
maybe_declare()
. - retry (bool) – Retry publishing, or declaring entities if the connection is lost.
- retry_policy (Dict) – Retry configuration, this is the keywords
supported by
ensure()
. - expiration (float) – A TTL in seconds can be specified per message. Default is no expiration.
- **properties (Any) – Additional message properties, see AMQP spec.
-
release
()¶
-
revive
(channel)¶ Revive the producer after connection loss.
-
routing_key
= u''¶
-
serializer
= None¶
-
Consumer¶
Replace with kombu.Consumer
.
-
class
kombu.compat.
Consumer
(connection, queue=None, exchange=None, routing_key=None, exchange_type=None, durable=None, exclusive=None, auto_delete=None, **kwargs)[source]¶ Carrot compatible consumer.
-
accept
= None¶
-
add_queue
(queue)[source]¶ Add a queue to the list of queues to consume from.
Note
This will not start consuming from the queue, for that you will have to call
consume()
after.
-
auto_declare
= True¶
-
auto_delete
= False¶
-
callbacks
= None¶
-
cancel
()[source]¶ End all active queue consumers.
Note
This does not affect already delivered messages, but it does mean the server will not send any more messages for this consumer.
-
channel
= None¶
-
connection
¶
-
consume
(no_ack=None)[source]¶ Start consuming messages.
Can be called multiple times, but note that while it will consume from new queues added since the last call, it will not cancel consuming from removed queues ( use
cancel_by_queue()
).Parameters: no_ack (bool) – See no_ack
.
-
declare
()[source]¶ Declare queues, exchanges and bindings.
Note
This is done automatically at instantiation when
auto_declare
is set.
-
durable
= True¶
-
exchange
= u''¶
-
exchange_type
= u'direct'¶
-
exclusive
= False¶
-
flow
(active)[source]¶ Enable/disable flow from peer.
This is a simple flow-control mechanism that a peer can use to avoid overflowing its queues or otherwise finding itself receiving more messages than it can process.
The peer that receives a request to stop sending content will finish sending the current content (if any), and then wait until flow is reactivated.
-
no_ack
= None¶
-
on_decode_error
= None¶
-
on_message
= None¶
-
prefetch_count
= None¶
-
purge
()[source]¶ Purge messages from all queues.
Warning
This will delete all ready messages, there is no undo operation.
-
qos
(prefetch_size=0, prefetch_count=0, apply_global=False)[source]¶ Specify quality of service.
The client can request that messages should be sent in advance so that when the client finishes processing a message, the following message is already held locally, rather than needing to be sent down the channel. Prefetching gives a performance improvement.
The prefetch window is Ignored if the
no_ack
option is set.Parameters: - prefetch_size (int) – Specify the prefetch window in octets. The server will send a message in advance if it is equal to or smaller in size than the available prefetch size (and also falls within other prefetch limits). May be set to zero, meaning “no specific limit”, although other prefetch limits may still apply.
- prefetch_count (int) – Specify the prefetch window in terms of whole messages.
- apply_global (bool) – Apply new settings globally on all channels.
-
queue
= u''¶
-
queues
¶
-
receive
(body, message)[source]¶ Method called when a message is received.
This dispatches to the registered
callbacks
.Parameters: - body (Any) – The decoded message body.
- message (Message) – The message instance.
Raises: NotImplementedError
– If no consumer callbacks have been registered.
-
recover
(requeue=False)[source]¶ Redeliver unacknowledged messages.
Asks the broker to redeliver all unacknowledged messages on the specified channel.
Parameters: requeue (bool) – By default the messages will be redelivered to the original recipient. With requeue set to true, the server will attempt to requeue the message, potentially then delivering it to an alternative subscriber.
-
register_callback
(callback)[source]¶ Register a new callback to be called when a message is received.
Note
The signature of the callback needs to accept two arguments: (body, message), which is the decoded message body and the
Message
instance.
-
routing_key
= u''¶
-
ConsumerSet¶
Replace with kombu.Consumer
.
-
class
kombu.compat.
ConsumerSet
(connection, from_dict=None, consumers=None, channel=None, **kwargs)[source]¶ -
-
accept
= None¶
-
add_queue
(queue)¶ Add a queue to the list of queues to consume from.
Note
This will not start consuming from the queue, for that you will have to call
consume()
after.
-
auto_declare
= True¶
-
callbacks
= None¶
-
cancel
()¶ End all active queue consumers.
Note
This does not affect already delivered messages, but it does mean the server will not send any more messages for this consumer.
-
cancel_by_queue
(queue)¶ Cancel consumer by queue name.
-
channel
= None¶
-
connection
¶
-
consume
(no_ack=None)¶ Start consuming messages.
Can be called multiple times, but note that while it will consume from new queues added since the last call, it will not cancel consuming from removed queues ( use
cancel_by_queue()
).Parameters: no_ack (bool) – See no_ack
.
-
consuming_from
(queue)¶ Return
True
if currently consuming from queue’.
-
declare
()¶ Declare queues, exchanges and bindings.
Note
This is done automatically at instantiation when
auto_declare
is set.
-
flow
(active)¶ Enable/disable flow from peer.
This is a simple flow-control mechanism that a peer can use to avoid overflowing its queues or otherwise finding itself receiving more messages than it can process.
The peer that receives a request to stop sending content will finish sending the current content (if any), and then wait until flow is reactivated.
-
no_ack
= None¶
-
on_decode_error
= None¶
-
on_message
= None¶
-
prefetch_count
= None¶
-
purge
()¶ Purge messages from all queues.
Warning
This will delete all ready messages, there is no undo operation.
-
qos
(prefetch_size=0, prefetch_count=0, apply_global=False)¶ Specify quality of service.
The client can request that messages should be sent in advance so that when the client finishes processing a message, the following message is already held locally, rather than needing to be sent down the channel. Prefetching gives a performance improvement.
The prefetch window is Ignored if the
no_ack
option is set.Parameters: - prefetch_size (int) – Specify the prefetch window in octets. The server will send a message in advance if it is equal to or smaller in size than the available prefetch size (and also falls within other prefetch limits). May be set to zero, meaning “no specific limit”, although other prefetch limits may still apply.
- prefetch_count (int) – Specify the prefetch window in terms of whole messages.
- apply_global (bool) – Apply new settings globally on all channels.
-
queues
¶
-
receive
(body, message)¶ Method called when a message is received.
This dispatches to the registered
callbacks
.Parameters: - body (Any) – The decoded message body.
- message (Message) – The message instance.
Raises: NotImplementedError
– If no consumer callbacks have been registered.
-
recover
(requeue=False)¶ Redeliver unacknowledged messages.
Asks the broker to redeliver all unacknowledged messages on the specified channel.
Parameters: requeue (bool) – By default the messages will be redelivered to the original recipient. With requeue set to true, the server will attempt to requeue the message, potentially then delivering it to an alternative subscriber.
-
register_callback
(callback)¶ Register a new callback to be called when a message is received.
Note
The signature of the callback needs to accept two arguments: (body, message), which is the decoded message body and the
Message
instance.
-