Message¶

class amqpstorm.Message(channel, auto_decode=True, **message)[source]¶

RabbitMQ Message.

e.g.

# Message Properties.
properties = {
    'content_type': 'text/plain',
    'expiration': '3600',
    'headers': {'key': 'value'},
}
# Create a new message.
message = Message.create(channel, 'Hello RabbitMQ!', properties)
# Publish the message to a queue called, 'my_queue'.
message.publish('my_queue')

Parameters:	channel (Channel) – AMQPStorm Channel auto_decode (bool) – Auto-decode strings when possible. Does not apply to to_dict, or to_tuple. body (bytes,str,unicode) – Message payload method (dict) – Message method properties (dict) – Message properties

static create(channel, body, properties=None)[source]¶

Create a new Message.

Parameters:	channel (Channel) – AMQPStorm Channel body (bytes,str,unicode) – Message payload properties (dict) – Message properties
Return type:	Message

body¶

Return the Message Body.

If auto_decode is enabled, the body will automatically be decoded using decode(‘utf-8’) if possible.

Return type:	bytes,str,unicode

channel¶

Return the Channel used by this message.

Return type:	Channel

method¶

Return the Message Method.

If auto_decode is enabled, all strings will automatically be decoded using decode(‘utf-8’) if possible.

Return type:	dict

properties¶

Returns the Message Properties.

If auto_decode is enabled, all strings will automatically be decoded using decode(‘utf-8’) if possible.

Return type:	dict

ack()[source]¶

Acknowledge Message.

Raises:	AMQPInvalidArgument – Invalid Parameters AMQPChannelError – Raises if the channel encountered an error. AMQPConnectionError – Raises if the connection encountered an error.
Returns:

nack(requeue=True)[source]¶

Negative Acknowledgement.

Raises:	AMQPInvalidArgument – Invalid Parameters AMQPChannelError – Raises if the channel encountered an error. AMQPConnectionError – Raises if the connection encountered an error.
Parameters:	requeue (bool) – Re-queue the message

reject(requeue=True)[source]¶

Reject Message.

Raises:	AMQPInvalidArgument – Invalid Parameters AMQPChannelError – Raises if the channel encountered an error. AMQPConnectionError – Raises if the connection encountered an error.
Parameters:	requeue (bool) – Re-queue the message

publish(routing_key, exchange='', mandatory=False, immediate=False)[source]¶

Publish Message.

Parameters:	routing_key (str) – Message routing key exchange (str) – The exchange to publish the message to mandatory (bool) – Requires the message is published immediate (bool) – Request immediate delivery
Raises:	AMQPInvalidArgument – Invalid Parameters AMQPChannelError – Raises if the channel encountered an error. AMQPConnectionError – Raises if the connection encountered an error.
Return type:	bool,None

app_id¶

Get AMQP Message attribute: app_id.

Returns:

message_id¶

Get AMQP Message attribute: message_id.

Returns:

content_encoding¶

Get AMQP Message attribute: content_encoding.

Returns:

content_type¶

Get AMQP Message attribute: content_type.

Returns:

correlation_id¶

Get AMQP Message attribute: correlation_id.

Returns:

delivery_mode¶

Get AMQP Message attribute: delivery_mode.

Returns:

timestamp¶

Get AMQP Message attribute: timestamp.

Returns:

priority¶

Get AMQP Message attribute: priority.

Returns:

reply_to¶

Get AMQP Message attribute: reply_to.

Returns:

redelivered¶

Indicates if this message may have been delivered before (but not acknowledged).

Return type:	bool,None

delivery_tag¶

Server-assigned delivery tag.

Return type:	int,None

json()[source]¶

Deserialize the message body, if it is JSON.

Returns: