Module proton :: Class Message
[frames] | no frames]

Class Message

source code


The Message class is a mutable holder of message content.

Instance Methods
 
__init__(self)
x.__init__(...) initializes x; see help(type(x)) for signature
source code
 
__del__(self) source code
 
clear(self)
Clears the contents of the Message.
source code
 
encode(self) source code
 
decode(self, data) source code
 
load(self, data) source code
 
save(self) source code
 
__repr2__(self) source code
 
__repr__(self)
repr(x)
source code

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __setattr__, __sizeof__, __str__, __subclasshook__

Class Variables
  DATA = 0
  TEXT = 1
  AMQP = 2
  JSON = 3
  DEFAULT_PRIORITY = 4
Instance Variables
dict annotations
infrastructure defined message annotations
bytes | unicode | dict | list | int | long | float | UUID body
message body
dict instructions
delivery instructions for the message
dict properties
application defined message properties
Properties
  inferred
  durable
The durable property indicates that the message should be held durably by any intermediaries taking responsibility for the message.
  priority
The priority of the message.
  ttl
The time to live of the message measured in milliseconds.
  first_acquirer
True iff the recipient is the first to acquire the message.
  delivery_count
The number of delivery attempts made for this message.
  id
The id of the message.
  user_id
The user id of the message creator.
  address
The address of the message.
  subject
The subject of the message.
  reply_to
The reply-to address for the message.
  correlation_id
The correlation-id for the message.
  content_type
The content-type of the message.
  content_encoding
The content-encoding of the message.
  expiry_time
The expiry time of the message.
  creation_time
The creation time of the message.
  group_id
The group id of the message.
  group_sequence
The sequence of the message within its group.
  reply_to_group_id
The group-id for any replies.
  format
The format of the message.

Inherited from object: __class__

Method Details

__init__(self)
(Constructor)

source code 

x.__init__(...) initializes x; see help(type(x)) for signature

Overrides: object.__init__
(inherited documentation)

clear(self)

source code 

Clears the contents of the Message. All fields will be reset to their default values.

__repr__(self)
(Representation operator)

source code 

repr(x)

Overrides: object.__repr__
(inherited documentation)

Property Details

inferred

Get Method:
_is_inferred(self)
Set Method:
_set_inferred(self, value)

durable

The durable property indicates that the message should be held durably by any intermediaries taking responsibility for the message.

Get Method:
_is_durable(self)
Set Method:
_set_durable(self, value)

priority

The priority of the message.

Get Method:
_get_priority(self)
Set Method:
_set_priority(self, value)

ttl

The time to live of the message measured in milliseconds. Expired messages may be dropped.

Get Method:
_get_ttl(self)
Set Method:
_set_ttl(self, value)

first_acquirer

True iff the recipient is the first to acquire the message.

Get Method:
_is_first_acquirer(self)
Set Method:
_set_first_acquirer(self, value)

delivery_count

The number of delivery attempts made for this message.

Get Method:
_get_delivery_count(self)
Set Method:
_set_delivery_count(self, value)

id

The id of the message.

Get Method:
_get_id(self)
Set Method:
_set_id(self, value)

user_id

The user id of the message creator.

Get Method:
_get_user_id(self)
Set Method:
_set_user_id(self, value)

address

The address of the message.

Get Method:
_get_address(self)
Set Method:
_set_address(self, value)

subject

The subject of the message.

Get Method:
_get_subject(self)
Set Method:
_set_subject(self, value)

reply_to

The reply-to address for the message.

Get Method:
_get_reply_to(self)
Set Method:
_set_reply_to(self, value)

correlation_id

The correlation-id for the message.

Get Method:
_get_correlation_id(self)
Set Method:
_set_correlation_id(self, value)

content_type

The content-type of the message.

Get Method:
_get_content_type(self)
Set Method:
_set_content_type(self, value)

content_encoding

The content-encoding of the message.

Get Method:
_get_content_encoding(self)
Set Method:
_set_content_encoding(self, value)

expiry_time

The expiry time of the message.

Get Method:
_get_expiry_time(self)
Set Method:
_set_expiry_time(self, value)

creation_time

The creation time of the message.

Get Method:
_get_creation_time(self)
Set Method:
_set_creation_time(self, value)

group_id

The group id of the message.

Get Method:
_get_group_id(self)
Set Method:
_set_group_id(self, value)

group_sequence

The sequence of the message within its group.

Get Method:
_get_group_sequence(self)
Set Method:
_set_group_sequence(self, value)

reply_to_group_id

The group-id for any replies.

Get Method:
_get_reply_to_group_id(self)
Set Method:
_set_reply_to_group_id(self, value)

format

The format of the message.

Get Method:
_get_format(self)
Set Method:
_set_format(self, value)