| <?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.Connection</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> :: |
| Class Connection |
| </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.Connection-class.html" |
| target="_top">no frames</a>]</span></td></tr> |
| </table> |
| </td> |
| </tr> |
| </table> |
| <!-- ==================== CLASS DESCRIPTION ==================== --> |
| <h1 class="epydoc">Class Connection</h1><p class="nomargin-top"><span class="codelink"><a href="proton-pysrc.html#Connection">source code</a></span></p> |
| <center> |
| |
| </center> |
| <hr /> |
| <p>A representation of an AMQP connection</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.Connection-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>, |
| <span class="summary-sig-arg">impl</span>=<span class="summary-sig-default">pn_connection</span>)</span></td> |
| <td align="right" valign="top"> |
| <span class="codelink"><a href="proton-pysrc.html#Connection.__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 href="proton.Connection-class.html#connection" class="summary-sig-name">connection</a>(<span class="summary-sig-arg">self</span>)</span></td> |
| <td align="right" valign="top"> |
| <span class="codelink"><a href="proton-pysrc.html#Connection.connection">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.Connection-class.html#transport" class="summary-sig-name">transport</a>(<span class="summary-sig-arg">self</span>)</span></td> |
| <td align="right" valign="top"> |
| <span class="codelink"><a href="proton-pysrc.html#Connection.transport">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="collect"></a><span class="summary-sig-name">collect</span>(<span class="summary-sig-arg">self</span>, |
| <span class="summary-sig-arg">collector</span>)</span></td> |
| <td align="right" valign="top"> |
| <span class="codelink"><a href="proton-pysrc.html#Connection.collect">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.Connection-class.html#remote_container" class="summary-sig-name">remote_container</a>(<span class="summary-sig-arg">self</span>)</span><br /> |
| The container identifier specified by the remote peer for this |
| connection.</td> |
| <td align="right" valign="top"> |
| <span class="codelink"><a href="proton-pysrc.html#Connection.remote_container">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.Connection-class.html#remote_hostname" class="summary-sig-name">remote_hostname</a>(<span class="summary-sig-arg">self</span>)</span><br /> |
| The hostname specified by the remote peer for this connection.</td> |
| <td align="right" valign="top"> |
| <span class="codelink"><a href="proton-pysrc.html#Connection.remote_hostname">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.Connection-class.html#remote_offered_capabilities" class="summary-sig-name">remote_offered_capabilities</a>(<span class="summary-sig-arg">self</span>)</span><br /> |
| The capabilities offered by the remote peer for this connection.</td> |
| <td align="right" valign="top"> |
| <span class="codelink"><a href="proton-pysrc.html#Connection.remote_offered_capabilities">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.Connection-class.html#remote_desired_capabilities" class="summary-sig-name">remote_desired_capabilities</a>(<span class="summary-sig-arg">self</span>)</span><br /> |
| The capabilities desired by the remote peer for this connection.</td> |
| <td align="right" valign="top"> |
| <span class="codelink"><a href="proton-pysrc.html#Connection.remote_desired_capabilities">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.Connection-class.html#remote_properties" class="summary-sig-name">remote_properties</a>(<span class="summary-sig-arg">self</span>)</span><br /> |
| The properties specified by the remote peer for this connection.</td> |
| <td align="right" valign="top"> |
| <span class="codelink"><a href="proton-pysrc.html#Connection.remote_properties">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.Connection-class.html#open" class="summary-sig-name">open</a>(<span class="summary-sig-arg">self</span>)</span><br /> |
| Opens the connection.</td> |
| <td align="right" valign="top"> |
| <span class="codelink"><a href="proton-pysrc.html#Connection.open">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.Connection-class.html#close" class="summary-sig-name">close</a>(<span class="summary-sig-arg">self</span>)</span><br /> |
| Closes the connection.</td> |
| <td align="right" valign="top"> |
| <span class="codelink"><a href="proton-pysrc.html#Connection.close">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.Connection-class.html#state" class="summary-sig-name">state</a>(<span class="summary-sig-arg">self</span>)</span><br /> |
| The state of the connection as a bit field.</td> |
| <td align="right" valign="top"> |
| <span class="codelink"><a href="proton-pysrc.html#Connection.state">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="session"></a><span class="summary-sig-name">session</span>(<span class="summary-sig-arg">self</span>)</span><br /> |
| Returns a new session on this connection.</td> |
| <td align="right" valign="top"> |
| <span class="codelink"><a href="proton-pysrc.html#Connection.session">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="session_head"></a><span class="summary-sig-name">session_head</span>(<span class="summary-sig-arg">self</span>, |
| <span class="summary-sig-arg">mask</span>)</span></td> |
| <td align="right" valign="top"> |
| <span class="codelink"><a href="proton-pysrc.html#Connection.session_head">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="link_head"></a><span class="summary-sig-name">link_head</span>(<span class="summary-sig-arg">self</span>, |
| <span class="summary-sig-arg">mask</span>)</span></td> |
| <td align="right" valign="top"> |
| <span class="codelink"><a href="proton-pysrc.html#Connection.link_head">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.Connection-class.html#work_head" class="summary-sig-name">work_head</a>(<span class="summary-sig-arg">self</span>)</span></td> |
| <td align="right" valign="top"> |
| <span class="codelink"><a href="proton-pysrc.html#Connection.work_head">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.Connection-class.html#error" class="summary-sig-name">error</a>(<span class="summary-sig-arg">self</span>)</span></td> |
| <td align="right" valign="top"> |
| <span class="codelink"><a href="proton-pysrc.html#Connection.error">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="free"></a><span class="summary-sig-name">free</span>(<span class="summary-sig-arg">self</span>)</span></td> |
| <td align="right" valign="top"> |
| <span class="codelink"><a href="proton-pysrc.html#Connection.free">source code</a></span> |
| |
| </td> |
| </tr> |
| </table> |
| |
| </td> |
| </tr> |
| <tr> |
| <td colspan="2" class="summary"> |
| <p class="indent-wrapped-lines"><b>Inherited from <code><a href="proton.wrapper.Wrapper-class.html">wrapper.Wrapper</a></code></b>: |
| <code><a href="proton.wrapper.Wrapper-class.html#__del__">__del__</a></code>, |
| <code><a href="proton.wrapper.Wrapper-class.html#__delattr__">__delattr__</a></code>, |
| <code><a href="proton.wrapper.Wrapper-class.html#__eq__">__eq__</a></code>, |
| <code><a href="proton.wrapper.Wrapper-class.html#__getattr__">__getattr__</a></code>, |
| <code><a href="proton.wrapper.Wrapper-class.html#__hash__">__hash__</a></code>, |
| <code><a href="proton.wrapper.Wrapper-class.html#__ne__">__ne__</a></code>, |
| <code><a href="proton.wrapper.Wrapper-class.html#__repr__">__repr__</a></code>, |
| <code><a href="proton.wrapper.Wrapper-class.html#__setattr__">__setattr__</a></code> |
| </p> |
| <p class="indent-wrapped-lines"><b>Inherited from <code><a href="proton.Endpoint-class.html">Endpoint</a></code></b>: |
| <code><a href="proton.Endpoint-class.html#remote_condition">remote_condition</a></code> |
| </p> |
| </td> |
| </tr> |
| </table> |
| <!-- ==================== STATIC METHODS ==================== --> |
| <a name="section-StaticMethods"></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">Static 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 name="wrap"></a><span class="summary-sig-name">wrap</span>(<span class="summary-sig-arg">impl</span>)</span></td> |
| <td align="right" valign="top"> |
| <span class="codelink"><a href="proton-pysrc.html#Connection.wrap">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="container"></a><span class="summary-name">container</span> = <code title="property(_get_container, _set_container)">property(_get_container, _set_container)</code> |
| </td> |
| </tr> |
| <tr> |
| <td width="15%" align="right" valign="top" class="summary"> |
| <span class="summary-type"> </span> |
| </td><td class="summary"> |
| <a href="proton.Connection-class.html#hostname" class="summary-name">hostname</a> = <code title="property(_get_hostname, _set_hostname, doc= """ |
| Set the name of the host (either fully qualified or relative) to which\ |
| this |
| connection is connecting to. This information may be used by the remo\ |
| te |
| peer to determine the correct back-end service to connect the client t\ |
| o. |
| This value will be sent in the Open performative, and will be used by \ |
| ...">property(_get_hostname, _set_hostname, doc= <code class="variable-ellipsis">...</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="user"></a><span class="summary-name">user</span> = <code title="property(_get_user, _set_user)">property(_get_user, _set_user)</code> |
| </td> |
| </tr> |
| <tr> |
| <td width="15%" align="right" valign="top" class="summary"> |
| <span class="summary-type"> </span> |
| </td><td class="summary"> |
| <a name="password"></a><span class="summary-name">password</span> = <code title="property(_get_password, _set_password)">property(_get_password, _set_password)</code> |
| </td> |
| </tr> |
| <tr> |
| <td colspan="2" class="summary"> |
| <p class="indent-wrapped-lines"><b>Inherited from <code><a href="proton.Endpoint-class.html">Endpoint</a></code></b>: |
| <code><a href="proton.Endpoint-class.html#LOCAL_ACTIVE">LOCAL_ACTIVE</a></code>, |
| <code><a href="proton.Endpoint-class.html#LOCAL_CLOSED">LOCAL_CLOSED</a></code>, |
| <code><a href="proton.Endpoint-class.html#LOCAL_UNINIT">LOCAL_UNINIT</a></code>, |
| <code><a href="proton.Endpoint-class.html#REMOTE_ACTIVE">REMOTE_ACTIVE</a></code>, |
| <code><a href="proton.Endpoint-class.html#REMOTE_CLOSED">REMOTE_CLOSED</a></code>, |
| <code><a href="proton.Endpoint-class.html#REMOTE_UNINIT">REMOTE_UNINIT</a></code>, |
| <code><a href="proton.Endpoint-class.html#handler">handler</a></code> |
| </p> |
| </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">impl</span>=<span class="sig-default">pn_connection</span>)</span> |
| <br /><em class="fname">(Constructor)</em> |
| </h3> |
| </td><td align="right" valign="top" |
| ><span class="codelink"><a href="proton-pysrc.html#Connection.__init__">source code</a></span> |
| </td> |
| </tr></table> |
| |
| |
| <dl class="fields"> |
| <dt>Overrides: |
| <a href="proton.wrapper.Wrapper-class.html#__init__">wrapper.Wrapper.__init__</a> |
| </dt> |
| </dl> |
| </td></tr></table> |
| </div> |
| <a name="connection"></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">connection</span>(<span class="sig-arg">self</span>)</span> |
| </h3> |
| </td><td align="right" valign="top" |
| ><span class="codelink"><a href="proton-pysrc.html#Connection.connection">source code</a></span> |
| </td> |
| </tr></table> |
| |
| |
| <dl class="fields"> |
| <dt>Decorators:</dt> |
| <dd><ul class="nomargin-top"> |
| <li><code>@property</code></li> |
| </ul></dd> |
| </dl> |
| </td></tr></table> |
| </div> |
| <a name="transport"></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">transport</span>(<span class="sig-arg">self</span>)</span> |
| </h3> |
| </td><td align="right" valign="top" |
| ><span class="codelink"><a href="proton-pysrc.html#Connection.transport">source code</a></span> |
| </td> |
| </tr></table> |
| |
| |
| <dl class="fields"> |
| <dt>Decorators:</dt> |
| <dd><ul class="nomargin-top"> |
| <li><code>@property</code></li> |
| </ul></dd> |
| <dt>Overrides: |
| <a href="proton.Endpoint-class.html#transport">Endpoint.transport</a> |
| </dt> |
| </dl> |
| </td></tr></table> |
| </div> |
| <a name="remote_container"></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">remote_container</span>(<span class="sig-arg">self</span>)</span> |
| </h3> |
| </td><td align="right" valign="top" |
| ><span class="codelink"><a href="proton-pysrc.html#Connection.remote_container">source code</a></span> |
| </td> |
| </tr></table> |
| |
| <p>The container identifier specified by the remote peer for this |
| connection.</p> |
| <dl class="fields"> |
| <dt>Decorators:</dt> |
| <dd><ul class="nomargin-top"> |
| <li><code>@property</code></li> |
| </ul></dd> |
| </dl> |
| </td></tr></table> |
| </div> |
| <a name="remote_hostname"></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">remote_hostname</span>(<span class="sig-arg">self</span>)</span> |
| </h3> |
| </td><td align="right" valign="top" |
| ><span class="codelink"><a href="proton-pysrc.html#Connection.remote_hostname">source code</a></span> |
| </td> |
| </tr></table> |
| |
| <p>The hostname specified by the remote peer for this connection.</p> |
| <dl class="fields"> |
| <dt>Decorators:</dt> |
| <dd><ul class="nomargin-top"> |
| <li><code>@property</code></li> |
| </ul></dd> |
| </dl> |
| </td></tr></table> |
| </div> |
| <a name="remote_offered_capabilities"></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">remote_offered_capabilities</span>(<span class="sig-arg">self</span>)</span> |
| </h3> |
| </td><td align="right" valign="top" |
| ><span class="codelink"><a href="proton-pysrc.html#Connection.remote_offered_capabilities">source code</a></span> |
| </td> |
| </tr></table> |
| |
| <p>The capabilities offered by the remote peer for this connection.</p> |
| <dl class="fields"> |
| <dt>Decorators:</dt> |
| <dd><ul class="nomargin-top"> |
| <li><code>@property</code></li> |
| </ul></dd> |
| </dl> |
| </td></tr></table> |
| </div> |
| <a name="remote_desired_capabilities"></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">remote_desired_capabilities</span>(<span class="sig-arg">self</span>)</span> |
| </h3> |
| </td><td align="right" valign="top" |
| ><span class="codelink"><a href="proton-pysrc.html#Connection.remote_desired_capabilities">source code</a></span> |
| </td> |
| </tr></table> |
| |
| <p>The capabilities desired by the remote peer for this connection.</p> |
| <dl class="fields"> |
| <dt>Decorators:</dt> |
| <dd><ul class="nomargin-top"> |
| <li><code>@property</code></li> |
| </ul></dd> |
| </dl> |
| </td></tr></table> |
| </div> |
| <a name="remote_properties"></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">remote_properties</span>(<span class="sig-arg">self</span>)</span> |
| </h3> |
| </td><td align="right" valign="top" |
| ><span class="codelink"><a href="proton-pysrc.html#Connection.remote_properties">source code</a></span> |
| </td> |
| </tr></table> |
| |
| <p>The properties specified by the remote peer for this connection.</p> |
| <dl class="fields"> |
| <dt>Decorators:</dt> |
| <dd><ul class="nomargin-top"> |
| <li><code>@property</code></li> |
| </ul></dd> |
| </dl> |
| </td></tr></table> |
| </div> |
| <a name="open"></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">open</span>(<span class="sig-arg">self</span>)</span> |
| </h3> |
| </td><td align="right" valign="top" |
| ><span class="codelink"><a href="proton-pysrc.html#Connection.open">source code</a></span> |
| </td> |
| </tr></table> |
| |
| <p>Opens the connection.</p> |
| <p>In more detail, this moves the local state of the connection to the |
| ACTIVE state and triggers an open frame to be sent to the peer. A |
| connection is fully active once both peers have opened it.</p> |
| <dl class="fields"> |
| </dl> |
| </td></tr></table> |
| </div> |
| <a name="close"></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">close</span>(<span class="sig-arg">self</span>)</span> |
| </h3> |
| </td><td align="right" valign="top" |
| ><span class="codelink"><a href="proton-pysrc.html#Connection.close">source code</a></span> |
| </td> |
| </tr></table> |
| |
| <p>Closes the connection.</p> |
| <p>In more detail, this moves the local state of the connection to the |
| CLOSED state and triggers a close frame to be sent to the peer. A |
| connection is fully closed once both peers have closed it.</p> |
| <dl class="fields"> |
| </dl> |
| </td></tr></table> |
| </div> |
| <a name="state"></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">state</span>(<span class="sig-arg">self</span>)</span> |
| </h3> |
| </td><td align="right" valign="top" |
| ><span class="codelink"><a href="proton-pysrc.html#Connection.state">source code</a></span> |
| </td> |
| </tr></table> |
| |
| <p>The state of the connection as a bit field. The state has a local and |
| a remote component. Each of these can be in one of three states: UNINIT, |
| ACTIVE or CLOSED. These can be tested by masking against LOCAL_UNINIT, |
| LOCAL_ACTIVE, LOCAL_CLOSED, REMOTE_UNINIT, REMOTE_ACTIVE and |
| REMOTE_CLOSED.</p> |
| <dl class="fields"> |
| <dt>Decorators:</dt> |
| <dd><ul class="nomargin-top"> |
| <li><code>@property</code></li> |
| </ul></dd> |
| </dl> |
| </td></tr></table> |
| </div> |
| <a name="work_head"></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">work_head</span>(<span class="sig-arg">self</span>)</span> |
| </h3> |
| </td><td align="right" valign="top" |
| ><span class="codelink"><a href="proton-pysrc.html#Connection.work_head">source code</a></span> |
| </td> |
| </tr></table> |
| |
| |
| <dl class="fields"> |
| <dt>Decorators:</dt> |
| <dd><ul class="nomargin-top"> |
| <li><code>@property</code></li> |
| </ul></dd> |
| </dl> |
| </td></tr></table> |
| </div> |
| <a name="error"></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">error</span>(<span class="sig-arg">self</span>)</span> |
| </h3> |
| </td><td align="right" valign="top" |
| ><span class="codelink"><a href="proton-pysrc.html#Connection.error">source code</a></span> |
| </td> |
| </tr></table> |
| |
| |
| <dl class="fields"> |
| <dt>Decorators:</dt> |
| <dd><ul class="nomargin-top"> |
| <li><code>@property</code></li> |
| </ul></dd> |
| </dl> |
| </td></tr></table> |
| </div> |
| <br /> |
| <!-- ==================== CLASS VARIABLE DETAILS ==================== --> |
| <a name="section-ClassVariableDetails"></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">Class Variable Details</span></td> |
| </tr> |
| </table> |
| <a name="hostname"></a> |
| <div> |
| <table class="details" border="1" cellpadding="3" |
| cellspacing="0" width="100%" bgcolor="white"> |
| <tr><td> |
| <h3 class="epydoc">hostname</h3> |
| |
| <dl class="fields"> |
| </dl> |
| <dl class="fields"> |
| <dt>Value:</dt> |
| <dd><table><tr><td><pre class="variable"> |
| property(_get_hostname, _set_hostname, doc= """ |
| Set the name of the host (either fully qualified or relative) to which<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span> |
| this |
| connection is connecting to. This information may be used by the remo<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span> |
| te |
| peer to determine the correct back-end service to connect the client t<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span> |
| o. |
| This value will be sent in the Open performative, and will be used by <span class="variable-linewrap"><img src="crarr.png" alt="\" /></span> |
| <code class="variable-ellipsis">...</code> |
| </pre></td></tr></table> |
| </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> |
