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

Class Message

source code

object --+
         |
        Message

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 = PN_DATA
  TEXT = PN_TEXT
  AMQP = PN_AMQP
  JSON = PN_JSON
  DEFAULT_PRIORITY = PN_DEFAULT_PRIORITY
  inferred = property(_is_inferred, _set_inferred)
  durable = property(_is_durable, _set_durable, doc= ...
  priority = property(_get_priority, _set_priority, doc= ...
  ttl = property(_get_ttl, _set_ttl, doc= ...
  first_acquirer = property(_is_first_acquirer, _set_first_acqui...
  delivery_count = property(_get_delivery_count, _set_delivery_c...
  id = property(_get_id, _set_id, doc= ...
  user_id = property(_get_user_id, _set_user_id, doc= ...
  address = property(_get_address, _set_address, doc= ...
  subject = property(_get_subject, _set_subject, doc= ...
  reply_to = property(_get_reply_to, _set_reply_to, doc= ...
  correlation_id = property(_get_correlation_id, _set_correlatio...
  content_type = property(_get_content_type, _set_content_type, ...
  content_encoding = property(_get_content_encoding, _set_conten...
  expiry_time = property(_get_expiry_time, _set_expiry_time, doc...
  creation_time = property(_get_creation_time, _set_creation_tim...
  group_id = property(_get_group_id, _set_group_id, doc= ...
  group_sequence = property(_get_group_sequence, _set_group_sequ...
  reply_to_group_id = property(_get_reply_to_group_id, _set_repl...
  format = property(_get_format, _set_format, doc= ...
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

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)

Class Variable Details

durable

Value:
property(_is_durable, _set_durable, doc= """
The durable property indicates that the message should be held durably
by any intermediaries taking responsibility for the message.
""")

priority

Value:
property(_get_priority, _set_priority, doc= """
The priority of the message.
""")

ttl

Value:
property(_get_ttl, _set_ttl, doc= """
The time to live of the message measured in milliseconds. Expired
messages may be dropped.
""")

first_acquirer

Value:
property(_is_first_acquirer, _set_first_acquirer, doc= """
True iff the recipient is the first to acquire the message.
""")

delivery_count

Value:
property(_get_delivery_count, _set_delivery_count, doc= """
The number of delivery attempts made for this message.
""")

id

Value:
property(_get_id, _set_id, doc= """
The id of the message.
""")

user_id

Value:
property(_get_user_id, _set_user_id, doc= """
The user id of the message creator.
""")

address

Value:
property(_get_address, _set_address, doc= """
The address of the message.
""")

subject

Value:
property(_get_subject, _set_subject, doc= """
The subject of the message.
""")

reply_to

Value:
property(_get_reply_to, _set_reply_to, doc= """
The reply-to address for the message.
""")

correlation_id

Value:
property(_get_correlation_id, _set_correlation_id, doc= """
The correlation-id for the message.
""")

content_type

Value:
property(_get_content_type, _set_content_type, doc= """
The content-type of the message.
""")

content_encoding

Value:
property(_get_content_encoding, _set_content_encoding, doc= """
The content-encoding of the message.
""")

expiry_time

Value:
property(_get_expiry_time, _set_expiry_time, doc= """
The expiry time of the message.
""")

creation_time

Value:
property(_get_creation_time, _set_creation_time, doc= """
The creation time of the message.
""")

group_id

Value:
property(_get_group_id, _set_group_id, doc= """
The group id of the message.
""")

group_sequence

Value:
property(_get_group_sequence, _set_group_sequence, doc= """
The sequence of the message within its group.
""")

reply_to_group_id

Value:
property(_get_reply_to_group_id, _set_reply_to_group_id, doc= """
The group-id for any replies.
""")

format

Value:
property(_get_format, _set_format, doc= """
The format of the message.
""")