API reference

kombu_stomp

kombu_stomp.register_transport()

Register STOMP transport with Kombu.

You will have to manually call this function before being able to use STOMP protocol as Kombu transport.

kombu_stomp.stomp

class kombu_stomp.stomp.Connection(*args, **kwargs)

Connection object used by kombu-stomp

class kombu_stomp.stomp.MessageListener(q=None)

stomp.py listener used by kombu-stomp

iterator(timeout)

Return a Python generator consuming received messages.

If we try to consume a message and there is no messages remaining, then an exception will be raised.

Parameters:timeout (int) – Time to wait for message in seconds, a falsy value if we shouldn’t block for incoming messages. Yields dict:A dictionary representing the message in a Kombu compatible format. Raises:Queue.Empty When there is no message to be consumed.

on_message(headers, body)

Received message hook.

Parameters:

• headers – message headers.
• body – message body.

queue_from_destination(destination)

Get the queue name from a destination header value.

to_kombu_message(headers, body)

Get STOMP headers and body message and return a Kombu message dict.

Parameters:

• headers – message headers.
• body – message body.

Return dict:

A dictionary that Kombu can use for creating a new message object.

kombu_stomp.transport

class kombu_stomp.transport.Channel(*args, **kwargs)

kombu-stomp channel class.

conn_or_acquire(*args, **kwds)

Use current connection or create a new one.

stomp_conn

Property over the stomp.py connection object.

It will create the connection object at first use.

class kombu_stomp.transport.Message(channel, raw_message)

Kombu virtual transport message class for kombu-stomp.

This class extends kombu.transport.virtual.Message, so it keeps STOMP message ID for later use.

class kombu_stomp.transport.QoS(*args, **kwargs)

Kombu quality of service class for kombu-stomp.

class kombu_stomp.transport.Transport(client, **kwargs)

Transport class for kombu-stomp.