| <?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</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 bgcolor="#70b0f0" class="navbar-select" |
| > Home </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"> |
| Package proton |
| </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-module.html" |
| target="_top">no frames</a>]</span></td></tr> |
| </table> |
| </td> |
| </tr> |
| </table> |
| <!-- ==================== PACKAGE DESCRIPTION ==================== --> |
| <h1 class="epydoc">Package proton</h1><p class="nomargin-top"><span class="codelink"><a href="proton-pysrc.html">source code</a></span></p> |
| <p>The proton module defines a suite of APIs that implement the AMQP 1.0 |
| protocol.</p> |
| <p>The proton APIs consist of the following classes:</p> |
| <ul> |
| <li> |
| <a href="proton._message.Message-class.html" class="link">Message</a> |
| -- A class for creating and/or accessing AMQP message content. |
| </li> |
| <li> |
| <a href="proton._data.Data-class.html" class="link">Data</a> -- |
| A class for creating and/or accessing arbitrary AMQP encoded data. |
| </li> |
| </ul> |
| |
| <!-- ==================== SUBMODULES ==================== --> |
| <a name="section-Submodules"></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">Submodules</span></td> |
| </tr> |
| <tr><td class="summary"> |
| <ul class="nomargin"> |
| <li class="private"> <strong class="uidlink"><a href="proton._common-module.html" onclick="show_private();">proton._common</a></strong> </li> |
| <li class="private"> <strong class="uidlink"><a href="proton._compat-module.html" onclick="show_private();">proton._compat</a></strong>: <em class="summary">Utilities to help Proton support both python2 and python3.</em> </li> |
| <li class="private"> <strong class="uidlink"><a href="proton._condition-module.html" onclick="show_private();">proton._condition</a></strong> </li> |
| <li class="private"> <strong class="uidlink"><a href="proton._data-module.html" onclick="show_private();">proton._data</a></strong> </li> |
| <li class="private"> <strong class="uidlink"><a href="proton._delivery-module.html" onclick="show_private();">proton._delivery</a></strong> </li> |
| <li class="private"> <strong class="uidlink"><a href="proton._endpoints-module.html" onclick="show_private();">proton._endpoints</a></strong>: <em class="summary">The proton.endpoints module</em> </li> |
| <li class="private"> <strong class="uidlink"><a href="proton._events-module.html" onclick="show_private();">proton._events</a></strong> </li> |
| <li class="private"> <strong class="uidlink"><a href="proton._exceptions-module.html" onclick="show_private();">proton._exceptions</a></strong> </li> |
| <li class="private"> <strong class="uidlink"><a href="proton._handlers-module.html" onclick="show_private();">proton._handlers</a></strong> </li> |
| <li class="private"> <strong class="uidlink"><a href="proton._message-module.html" onclick="show_private();">proton._message</a></strong> </li> |
| <li class="private"> <strong class="uidlink"><a href="proton._reactor-module.html" onclick="show_private();">proton._reactor</a></strong> </li> |
| <li class="private"> <strong class="uidlink"><a href="proton._reactor_impl-module.html" onclick="show_private();">proton._reactor_impl</a></strong> </li> |
| <li class="private"> <strong class="uidlink"><a href="proton._transport-module.html" onclick="show_private();">proton._transport</a></strong> </li> |
| <li class="private"> <strong class="uidlink"><a href="proton._url-module.html" onclick="show_private();">proton._url</a></strong> </li> |
| <li class="private"> <strong class="uidlink"><a href="proton._utils-module.html" onclick="show_private();">proton._utils</a></strong> </li> |
| <li class="private"> <strong class="uidlink"><a href="proton._wrapper-module.html" onclick="show_private();">proton._wrapper</a></strong> </li> |
| <li class="private"> <strong class="uidlink"><a href="proton.handlers-module.html" onclick="show_private();">proton.handlers</a></strong> </li> |
| <li class="private"> <strong class="uidlink"><a href="proton.reactor-module.html" onclick="show_private();">proton.reactor</a></strong> </li> |
| <li class="private"> <strong class="uidlink"><a href="proton.utils-module.html" onclick="show_private();">proton.utils</a></strong> </li> |
| </ul></td></tr> |
| </table> |
| |
| <br /> |
| <!-- ==================== CLASSES ==================== --> |
| <a name="section-Classes"></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">Classes</span></td> |
| </tr> |
| <tr> |
| <td class="summary" colspan="2"> |
| <a href="proton._condition.Condition-class.html" class="summary-name">Condition</a> |
| </td> |
| </tr> |
| <tr> |
| <td class="summary" colspan="2"> |
| <a href="proton._data.Array-class.html" class="summary-name">Array</a> |
| </td> |
| </tr> |
| <tr> |
| <td class="summary" colspan="2"> |
| <a href="proton._data.Data-class.html" class="summary-name">Data</a><br /> |
| The <a href="proton._data.Data-class.html" class="link">Data</a> |
| class provides an interface for decoding, extracting, creating, and |
| encoding arbitrary AMQP data. |
| </td> |
| </tr> |
| <tr> |
| <td class="summary" colspan="2"> |
| <a href="proton._data.Described-class.html" class="summary-name">Described</a> |
| </td> |
| </tr> |
| <tr> |
| <td class="summary" colspan="2"> |
| <a href="proton._data.char-class.html" class="summary-name">char</a> |
| </td> |
| </tr> |
| <tr> |
| <td class="summary" colspan="2"> |
| <a href="proton._data.symbol-class.html" class="summary-name">symbol</a> |
| </td> |
| </tr> |
| <tr> |
| <td class="summary" colspan="2"> |
| <a href="proton._data.timestamp-class.html" class="summary-name">timestamp</a> |
| </td> |
| </tr> |
| <tr> |
| <td class="summary" colspan="2"> |
| <a href="proton._data.ubyte-class.html" class="summary-name">ubyte</a> |
| </td> |
| </tr> |
| <tr> |
| <td class="summary" colspan="2"> |
| <a href="proton._data.ushort-class.html" class="summary-name">ushort</a> |
| </td> |
| </tr> |
| <tr> |
| <td class="summary" colspan="2"> |
| <a href="proton._data.uint-class.html" class="summary-name">uint</a> |
| </td> |
| </tr> |
| <tr> |
| <td class="summary" colspan="2"> |
| <a href="proton._data.ulong-class.html" class="summary-name">ulong</a> |
| </td> |
| </tr> |
| <tr> |
| <td class="summary" colspan="2"> |
| <a href="proton._data.byte-class.html" class="summary-name">byte</a> |
| </td> |
| </tr> |
| <tr> |
| <td class="summary" colspan="2"> |
| <a href="proton._data.short-class.html" class="summary-name">short</a> |
| </td> |
| </tr> |
| <tr> |
| <td class="summary" colspan="2"> |
| <a href="proton._data.int32-class.html" class="summary-name">int32</a> |
| </td> |
| </tr> |
| <tr> |
| <td class="summary" colspan="2"> |
| <a href="proton._data.float32-class.html" class="summary-name">float32</a> |
| </td> |
| </tr> |
| <tr> |
| <td class="summary" colspan="2"> |
| <a href="proton._data.decimal32-class.html" class="summary-name">decimal32</a> |
| </td> |
| </tr> |
| <tr> |
| <td class="summary" colspan="2"> |
| <a href="proton._data.decimal64-class.html" class="summary-name">decimal64</a> |
| </td> |
| </tr> |
| <tr> |
| <td class="summary" colspan="2"> |
| <a href="proton._data.decimal128-class.html" class="summary-name">decimal128</a> |
| </td> |
| </tr> |
| <tr> |
| <td class="summary" colspan="2"> |
| <a href="proton._delivery.Delivery-class.html" class="summary-name">Delivery</a><br /> |
| Tracks and/or records the delivery of a message over a link. |
| </td> |
| </tr> |
| <tr> |
| <td class="summary" colspan="2"> |
| <a href="proton._delivery.Disposition-class.html" class="summary-name">Disposition</a> |
| </td> |
| </tr> |
| <tr> |
| <td class="summary" colspan="2"> |
| <a href="proton._endpoints.Endpoint-class.html" class="summary-name">Endpoint</a> |
| </td> |
| </tr> |
| <tr> |
| <td class="summary" colspan="2"> |
| <a href="proton._endpoints.Connection-class.html" class="summary-name">Connection</a><br /> |
| A representation of an AMQP connection |
| </td> |
| </tr> |
| <tr> |
| <td class="summary" colspan="2"> |
| <a href="proton._endpoints.Session-class.html" class="summary-name">Session</a> |
| </td> |
| </tr> |
| <tr> |
| <td class="summary" colspan="2"> |
| <a href="proton._endpoints.Link-class.html" class="summary-name">Link</a><br /> |
| A representation of an AMQP link, of which there are two concrete |
| implementations, Sender and Receiver. |
| </td> |
| </tr> |
| <tr> |
| <td class="summary" colspan="2"> |
| <a href="proton._endpoints.Receiver-class.html" class="summary-name">Receiver</a><br /> |
| A link over which messages are received. |
| </td> |
| </tr> |
| <tr> |
| <td class="summary" colspan="2"> |
| <a href="proton._endpoints.Sender-class.html" class="summary-name">Sender</a><br /> |
| A link over which messages are sent. |
| </td> |
| </tr> |
| <tr> |
| <td class="summary" colspan="2"> |
| <a href="proton._endpoints.Terminus-class.html" class="summary-name">Terminus</a> |
| </td> |
| </tr> |
| <tr> |
| <td class="summary" colspan="2"> |
| <a href="proton._events.Collector-class.html" class="summary-name">Collector</a> |
| </td> |
| </tr> |
| <tr> |
| <td class="summary" colspan="2"> |
| <a href="proton._events.Event-class.html" class="summary-name">Event</a> |
| </td> |
| </tr> |
| <tr> |
| <td class="summary" colspan="2"> |
| <a href="proton._events.EventType-class.html" class="summary-name">EventType</a> |
| </td> |
| </tr> |
| <tr> |
| <td class="summary" colspan="2"> |
| <a href="proton._events.Handler-class.html" class="summary-name">Handler</a> |
| </td> |
| </tr> |
| <tr> |
| <td class="summary" colspan="2"> |
| <a href="proton._exceptions.ProtonException-class.html" class="summary-name">ProtonException</a><br /> |
| The root of the proton exception hierarchy. |
| </td> |
| </tr> |
| <tr> |
| <td class="summary" colspan="2"> |
| <a href="proton._exceptions.MessageException-class.html" class="summary-name">MessageException</a><br /> |
| The MessageException class is the root of the message exception |
| hierarchy. |
| </td> |
| </tr> |
| <tr> |
| <td class="summary" colspan="2"> |
| <a href="proton._exceptions.DataException-class.html" class="summary-name">DataException</a><br /> |
| The DataException class is the root of the Data exception |
| hierarchy. |
| </td> |
| </tr> |
| <tr> |
| <td class="summary" colspan="2"> |
| <a href="proton._exceptions.TransportException-class.html" class="summary-name">TransportException</a> |
| </td> |
| </tr> |
| <tr> |
| <td class="summary" colspan="2"> |
| <a href="proton._exceptions.SSLException-class.html" class="summary-name">SSLException</a> |
| </td> |
| </tr> |
| <tr> |
| <td class="summary" colspan="2"> |
| <a href="proton._exceptions.SSLUnavailable-class.html" class="summary-name">SSLUnavailable</a> |
| </td> |
| </tr> |
| <tr> |
| <td class="summary" colspan="2"> |
| <a href="proton._exceptions.ConnectionException-class.html" class="summary-name">ConnectionException</a> |
| </td> |
| </tr> |
| <tr> |
| <td class="summary" colspan="2"> |
| <a href="proton._exceptions.SessionException-class.html" class="summary-name">SessionException</a> |
| </td> |
| </tr> |
| <tr> |
| <td class="summary" colspan="2"> |
| <a href="proton._exceptions.LinkException-class.html" class="summary-name">LinkException</a> |
| </td> |
| </tr> |
| <tr> |
| <td class="summary" colspan="2"> |
| <a href="proton._exceptions.Timeout-class.html" class="summary-name">Timeout</a><br /> |
| A timeout exception indicates that a blocking operation has timed |
| out. |
| </td> |
| </tr> |
| <tr> |
| <td class="summary" colspan="2"> |
| <a href="proton._exceptions.Interrupt-class.html" class="summary-name">Interrupt</a><br /> |
| An interrupt exception indicates that a blocking operation was |
| interrupted. |
| </td> |
| </tr> |
| <tr> |
| <td class="summary" colspan="2"> |
| <a href="proton._message.Message-class.html" class="summary-name">Message</a><br /> |
| The <a href="proton._message.Message-class.html" |
| class="link">Message</a> class is a mutable holder of message |
| content. |
| </td> |
| </tr> |
| <tr> |
| <td class="summary" colspan="2"> |
| <a href="proton._transport.Transport-class.html" class="summary-name">Transport</a> |
| </td> |
| </tr> |
| <tr> |
| <td class="summary" colspan="2"> |
| <a href="proton._transport.SASL-class.html" class="summary-name">SASL</a> |
| </td> |
| </tr> |
| <tr> |
| <td class="summary" colspan="2"> |
| <a href="proton._transport.SSL-class.html" class="summary-name">SSL</a> |
| </td> |
| </tr> |
| <tr> |
| <td class="summary" colspan="2"> |
| <a href="proton._transport.SSLDomain-class.html" class="summary-name">SSLDomain</a> |
| </td> |
| </tr> |
| <tr> |
| <td class="summary" colspan="2"> |
| <a href="proton._transport.SSLSessionDetails-class.html" class="summary-name">SSLSessionDetails</a><br /> |
| Unique identifier for the SSL session. |
| </td> |
| </tr> |
| <tr> |
| <td class="summary" colspan="2"> |
| <a href="proton._url.Url-class.html" class="summary-name">Url</a><br /> |
| Simple URL parser/constructor, handles URLs of the form: |
| </td> |
| </tr> |
| </table> |
| <!-- ==================== VARIABLES ==================== --> |
| <a name="section-Variables"></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">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="UNDESCRIBED"></a><span class="summary-name">UNDESCRIBED</span> = <code title="UNDESCRIBED">UNDESCRIBED</code> |
| </td> |
| </tr> |
| <tr> |
| <td width="15%" align="right" valign="top" class="summary"> |
| <span class="summary-type"> </span> |
| </td><td class="summary"> |
| <a name="VERSION_MAJOR"></a><span class="summary-name">VERSION_MAJOR</span> = <code title="0">0</code> |
| </td> |
| </tr> |
| <tr> |
| <td width="15%" align="right" valign="top" class="summary"> |
| <span class="summary-type"> </span> |
| </td><td class="summary"> |
| <a name="VERSION_MINOR"></a><span class="summary-name">VERSION_MINOR</span> = <code title="25">25</code> |
| </td> |
| </tr> |
| <tr> |
| <td width="15%" align="right" valign="top" class="summary"> |
| <span class="summary-type"> </span> |
| </td><td class="summary"> |
| <a name="API_LANGUAGE"></a><span class="summary-name">API_LANGUAGE</span> = <code title="'C'"><code class="variable-quote">'</code><code class="variable-string">C</code><code class="variable-quote">'</code></code> |
| </td> |
| </tr> |
| <tr> |
| <td width="15%" align="right" valign="top" class="summary"> |
| <span class="summary-type"> </span> |
| </td><td class="summary"> |
| <a name="IMPLEMENTATION_LANGUAGE"></a><span class="summary-name">IMPLEMENTATION_LANGUAGE</span> = <code title="'C'"><code class="variable-quote">'</code><code class="variable-string">C</code><code class="variable-quote">'</code></code> |
| </td> |
| </tr> |
| </table> |
| <!-- ==================== NAVIGATION BAR ==================== --> |
| <table class="navbar" border="0" width="100%" cellpadding="0" |
| bgcolor="#a0c0ff" cellspacing="0"> |
| <tr valign="middle"> |
| <!-- Home link --> |
| <th bgcolor="#70b0f0" class="navbar-select" |
| > Home </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> |
