| <?xml version="1.0" encoding="ascii"?> |
| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" |
| "DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
| <head> |
| <title>proton._message.Message</title> |
| <link rel="stylesheet" href="epydoc.css" type="text/css" /> |
| <script type="text/javascript" src="epydoc.js"></script> |
| </head> |
| |
| <body bgcolor="white" text="black" link="blue" vlink="#204080" |
| alink="#204080"> |
| <!-- ==================== NAVIGATION BAR ==================== --> |
| <table class="navbar" border="0" width="100%" cellpadding="0" |
| bgcolor="#a0c0ff" cellspacing="0"> |
| <tr valign="middle"> |
| <!-- Home link --> |
| <th> <a |
| href="proton-module.html">Home</a> </th> |
| |
| <!-- Tree link --> |
| <th> <a |
| href="module-tree.html">Trees</a> </th> |
| |
| <!-- Index link --> |
| <th> <a |
| href="identifier-index.html">Indices</a> </th> |
| |
| <!-- Help link --> |
| <th> <a |
| href="help.html">Help</a> </th> |
| |
| <!-- Project homepage --> |
| <th class="navbar" align="right" width="100%"> |
| <table border="0" cellpadding="0" cellspacing="0"> |
| <tr><th class="navbar" align="center" |
| ><a class="navbar" target="_top" href="http://qpid.apache.org/index.html">Qpid Proton Python API</a></th> |
| </tr></table></th> |
| </tr> |
| </table> |
| <table width="100%" cellpadding="0" cellspacing="0"> |
| <tr valign="top"> |
| <td width="100%"> |
| <span class="breadcrumbs"> |
| <a href="proton-module.html">Package proton</a> :: |
| <a href="proton._message-module.html" onclick="show_private();">Module _message</a> :: |
| Class Message |
| </span> |
| </td> |
| <td> |
| <table cellpadding="0" cellspacing="0"> |
| <!-- hide/show private --> |
| <tr><td align="right"><span class="options" |
| >[<a href="frames.html" target="_top">frames</a |
| >] | <a href="proton._message.Message-class.html" |
| target="_top">no frames</a>]</span></td></tr> |
| </table> |
| </td> |
| </tr> |
| </table> |
| <!-- ==================== TYPE DESCRIPTION ==================== --> |
| <h1 class="epydoc">type Message</h1><p class="nomargin-top"><span class="codelink"><a href="proton._message-pysrc.html#Message">source code</a></span></p> |
| <center> |
| |
| </center> |
| <hr /> |
| <p>The <a href="proton._message.Message-class.html" |
| class="link">Message</a> class is a mutable holder of message |
| content.</p> |
| |
| <!-- ==================== INSTANCE METHODS ==================== --> |
| <a name="section-InstanceMethods"></a> |
| <table class="summary" border="1" cellpadding="3" |
| cellspacing="0" width="100%" bgcolor="white"> |
| <tr bgcolor="#70b0f0" class="table-header"> |
| <td align="left" colspan="2" class="table-header"> |
| <span class="table-header">Instance Methods</span></td> |
| </tr> |
| <tr> |
| <td width="15%" align="right" valign="top" class="summary"> |
| <span class="summary-type"> </span> |
| </td><td class="summary"> |
| <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td><span class="summary-sig"><a href="proton._message.Message-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>, |
| <span class="summary-sig-arg">body</span>=<span class="summary-sig-default">None</span>, |
| <span class="summary-sig-arg">**kwargs</span>)</span></td> |
| <td align="right" valign="top"> |
| <span class="codelink"><a href="proton._message-pysrc.html#Message.__init__">source code</a></span> |
| |
| </td> |
| </tr> |
| </table> |
| |
| </td> |
| </tr> |
| <tr> |
| <td width="15%" align="right" valign="top" class="summary"> |
| <span class="summary-type"> </span> |
| </td><td class="summary"> |
| <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td><span class="summary-sig"><a name="__del__"></a><span class="summary-sig-name">__del__</span>(<span class="summary-sig-arg">self</span>)</span></td> |
| <td align="right" valign="top"> |
| <span class="codelink"><a href="proton._message-pysrc.html#Message.__del__">source code</a></span> |
| |
| </td> |
| </tr> |
| </table> |
| |
| </td> |
| </tr> |
| <tr> |
| <td width="15%" align="right" valign="top" class="summary"> |
| <span class="summary-type"> </span> |
| </td><td class="summary"> |
| <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td><span class="summary-sig"><a href="proton._message.Message-class.html#clear" class="summary-sig-name">clear</a>(<span class="summary-sig-arg">self</span>)</span><br /> |
| Clears the contents of the <a |
| href="proton._message.Message-class.html" class="link">Message</a>.</td> |
| <td align="right" valign="top"> |
| <span class="codelink"><a href="proton._message-pysrc.html#Message.clear">source code</a></span> |
| |
| </td> |
| </tr> |
| </table> |
| |
| </td> |
| </tr> |
| <tr> |
| <td width="15%" align="right" valign="top" class="summary"> |
| <span class="summary-type"> </span> |
| </td><td class="summary"> |
| <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td><span class="summary-sig"><a name="encode"></a><span class="summary-sig-name">encode</span>(<span class="summary-sig-arg">self</span>)</span></td> |
| <td align="right" valign="top"> |
| <span class="codelink"><a href="proton._message-pysrc.html#Message.encode">source code</a></span> |
| |
| </td> |
| </tr> |
| </table> |
| |
| </td> |
| </tr> |
| <tr> |
| <td width="15%" align="right" valign="top" class="summary"> |
| <span class="summary-type"> </span> |
| </td><td class="summary"> |
| <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td><span class="summary-sig"><a name="decode"></a><span class="summary-sig-name">decode</span>(<span class="summary-sig-arg">self</span>, |
| <span class="summary-sig-arg">data</span>)</span></td> |
| <td align="right" valign="top"> |
| <span class="codelink"><a href="proton._message-pysrc.html#Message.decode">source code</a></span> |
| |
| </td> |
| </tr> |
| </table> |
| |
| </td> |
| </tr> |
| <tr> |
| <td width="15%" align="right" valign="top" class="summary"> |
| <span class="summary-type"> </span> |
| </td><td class="summary"> |
| <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td><span class="summary-sig"><a name="send"></a><span class="summary-sig-name">send</span>(<span class="summary-sig-arg">self</span>, |
| <span class="summary-sig-arg">sender</span>, |
| <span class="summary-sig-arg">tag</span>=<span class="summary-sig-default">None</span>)</span></td> |
| <td align="right" valign="top"> |
| <span class="codelink"><a href="proton._message-pysrc.html#Message.send">source code</a></span> |
| |
| </td> |
| </tr> |
| </table> |
| |
| </td> |
| </tr> |
| <tr> |
| <td width="15%" align="right" valign="top" class="summary"> |
| <span class="summary-type"> </span> |
| </td><td class="summary"> |
| <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td><span class="summary-sig"><a href="proton._message.Message-class.html#recv" class="summary-sig-name">recv</a>(<span class="summary-sig-arg">self</span>, |
| <span class="summary-sig-arg">link</span>)</span><br /> |
| Receives and decodes the message content for the current delivery |
| from the link.</td> |
| <td align="right" valign="top"> |
| <span class="codelink"><a href="proton._message-pysrc.html#Message.recv">source code</a></span> |
| |
| </td> |
| </tr> |
| </table> |
| |
| </td> |
| </tr> |
| <tr> |
| <td width="15%" align="right" valign="top" class="summary"> |
| <span class="summary-type"> </span> |
| </td><td class="summary"> |
| <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td><span class="summary-sig"><a name="__repr2__"></a><span class="summary-sig-name">__repr2__</span>(<span class="summary-sig-arg">self</span>)</span></td> |
| <td align="right" valign="top"> |
| <span class="codelink"><a href="proton._message-pysrc.html#Message.__repr2__">source code</a></span> |
| |
| </td> |
| </tr> |
| </table> |
| |
| </td> |
| </tr> |
| <tr> |
| <td width="15%" align="right" valign="top" class="summary"> |
| <span class="summary-type"> </span> |
| </td><td class="summary"> |
| <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td><span class="summary-sig"><a href="proton._message.Message-class.html#__repr__" class="summary-sig-name">__repr__</a>(<span class="summary-sig-arg">self</span>)</span></td> |
| <td align="right" valign="top"> |
| <span class="codelink"><a href="proton._message-pysrc.html#Message.__repr__">source code</a></span> |
| |
| </td> |
| </tr> |
| </table> |
| |
| </td> |
| </tr> |
| </table> |
| <!-- ==================== CLASS VARIABLES ==================== --> |
| <a name="section-ClassVariables"></a> |
| <table class="summary" border="1" cellpadding="3" |
| cellspacing="0" width="100%" bgcolor="white"> |
| <tr bgcolor="#70b0f0" class="table-header"> |
| <td align="left" colspan="2" class="table-header"> |
| <span class="table-header">Class Variables</span></td> |
| </tr> |
| <tr> |
| <td width="15%" align="right" valign="top" class="summary"> |
| <span class="summary-type"> </span> |
| </td><td class="summary"> |
| <a name="DEFAULT_PRIORITY"></a><span class="summary-name">DEFAULT_PRIORITY</span> = <code title="4">4</code> |
| </td> |
| </tr> |
| </table> |
| <!-- ==================== INSTANCE VARIABLES ==================== --> |
| <a name="section-InstanceVariables"></a> |
| <table class="summary" border="1" cellpadding="3" |
| cellspacing="0" width="100%" bgcolor="white"> |
| <tr bgcolor="#70b0f0" class="table-header"> |
| <td align="left" colspan="2" class="table-header"> |
| <span class="table-header">Instance Variables</span></td> |
| </tr> |
| <tr> |
| <td width="15%" align="right" valign="top" class="summary"> |
| <span class="summary-type">dict</span> |
| </td><td class="summary"> |
| <a name="annotations"></a><span class="summary-name">annotations</span><br /> |
| infrastructure defined message annotations |
| </td> |
| </tr> |
| <tr> |
| <td width="15%" align="right" valign="top" class="summary"> |
| <span class="summary-type">bytes | unicode | dict | list | int | long | float | UUID</span> |
| </td><td class="summary"> |
| <a name="body"></a><span class="summary-name">body</span><br /> |
| message body |
| </td> |
| </tr> |
| <tr> |
| <td width="15%" align="right" valign="top" class="summary"> |
| <span class="summary-type">dict</span> |
| </td><td class="summary"> |
| <a name="instructions"></a><span class="summary-name">instructions</span><br /> |
| delivery instructions for the message |
| </td> |
| </tr> |
| <tr> |
| <td width="15%" align="right" valign="top" class="summary"> |
| <span class="summary-type">dict</span> |
| </td><td class="summary"> |
| <a name="properties"></a><span class="summary-name">properties</span><br /> |
| application defined message properties |
| </td> |
| </tr> |
| </table> |
| <!-- ==================== PROPERTIES ==================== --> |
| <a name="section-Properties"></a> |
| <table class="summary" border="1" cellpadding="3" |
| cellspacing="0" width="100%" bgcolor="white"> |
| <tr bgcolor="#70b0f0" class="table-header"> |
| <td align="left" colspan="2" class="table-header"> |
| <span class="table-header">Properties</span></td> |
| </tr> |
| <tr> |
| <td width="15%" align="right" valign="top" class="summary"> |
| <span class="summary-type"> </span> |
| </td><td class="summary"> |
| <a href="proton._message.Message-class.html#inferred" class="summary-name">inferred</a><br /> |
| The inferred flag for a message indicates how the message content is |
| encoded into AMQP sections. |
| </td> |
| </tr> |
| <tr> |
| <td width="15%" align="right" valign="top" class="summary"> |
| <span class="summary-type"> </span> |
| </td><td class="summary"> |
| <a href="proton._message.Message-class.html#durable" class="summary-name">durable</a><br /> |
| The durable property indicates that the message should be held |
| durably by any intermediaries taking responsibility for the message. |
| </td> |
| </tr> |
| <tr> |
| <td width="15%" align="right" valign="top" class="summary"> |
| <span class="summary-type"> </span> |
| </td><td class="summary"> |
| <a href="proton._message.Message-class.html#priority" class="summary-name">priority</a><br /> |
| The priority of the message. |
| </td> |
| </tr> |
| <tr> |
| <td width="15%" align="right" valign="top" class="summary"> |
| <span class="summary-type"> </span> |
| </td><td class="summary"> |
| <a href="proton._message.Message-class.html#ttl" class="summary-name">ttl</a><br /> |
| The time to live of the message measured in seconds. |
| </td> |
| </tr> |
| <tr> |
| <td width="15%" align="right" valign="top" class="summary"> |
| <span class="summary-type"> </span> |
| </td><td class="summary"> |
| <a href="proton._message.Message-class.html#first_acquirer" class="summary-name">first_acquirer</a><br /> |
| True iff the recipient is the first to acquire the message. |
| </td> |
| </tr> |
| <tr> |
| <td width="15%" align="right" valign="top" class="summary"> |
| <span class="summary-type"> </span> |
| </td><td class="summary"> |
| <a href="proton._message.Message-class.html#delivery_count" class="summary-name">delivery_count</a><br /> |
| The number of delivery attempts made for this message. |
| </td> |
| </tr> |
| <tr> |
| <td width="15%" align="right" valign="top" class="summary"> |
| <span class="summary-type"> </span> |
| </td><td class="summary"> |
| <a href="proton._message.Message-class.html#id" class="summary-name">id</a><br /> |
| The id of the message. |
| </td> |
| </tr> |
| <tr> |
| <td width="15%" align="right" valign="top" class="summary"> |
| <span class="summary-type"> </span> |
| </td><td class="summary"> |
| <a href="proton._message.Message-class.html#user_id" class="summary-name">user_id</a><br /> |
| The user id of the message creator. |
| </td> |
| </tr> |
| <tr> |
| <td width="15%" align="right" valign="top" class="summary"> |
| <span class="summary-type"> </span> |
| </td><td class="summary"> |
| <a href="proton._message.Message-class.html#address" class="summary-name">address</a><br /> |
| The address of the message. |
| </td> |
| </tr> |
| <tr> |
| <td width="15%" align="right" valign="top" class="summary"> |
| <span class="summary-type"> </span> |
| </td><td class="summary"> |
| <a href="proton._message.Message-class.html#subject" class="summary-name">subject</a><br /> |
| The subject of the message. |
| </td> |
| </tr> |
| <tr> |
| <td width="15%" align="right" valign="top" class="summary"> |
| <span class="summary-type"> </span> |
| </td><td class="summary"> |
| <a href="proton._message.Message-class.html#reply_to" class="summary-name">reply_to</a><br /> |
| The reply-to address for the message. |
| </td> |
| </tr> |
| <tr> |
| <td width="15%" align="right" valign="top" class="summary"> |
| <span class="summary-type"> </span> |
| </td><td class="summary"> |
| <a href="proton._message.Message-class.html#correlation_id" class="summary-name">correlation_id</a><br /> |
| The correlation-id for the message. |
| </td> |
| </tr> |
| <tr> |
| <td width="15%" align="right" valign="top" class="summary"> |
| <span class="summary-type"> </span> |
| </td><td class="summary"> |
| <a href="proton._message.Message-class.html#content_type" class="summary-name">content_type</a><br /> |
| The content-type of the message. |
| </td> |
| </tr> |
| <tr> |
| <td width="15%" align="right" valign="top" class="summary"> |
| <span class="summary-type"> </span> |
| </td><td class="summary"> |
| <a href="proton._message.Message-class.html#content_encoding" class="summary-name">content_encoding</a><br /> |
| The content-encoding of the message. |
| </td> |
| </tr> |
| <tr> |
| <td width="15%" align="right" valign="top" class="summary"> |
| <span class="summary-type"> </span> |
| </td><td class="summary"> |
| <a href="proton._message.Message-class.html#expiry_time" class="summary-name">expiry_time</a><br /> |
| The expiry time of the message. |
| </td> |
| </tr> |
| <tr> |
| <td width="15%" align="right" valign="top" class="summary"> |
| <span class="summary-type"> </span> |
| </td><td class="summary"> |
| <a href="proton._message.Message-class.html#creation_time" class="summary-name">creation_time</a><br /> |
| The creation time of the message. |
| </td> |
| </tr> |
| <tr> |
| <td width="15%" align="right" valign="top" class="summary"> |
| <span class="summary-type"> </span> |
| </td><td class="summary"> |
| <a href="proton._message.Message-class.html#group_id" class="summary-name">group_id</a><br /> |
| The group id of the message. |
| </td> |
| </tr> |
| <tr> |
| <td width="15%" align="right" valign="top" class="summary"> |
| <span class="summary-type"> </span> |
| </td><td class="summary"> |
| <a href="proton._message.Message-class.html#group_sequence" class="summary-name">group_sequence</a><br /> |
| The sequence of the message within its group. |
| </td> |
| </tr> |
| <tr> |
| <td width="15%" align="right" valign="top" class="summary"> |
| <span class="summary-type"> </span> |
| </td><td class="summary"> |
| <a href="proton._message.Message-class.html#reply_to_group_id" class="summary-name">reply_to_group_id</a><br /> |
| The group-id for any replies. |
| </td> |
| </tr> |
| </table> |
| <!-- ==================== METHOD DETAILS ==================== --> |
| <a name="section-MethodDetails"></a> |
| <table class="details" border="1" cellpadding="3" |
| cellspacing="0" width="100%" bgcolor="white"> |
| <tr bgcolor="#70b0f0" class="table-header"> |
| <td align="left" colspan="2" class="table-header"> |
| <span class="table-header">Method Details</span></td> |
| </tr> |
| </table> |
| <a name="__init__"></a> |
| <div> |
| <table class="details" border="1" cellpadding="3" |
| cellspacing="0" width="100%" bgcolor="white"> |
| <tr><td> |
| <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| <tr valign="top"><td> |
| <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>, |
| <span class="sig-arg">body</span>=<span class="sig-default">None</span>, |
| <span class="sig-arg">**kwargs</span>)</span> |
| <br /><em class="fname">(Constructor)</em> |
| </h3> |
| </td><td align="right" valign="top" |
| ><span class="codelink"><a href="proton._message-pysrc.html#Message.__init__">source code</a></span> |
| </td> |
| </tr></table> |
| |
| |
| <dl class="fields"> |
| <dt>Parameters:</dt> |
| <dd><ul class="nomargin-top"> |
| <li><strong class="pname"><code>kwargs</code></strong> - Message property name/value pairs to initialise the Message</li> |
| </ul></dd> |
| <dt>Overrides: |
| object.__init__ |
| </dt> |
| </dl> |
| </td></tr></table> |
| </div> |
| <a name="clear"></a> |
| <div> |
| <table class="details" border="1" cellpadding="3" |
| cellspacing="0" width="100%" bgcolor="white"> |
| <tr><td> |
| <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| <tr valign="top"><td> |
| <h3 class="epydoc"><span class="sig"><span class="sig-name">clear</span>(<span class="sig-arg">self</span>)</span> |
| </h3> |
| </td><td align="right" valign="top" |
| ><span class="codelink"><a href="proton._message-pysrc.html#Message.clear">source code</a></span> |
| </td> |
| </tr></table> |
| |
| <p>Clears the contents of the <a |
| href="proton._message.Message-class.html" class="link">Message</a>. All |
| fields will be reset to their default values.</p> |
| <dl class="fields"> |
| </dl> |
| </td></tr></table> |
| </div> |
| <a name="recv"></a> |
| <div> |
| <table class="details" border="1" cellpadding="3" |
| cellspacing="0" width="100%" bgcolor="white"> |
| <tr><td> |
| <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| <tr valign="top"><td> |
| <h3 class="epydoc"><span class="sig"><span class="sig-name">recv</span>(<span class="sig-arg">self</span>, |
| <span class="sig-arg">link</span>)</span> |
| </h3> |
| </td><td align="right" valign="top" |
| ><span class="codelink"><a href="proton._message-pysrc.html#Message.recv">source code</a></span> |
| </td> |
| </tr></table> |
| |
| <p>Receives and decodes the message content for the current delivery from |
| the link. Upon success it will return the current delivery for the link. |
| If there is no current delivery, or if the current delivery is |
| incomplete, or if the link is not a receiver, it will return None.</p> |
| <dl class="fields"> |
| <dt>Parameters:</dt> |
| <dd><ul class="nomargin-top"> |
| <li><strong class="pname"><code>link</code></strong> (Link) - the link to receive a message from @return the delivery |
| associated with the decoded message (or None)</li> |
| </ul></dd> |
| </dl> |
| </td></tr></table> |
| </div> |
| <a name="__repr__"></a> |
| <div> |
| <table class="details" border="1" cellpadding="3" |
| cellspacing="0" width="100%" bgcolor="white"> |
| <tr><td> |
| <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| <tr valign="top"><td> |
| <h3 class="epydoc"><span class="sig"><span class="sig-name">__repr__</span>(<span class="sig-arg">self</span>)</span> |
| <br /><em class="fname">(Representation operator)</em> |
| </h3> |
| </td><td align="right" valign="top" |
| ><span class="codelink"><a href="proton._message-pysrc.html#Message.__repr__">source code</a></span> |
| </td> |
| </tr></table> |
| |
| |
| <dl class="fields"> |
| <dt>Overrides: |
| object.__repr__ |
| <dd><em class="note">(inherited documentation)</em></dd> |
| </dt> |
| </dl> |
| </td></tr></table> |
| </div> |
| <br /> |
| <!-- ==================== PROPERTY DETAILS ==================== --> |
| <a name="section-PropertyDetails"></a> |
| <table class="details" border="1" cellpadding="3" |
| cellspacing="0" width="100%" bgcolor="white"> |
| <tr bgcolor="#70b0f0" class="table-header"> |
| <td align="left" colspan="2" class="table-header"> |
| <span class="table-header">Property Details</span></td> |
| </tr> |
| </table> |
| <a name="inferred"></a> |
| <div> |
| <table class="details" border="1" cellpadding="3" |
| cellspacing="0" width="100%" bgcolor="white"> |
| <tr><td> |
| <h3 class="epydoc">inferred</h3> |
| <p>The inferred flag for a message indicates how the message content is |
| encoded into AMQP sections. If inferred is true then binary and list |
| values in the body of the message will be encoded as AMQP DATA and AMQP |
| SEQUENCE sections, respectively. If inferred is false, then all values in |
| the body of the message will be encoded as AMQP VALUE sections regardless |
| of their type.</p> |
| <dl class="fields"> |
| <dt>Get Method:</dt> |
| <dd class="value"><span class="summary-sig"><a href="proton._message.Message-class.html#_is_inferred" class="summary-sig-name" onclick="show_private();">_is_inferred</a>(<span class="summary-sig-arg">self</span>)</span> |
| </dd> |
| <dt>Set Method:</dt> |
| <dd class="value"><span class="summary-sig"><a href="proton._message.Message-class.html#_set_inferred" class="summary-sig-name" onclick="show_private();">_set_inferred</a>(<span class="summary-sig-arg">self</span>, |
| <span class="summary-sig-arg">value</span>)</span> |
| </dd> |
| </dl> |
| </td></tr></table> |
| </div> |
| <a name="durable"></a> |
| <div> |
| <table class="details" border="1" cellpadding="3" |
| cellspacing="0" width="100%" bgcolor="white"> |
| <tr><td> |
| <h3 class="epydoc">durable</h3> |
| <p>The durable property indicates that the message should be held durably |
| by any intermediaries taking responsibility for the message.</p> |
| <dl class="fields"> |
| <dt>Get Method:</dt> |
| <dd class="value"><span class="summary-sig"><a href="proton._message.Message-class.html#_is_durable" class="summary-sig-name" onclick="show_private();">_is_durable</a>(<span class="summary-sig-arg">self</span>)</span> |
| </dd> |
| <dt>Set Method:</dt> |
| <dd class="value"><span class="summary-sig"><a href="proton._message.Message-class.html#_set_durable" class="summary-sig-name" onclick="show_private();">_set_durable</a>(<span class="summary-sig-arg">self</span>, |
| <span class="summary-sig-arg">value</span>)</span> |
| </dd> |
| </dl> |
| </td></tr></table> |
| </div> |
| <a name="priority"></a> |
| <div> |
| <table class="details" border="1" cellpadding="3" |
| cellspacing="0" width="100%" bgcolor="white"> |
| <tr><td> |
| <h3 class="epydoc">priority</h3> |
| <p>The priority of the message.</p> |
| <dl class="fields"> |
| <dt>Get Method:</dt> |
| <dd class="value"><span class="summary-sig"><a href="proton._message.Message-class.html#_get_priority" class="summary-sig-name" onclick="show_private();">_get_priority</a>(<span class="summary-sig-arg">self</span>)</span> |
| </dd> |
| <dt>Set Method:</dt> |
| <dd class="value"><span class="summary-sig"><a href="proton._message.Message-class.html#_set_priority" class="summary-sig-name" onclick="show_private();">_set_priority</a>(<span class="summary-sig-arg">self</span>, |
| <span class="summary-sig-arg">value</span>)</span> |
| </dd> |
| </dl> |
| </td></tr></table> |
| </div> |
| <a name="ttl"></a> |
| <div> |
| <table class="details" border="1" cellpadding="3" |
| cellspacing="0" width="100%" bgcolor="white"> |
| <tr><td> |
| <h3 class="epydoc">ttl</h3> |
| <p>The time to live of the message measured in seconds. Expired messages |
| may be dropped.</p> |
| <dl class="fields"> |
| <dt>Get Method:</dt> |
| <dd class="value"><span class="summary-sig"><a href="proton._message.Message-class.html#_get_ttl" class="summary-sig-name" onclick="show_private();">_get_ttl</a>(<span class="summary-sig-arg">self</span>)</span> |
| </dd> |
| <dt>Set Method:</dt> |
| <dd class="value"><span class="summary-sig"><a href="proton._message.Message-class.html#_set_ttl" class="summary-sig-name" onclick="show_private();">_set_ttl</a>(<span class="summary-sig-arg">self</span>, |
| <span class="summary-sig-arg">value</span>)</span> |
| </dd> |
| </dl> |
| </td></tr></table> |
| </div> |
| <a name="first_acquirer"></a> |
| <div> |
| <table class="details" border="1" cellpadding="3" |
| cellspacing="0" width="100%" bgcolor="white"> |
| <tr><td> |
| <h3 class="epydoc">first_acquirer</h3> |
| <p>True iff the recipient is the first to acquire the message.</p> |
| <dl class="fields"> |
| <dt>Get Method:</dt> |
| <dd class="value"><span class="summary-sig"><a href="proton._message.Message-class.html#_is_first_acquirer" class="summary-sig-name" onclick="show_private();">_is_first_acquirer</a>(<span class="summary-sig-arg">self</span>)</span> |
| </dd> |
| <dt>Set Method:</dt> |
| <dd class="value"><span class="summary-sig"><a href="proton._message.Message-class.html#_set_first_acquirer" class="summary-sig-name" onclick="show_private();">_set_first_acquirer</a>(<span class="summary-sig-arg">self</span>, |
| <span class="summary-sig-arg">value</span>)</span> |
| </dd> |
| </dl> |
| </td></tr></table> |
| </div> |
| <a name="delivery_count"></a> |
| <div> |
| <table class="details" border="1" cellpadding="3" |
| cellspacing="0" width="100%" bgcolor="white"> |
| <tr><td> |
| <h3 class="epydoc">delivery_count</h3> |
| <p>The number of delivery attempts made for this message.</p> |
| <dl class="fields"> |
| <dt>Get Method:</dt> |
| <dd class="value"><span class="summary-sig"><a href="proton._message.Message-class.html#_get_delivery_count" class="summary-sig-name" onclick="show_private();">_get_delivery_count</a>(<span class="summary-sig-arg">self</span>)</span> |
| </dd> |
| <dt>Set Method:</dt> |
| <dd class="value"><span class="summary-sig"><a href="proton._message.Message-class.html#_set_delivery_count" class="summary-sig-name" onclick="show_private();">_set_delivery_count</a>(<span class="summary-sig-arg">self</span>, |
| <span class="summary-sig-arg">value</span>)</span> |
| </dd> |
| </dl> |
| </td></tr></table> |
| </div> |
| <a name="id"></a> |
| <div> |
| <table class="details" border="1" cellpadding="3" |
| cellspacing="0" width="100%" bgcolor="white"> |
| <tr><td> |
| <h3 class="epydoc">id</h3> |
| <p>The id of the message.</p> |
| <dl class="fields"> |
| <dt>Get Method:</dt> |
| <dd class="value"><span class="summary-sig"><a href="proton._message.Message-class.html#_get_id" class="summary-sig-name" onclick="show_private();">_get_id</a>(<span class="summary-sig-arg">self</span>)</span> |
| </dd> |
| <dt>Set Method:</dt> |
| <dd class="value"><span class="summary-sig"><a href="proton._message.Message-class.html#_set_id" class="summary-sig-name" onclick="show_private();">_set_id</a>(<span class="summary-sig-arg">self</span>, |
| <span class="summary-sig-arg">value</span>)</span> |
| </dd> |
| </dl> |
| </td></tr></table> |
| </div> |
| <a name="user_id"></a> |
| <div> |
| <table class="details" border="1" cellpadding="3" |
| cellspacing="0" width="100%" bgcolor="white"> |
| <tr><td> |
| <h3 class="epydoc">user_id</h3> |
| <p>The user id of the message creator.</p> |
| <dl class="fields"> |
| <dt>Get Method:</dt> |
| <dd class="value"><span class="summary-sig"><a href="proton._message.Message-class.html#_get_user_id" class="summary-sig-name" onclick="show_private();">_get_user_id</a>(<span class="summary-sig-arg">self</span>)</span> |
| </dd> |
| <dt>Set Method:</dt> |
| <dd class="value"><span class="summary-sig"><a href="proton._message.Message-class.html#_set_user_id" class="summary-sig-name" onclick="show_private();">_set_user_id</a>(<span class="summary-sig-arg">self</span>, |
| <span class="summary-sig-arg">value</span>)</span> |
| </dd> |
| </dl> |
| </td></tr></table> |
| </div> |
| <a name="address"></a> |
| <div> |
| <table class="details" border="1" cellpadding="3" |
| cellspacing="0" width="100%" bgcolor="white"> |
| <tr><td> |
| <h3 class="epydoc">address</h3> |
| <p>The address of the message.</p> |
| <dl class="fields"> |
| <dt>Get Method:</dt> |
| <dd class="value"><span class="summary-sig"><a href="proton._message.Message-class.html#_get_address" class="summary-sig-name" onclick="show_private();">_get_address</a>(<span class="summary-sig-arg">self</span>)</span> |
| </dd> |
| <dt>Set Method:</dt> |
| <dd class="value"><span class="summary-sig"><a href="proton._message.Message-class.html#_set_address" class="summary-sig-name" onclick="show_private();">_set_address</a>(<span class="summary-sig-arg">self</span>, |
| <span class="summary-sig-arg">value</span>)</span> |
| </dd> |
| </dl> |
| </td></tr></table> |
| </div> |
| <a name="subject"></a> |
| <div> |
| <table class="details" border="1" cellpadding="3" |
| cellspacing="0" width="100%" bgcolor="white"> |
| <tr><td> |
| <h3 class="epydoc">subject</h3> |
| <p>The subject of the message.</p> |
| <dl class="fields"> |
| <dt>Get Method:</dt> |
| <dd class="value"><span class="summary-sig"><a href="proton._message.Message-class.html#_get_subject" class="summary-sig-name" onclick="show_private();">_get_subject</a>(<span class="summary-sig-arg">self</span>)</span> |
| </dd> |
| <dt>Set Method:</dt> |
| <dd class="value"><span class="summary-sig"><a href="proton._message.Message-class.html#_set_subject" class="summary-sig-name" onclick="show_private();">_set_subject</a>(<span class="summary-sig-arg">self</span>, |
| <span class="summary-sig-arg">value</span>)</span> |
| </dd> |
| </dl> |
| </td></tr></table> |
| </div> |
| <a name="reply_to"></a> |
| <div> |
| <table class="details" border="1" cellpadding="3" |
| cellspacing="0" width="100%" bgcolor="white"> |
| <tr><td> |
| <h3 class="epydoc">reply_to</h3> |
| <p>The reply-to address for the message.</p> |
| <dl class="fields"> |
| <dt>Get Method:</dt> |
| <dd class="value"><span class="summary-sig"><a href="proton._message.Message-class.html#_get_reply_to" class="summary-sig-name" onclick="show_private();">_get_reply_to</a>(<span class="summary-sig-arg">self</span>)</span> |
| </dd> |
| <dt>Set Method:</dt> |
| <dd class="value"><span class="summary-sig"><a href="proton._message.Message-class.html#_set_reply_to" class="summary-sig-name" onclick="show_private();">_set_reply_to</a>(<span class="summary-sig-arg">self</span>, |
| <span class="summary-sig-arg">value</span>)</span> |
| </dd> |
| </dl> |
| </td></tr></table> |
| </div> |
| <a name="correlation_id"></a> |
| <div> |
| <table class="details" border="1" cellpadding="3" |
| cellspacing="0" width="100%" bgcolor="white"> |
| <tr><td> |
| <h3 class="epydoc">correlation_id</h3> |
| <p>The correlation-id for the message.</p> |
| <dl class="fields"> |
| <dt>Get Method:</dt> |
| <dd class="value"><span class="summary-sig"><a href="proton._message.Message-class.html#_get_correlation_id" class="summary-sig-name" onclick="show_private();">_get_correlation_id</a>(<span class="summary-sig-arg">self</span>)</span> |
| </dd> |
| <dt>Set Method:</dt> |
| <dd class="value"><span class="summary-sig"><a href="proton._message.Message-class.html#_set_correlation_id" class="summary-sig-name" onclick="show_private();">_set_correlation_id</a>(<span class="summary-sig-arg">self</span>, |
| <span class="summary-sig-arg">value</span>)</span> |
| </dd> |
| </dl> |
| </td></tr></table> |
| </div> |
| <a name="content_type"></a> |
| <div> |
| <table class="details" border="1" cellpadding="3" |
| cellspacing="0" width="100%" bgcolor="white"> |
| <tr><td> |
| <h3 class="epydoc">content_type</h3> |
| <p>The content-type of the message.</p> |
| <dl class="fields"> |
| <dt>Get Method:</dt> |
| <dd class="value"><span class="summary-sig"><a href="proton._message.Message-class.html#_get_content_type" class="summary-sig-name" onclick="show_private();">_get_content_type</a>(<span class="summary-sig-arg">self</span>)</span> |
| </dd> |
| <dt>Set Method:</dt> |
| <dd class="value"><span class="summary-sig"><a href="proton._message.Message-class.html#_set_content_type" class="summary-sig-name" onclick="show_private();">_set_content_type</a>(<span class="summary-sig-arg">self</span>, |
| <span class="summary-sig-arg">value</span>)</span> |
| </dd> |
| </dl> |
| </td></tr></table> |
| </div> |
| <a name="content_encoding"></a> |
| <div> |
| <table class="details" border="1" cellpadding="3" |
| cellspacing="0" width="100%" bgcolor="white"> |
| <tr><td> |
| <h3 class="epydoc">content_encoding</h3> |
| <p>The content-encoding of the message.</p> |
| <dl class="fields"> |
| <dt>Get Method:</dt> |
| <dd class="value"><span class="summary-sig"><a href="proton._message.Message-class.html#_get_content_encoding" class="summary-sig-name" onclick="show_private();">_get_content_encoding</a>(<span class="summary-sig-arg">self</span>)</span> |
| </dd> |
| <dt>Set Method:</dt> |
| <dd class="value"><span class="summary-sig"><a href="proton._message.Message-class.html#_set_content_encoding" class="summary-sig-name" onclick="show_private();">_set_content_encoding</a>(<span class="summary-sig-arg">self</span>, |
| <span class="summary-sig-arg">value</span>)</span> |
| </dd> |
| </dl> |
| </td></tr></table> |
| </div> |
| <a name="expiry_time"></a> |
| <div> |
| <table class="details" border="1" cellpadding="3" |
| cellspacing="0" width="100%" bgcolor="white"> |
| <tr><td> |
| <h3 class="epydoc">expiry_time</h3> |
| <p>The expiry time of the message.</p> |
| <dl class="fields"> |
| <dt>Get Method:</dt> |
| <dd class="value"><span class="summary-sig"><a href="proton._message.Message-class.html#_get_expiry_time" class="summary-sig-name" onclick="show_private();">_get_expiry_time</a>(<span class="summary-sig-arg">self</span>)</span> |
| </dd> |
| <dt>Set Method:</dt> |
| <dd class="value"><span class="summary-sig"><a href="proton._message.Message-class.html#_set_expiry_time" class="summary-sig-name" onclick="show_private();">_set_expiry_time</a>(<span class="summary-sig-arg">self</span>, |
| <span class="summary-sig-arg">value</span>)</span> |
| </dd> |
| </dl> |
| </td></tr></table> |
| </div> |
| <a name="creation_time"></a> |
| <div> |
| <table class="details" border="1" cellpadding="3" |
| cellspacing="0" width="100%" bgcolor="white"> |
| <tr><td> |
| <h3 class="epydoc">creation_time</h3> |
| <p>The creation time of the message.</p> |
| <dl class="fields"> |
| <dt>Get Method:</dt> |
| <dd class="value"><span class="summary-sig"><a href="proton._message.Message-class.html#_get_creation_time" class="summary-sig-name" onclick="show_private();">_get_creation_time</a>(<span class="summary-sig-arg">self</span>)</span> |
| </dd> |
| <dt>Set Method:</dt> |
| <dd class="value"><span class="summary-sig"><a href="proton._message.Message-class.html#_set_creation_time" class="summary-sig-name" onclick="show_private();">_set_creation_time</a>(<span class="summary-sig-arg">self</span>, |
| <span class="summary-sig-arg">value</span>)</span> |
| </dd> |
| </dl> |
| </td></tr></table> |
| </div> |
| <a name="group_id"></a> |
| <div> |
| <table class="details" border="1" cellpadding="3" |
| cellspacing="0" width="100%" bgcolor="white"> |
| <tr><td> |
| <h3 class="epydoc">group_id</h3> |
| <p>The group id of the message.</p> |
| <dl class="fields"> |
| <dt>Get Method:</dt> |
| <dd class="value"><span class="summary-sig"><a href="proton._message.Message-class.html#_get_group_id" class="summary-sig-name" onclick="show_private();">_get_group_id</a>(<span class="summary-sig-arg">self</span>)</span> |
| </dd> |
| <dt>Set Method:</dt> |
| <dd class="value"><span class="summary-sig"><a href="proton._message.Message-class.html#_set_group_id" class="summary-sig-name" onclick="show_private();">_set_group_id</a>(<span class="summary-sig-arg">self</span>, |
| <span class="summary-sig-arg">value</span>)</span> |
| </dd> |
| </dl> |
| </td></tr></table> |
| </div> |
| <a name="group_sequence"></a> |
| <div> |
| <table class="details" border="1" cellpadding="3" |
| cellspacing="0" width="100%" bgcolor="white"> |
| <tr><td> |
| <h3 class="epydoc">group_sequence</h3> |
| <p>The sequence of the message within its group.</p> |
| <dl class="fields"> |
| <dt>Get Method:</dt> |
| <dd class="value"><span class="summary-sig"><a href="proton._message.Message-class.html#_get_group_sequence" class="summary-sig-name" onclick="show_private();">_get_group_sequence</a>(<span class="summary-sig-arg">self</span>)</span> |
| </dd> |
| <dt>Set Method:</dt> |
| <dd class="value"><span class="summary-sig"><a href="proton._message.Message-class.html#_set_group_sequence" class="summary-sig-name" onclick="show_private();">_set_group_sequence</a>(<span class="summary-sig-arg">self</span>, |
| <span class="summary-sig-arg">value</span>)</span> |
| </dd> |
| </dl> |
| </td></tr></table> |
| </div> |
| <a name="reply_to_group_id"></a> |
| <div> |
| <table class="details" border="1" cellpadding="3" |
| cellspacing="0" width="100%" bgcolor="white"> |
| <tr><td> |
| <h3 class="epydoc">reply_to_group_id</h3> |
| <p>The group-id for any replies.</p> |
| <dl class="fields"> |
| <dt>Get Method:</dt> |
| <dd class="value"><span class="summary-sig"><a href="proton._message.Message-class.html#_get_reply_to_group_id" class="summary-sig-name" onclick="show_private();">_get_reply_to_group_id</a>(<span class="summary-sig-arg">self</span>)</span> |
| </dd> |
| <dt>Set Method:</dt> |
| <dd class="value"><span class="summary-sig"><a href="proton._message.Message-class.html#_set_reply_to_group_id" class="summary-sig-name" onclick="show_private();">_set_reply_to_group_id</a>(<span class="summary-sig-arg">self</span>, |
| <span class="summary-sig-arg">value</span>)</span> |
| </dd> |
| </dl> |
| </td></tr></table> |
| </div> |
| <br /> |
| <!-- ==================== NAVIGATION BAR ==================== --> |
| <table class="navbar" border="0" width="100%" cellpadding="0" |
| bgcolor="#a0c0ff" cellspacing="0"> |
| <tr valign="middle"> |
| <!-- Home link --> |
| <th> <a |
| href="proton-module.html">Home</a> </th> |
| |
| <!-- Tree link --> |
| <th> <a |
| href="module-tree.html">Trees</a> </th> |
| |
| <!-- Index link --> |
| <th> <a |
| href="identifier-index.html">Indices</a> </th> |
| |
| <!-- Help link --> |
| <th> <a |
| href="help.html">Help</a> </th> |
| |
| <!-- Project homepage --> |
| <th class="navbar" align="right" width="100%"> |
| <table border="0" cellpadding="0" cellspacing="0"> |
| <tr><th class="navbar" align="center" |
| ><a class="navbar" target="_top" href="http://qpid.apache.org/index.html">Qpid Proton Python API</a></th> |
| </tr></table></th> |
| </tr> |
| </table> |
| <table border="0" cellpadding="0" cellspacing="0" width="100%%"> |
| <tr> |
| <td align="left" class="footer"> |
| Generated by Epydoc 3.0.1 |
| </td> |
| <td align="right" class="footer"> |
| <a target="mainFrame" href="http://epydoc.sourceforge.net" |
| >http://epydoc.sourceforge.net</a> |
| </td> |
| </tr> |
| </table> |
| |
| <script type="text/javascript"> |
| <!-- |
| // Private objects are initially displayed (because if |
| // javascript is turned off then we want them to be |
| // visible); but by default, we want to hide them. So hide |
| // them unless we have a cookie that says to show them. |
| checkCookie(); |
| // --> |
| </script> |
| </body> |
| </html> |