This document describes the current stable version of Kombu (5.0). For development docs, go here.

Virtual Transport Base Class - kombu.transport.virtual

Transports

class kombu.transport.virtual.Transport(client, **kwargs)

Virtual transport.

Parameters

client (kombu.Connection) – The client this is a transport for.

Channel = <class 'kombu.transport.virtual.base.Channel'>

Cycle = <class 'kombu.utils.scheduling.FairCycle'>

polling_interval = 1.0

Time to sleep between unsuccessful polls.

default_port = None

port number used when no port is specified.

state = <kombu.transport.virtual.base.BrokerState object>

Global BrokerState containing declared exchanges and bindings.

cycle = None

FairCycle instance used to fairly drain events from channels (set by constructor).

establish_connection()

close_connection(connection)

create_channel(connection)

close_channel(channel)

drain_events(connection, timeout=None)

Channel

class kombu.transport.virtual.AbstractChannel

Abstract channel interface.

This is an abstract class defining the channel methods you’d usually want to implement in a virtual channel.

Note

Do not subclass directly, but rather inherit from Channel.

class kombu.transport.virtual.Channel(connection, **kwargs)

Virtual channel.

Parameters

connection (ConnectionT) – The transport instance this channel is part of.

Message = <class 'kombu.transport.virtual.base.Message'>

message class used.

state

Broker state containing exchanges and bindings.

qos

QoS manager for this channel.

do_restore = True

flag to restore unacked messages when channel goes out of scope.

exchange_types = {'direct': <class 'kombu.transport.virtual.exchange.DirectExchange'>, 'fanout': <class 'kombu.transport.virtual.exchange.FanoutExchange'>, 'topic': <class 'kombu.transport.virtual.exchange.TopicExchange'>}

mapping of exchange types and corresponding classes.

exchange_declare(exchange=None, type='direct', durable=False, auto_delete=False, arguments=None, nowait=False, passive=False)

Declare exchange.

exchange_delete(exchange, if_unused=False, nowait=False)

Delete exchange and all its bindings.

queue_declare(queue=None, passive=False, **kwargs)

Declare queue.

queue_delete(queue, if_unused=False, if_empty=False, **kwargs)

Delete queue.

queue_bind(queue, exchange=None, routing_key='', arguments=None, **kwargs)

Bind queue to exchange with routing key.

queue_purge(queue, **kwargs)

Remove all ready messages from queue.

basic_publish(message, exchange, routing_key, **kwargs)

Publish message.

basic_consume(queue, no_ack, callback, consumer_tag, **kwargs)

Consume from queue.

basic_cancel(consumer_tag)

Cancel consumer by consumer tag.

basic_get(queue, no_ack=False, **kwargs)

Get message by direct access (synchronous).

basic_ack(delivery_tag, multiple=False)

Acknowledge message.

basic_recover(requeue=False)

Recover unacked messages.

basic_reject(delivery_tag, requeue=False)

Reject message.

basic_qos(prefetch_size=0, prefetch_count=0, apply_global=False)

Change QoS settings for this channel.

Note

Only prefetch_count is supported.

get_table(exchange)

Get table of bindings for exchange.

typeof(exchange, default='direct')

Get the exchange type instance for exchange.

drain_events(timeout=None, callback=None)

prepare_message(body, priority=None, content_type=None, content_encoding=None, headers=None, properties=None)

Prepare message data.

message_to_python(raw_message)

Convert raw message to Message instance.

flow(active=True)

Enable/disable message flow.

Raises

NotImplementedError – as flow is not implemented by the base virtual implementation.

close()

Close channel.

Cancel all consumers, and requeue unacked messages.

Message

class kombu.transport.virtual.Message(payload, channel=None, **kwargs)

Message object.

exception MessageStateError

The message has already been acknowledged.

args

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

accept

ack(multiple=False)

Acknowledge this message as being processed.

This will remove the message from the queue.

Raises

MessageStateError – If the message has already been acknowledged/requeued/rejected.

ack_log_error(logger, errors, multiple=False)

property acknowledged

Set to true if the message has been acknowledged.

body

channel

content_encoding

content_type

decode()

Deserialize the message body.

Returning the original python structure sent by the publisher.

Note

The return value is memoized, use _decode to force re-evaluation.

delivery_info

delivery_tag

errors = None

headers

property payload

The decoded message body.

properties

reject(requeue=False)

Reject this message.

The message will be discarded by the server.

Raises

MessageStateError – If the message has already been acknowledged/requeued/rejected.

reject_log_error(logger, errors, requeue=False)

requeue()

Reject this message and put it back on the queue.

Warning

You must not use this method as a means of selecting messages to process.

Raises

MessageStateError – If the message has already been acknowledged/requeued/rejected.

serializable()

Quality Of Service

class kombu.transport.virtual.QoS(channel, prefetch_count=0)

Quality of Service guarantees.

Only supports prefetch_count at this point.

Parameters

• channel (ChannelT) – Connection channel.

• prefetch_count (int) – Initial prefetch count (defaults to 0).

ack(delivery_tag)

Acknowledge message and remove from transactional state.

append(message, delivery_tag)

Append message to transactional state.

can_consume()

Return true if the channel can be consumed from.

Used to ensure the client adhers to currently active prefetch limits.

can_consume_max_estimate()

Return the maximum number of messages allowed to be returned.

Returns an estimated number of messages that a consumer may be allowed to consume at once from the broker. This is used for services where bulk ‘get message’ calls are preferred to many individual ‘get message’ calls - like SQS.

Returns

greater than zero.

Return type

int

get(delivery_tag)

prefetch_count = 0

current prefetch count value

reject(delivery_tag, requeue=False)

Remove from transactional state and requeue message.

restore_at_shutdown = True

If disabled, unacked messages won’t be restored at shutdown.

restore_unacked()

Restore all unacknowledged messages.

restore_unacked_once(stderr=None)

Restore all unacknowledged messages at shutdown/gc collect.

Note

Can only be called once for each instance, subsequent calls will be ignored.

restore_visible(*args, **kwargs)

Restore any pending unackwnowledged messages.

To be filled in for visibility_timeout style implementations.

Note

This is implementation optional, and currently only used by the Redis transport.

In-memory State

class kombu.transport.virtual.BrokerState(exchanges=None)

Broker state holds exchanges, queues and bindings.

binding_declare(queue, exchange, routing_key, arguments)

binding_delete(queue, exchange, routing_key)

bindings = None

This is the actual bindings registry, used to store bindings and to test ‘in’ relationships in constant time. It has the following structure:

{
    (queue, exchange, routing_key): arguments,
    # ...,
}

clear()

exchanges = None

Mapping of exchange name to kombu.transport.virtual.exchange.ExchangeType

has_binding(queue, exchange, routing_key)

queue_bindings(queue)

queue_bindings_delete(queue)

queue_index = None

The queue index is used to access directly (constant time) all the bindings of a certain queue. It has the following structure:

{
    queue: {
        (queue, exchange, routing_key),
        # ...,
    },
    # ...,
}