http://git-wip-us.apache.org/repos/asf/qpid-site/blob/55375a76/content/releases/qpid-python-1.36.0/messaging-api/api/qpid.messaging.endpoints.Connection-class.html ---------------------------------------------------------------------- diff --git a/content/releases/qpid-python-1.36.0/messaging-api/api/qpid.messaging.endpoints.Connection-class.html b/content/releases/qpid-python-1.36.0/messaging-api/api/qpid.messaging.endpoints.Connection-class.html new file mode 100755 index 0000000..9d2cdc1 --- /dev/null +++ b/content/releases/qpid-python-1.36.0/messaging-api/api/qpid.messaging.endpoints.Connection-class.html @@ -0,0 +1,630 @@ +<?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>qpid.messaging.endpoints.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="qpid.messaging-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 Python Messaging 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 qpid :: + <a href="qpid.messaging-module.html">Package messaging</a> :: + <a href="qpid.messaging.endpoints-module.html">Module endpoints</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="qpid.messaging.endpoints.Connection-class.html" + target="_top">no frames</a>]</span></td></tr> + </table> + </td> + </tr> +</table> +<!-- ==================== TYPE DESCRIPTION ==================== --> +<h1 class="epydoc">type Connection</h1><p class="nomargin-top"><span class="codelink"><a href="qpid.messaging.endpoints-pysrc.html#Connection">source code</a></span></p> +<center> + +</center> +<hr /> +<p>A Connection manages a group of <a + href="qpid.messaging.endpoints.Session-class.html" + class="link">Sessions</a> and connects them with a remote endpoint.</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">Connection</span> + </td><td class="summary"> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr> + <td><span class="summary-sig"><a href="qpid.messaging.endpoints.Connection-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>, + <span class="summary-sig-arg">url</span>=<span class="summary-sig-default">None</span>, + <span class="summary-sig-arg">**options</span>)</span><br /> + Creates a connection.</td> + <td align="right" valign="top"> + <span class="codelink"><a href="qpid.messaging.endpoints-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 name="check_error"></a><span class="summary-sig-name">check_error</span>(<span class="summary-sig-arg">self</span>)</span></td> + <td align="right" valign="top"> + <span class="codelink"><a href="qpid.messaging.endpoints-pysrc.html#Connection.check_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="get_error"></a><span class="summary-sig-name">get_error</span>(<span class="summary-sig-arg">self</span>)</span></td> + <td align="right" valign="top"> + <span class="codelink"><a href="qpid.messaging.endpoints-pysrc.html#Connection.get_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="check_closed"></a><span class="summary-sig-name">check_closed</span>(<span class="summary-sig-arg">self</span>)</span></td> + <td align="right" valign="top"> + <span class="codelink"><a href="qpid.messaging.endpoints-pysrc.html#Connection.check_closed">source code</a></span> + + </td> + </tr> + </table> + + </td> + </tr> +<tr> + <td width="15%" align="right" valign="top" class="summary"> + <span class="summary-type">Session</span> + </td><td class="summary"> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr> + <td><span class="summary-sig"><a href="qpid.messaging.endpoints.Connection-class.html#session" class="summary-sig-name">session</a>(<span class="summary-sig-arg">self</span>, + <span class="summary-sig-arg">name</span>=<span class="summary-sig-default">None</span>, + <span class="summary-sig-arg">transactional</span>=<span class="summary-sig-default">False</span>)</span><br /> + Creates or retrieves the named session.</td> + <td align="right" valign="top"> + <span class="codelink"><a href="qpid.messaging.endpoints-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 href="qpid.messaging.endpoints.Connection-class.html#open" class="summary-sig-name">open</a>(<span class="summary-sig-arg">self</span>, + <span class="summary-sig-arg">timeout</span>=<span class="summary-sig-default">None</span>)</span><br /> + Opens a connection.</td> + <td align="right" valign="top"> + <span class="codelink"><a href="qpid.messaging.endpoints-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="qpid.messaging.endpoints.Connection-class.html#opened" class="summary-sig-name">opened</a>(<span class="summary-sig-arg">self</span>)</span><br /> + Return true if the connection is open, false otherwise.</td> + <td align="right" valign="top"> + <span class="codelink"><a href="qpid.messaging.endpoints-pysrc.html#Connection.opened">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="qpid.messaging.endpoints.Connection-class.html#attach" class="summary-sig-name">attach</a>(<span class="summary-sig-arg">self</span>, + <span class="summary-sig-arg">timeout</span>=<span class="summary-sig-default">None</span>)</span><br /> + Attach to the remote endpoint.</td> + <td align="right" valign="top"> + <span class="codelink"><a href="qpid.messaging.endpoints-pysrc.html#Connection.attach">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="qpid.messaging.endpoints.Connection-class.html#detach" class="summary-sig-name">detach</a>(<span class="summary-sig-arg">self</span>, + <span class="summary-sig-arg">timeout</span>=<span class="summary-sig-default">None</span>)</span><br /> + Detach from the remote endpoint.</td> + <td align="right" valign="top"> + <span class="codelink"><a href="qpid.messaging.endpoints-pysrc.html#Connection.detach">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="qpid.messaging.endpoints.Connection-class.html#attached" class="summary-sig-name">attached</a>(<span class="summary-sig-arg">self</span>)</span><br /> + Return true if the connection is attached, false otherwise.</td> + <td align="right" valign="top"> + <span class="codelink"><a href="qpid.messaging.endpoints-pysrc.html#Connection.attached">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="qpid.messaging.endpoints.Connection-class.html#close" class="summary-sig-name">close</a>(<span class="summary-sig-arg">self</span>, + <span class="summary-sig-arg">timeout</span>=<span class="summary-sig-default">None</span>)</span><br /> + Close the connection and all sessions.</td> + <td align="right" valign="top"> + <span class="codelink"><a href="qpid.messaging.endpoints-pysrc.html#Connection.close">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="qpid.messaging.endpoints.Endpoint-class.html">Endpoint</a></code></b>: + <code><a href="qpid.messaging.endpoints.Endpoint-class.html#set_async_exception_notify_handler">set_async_exception_notify_handler</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 href="qpid.messaging.endpoints.Connection-class.html#establish" class="summary-sig-name">establish</a>(<span class="summary-sig-arg">url</span>=<span class="summary-sig-default">None</span>, + <span class="summary-sig-arg">timeout</span>=<span class="summary-sig-default">None</span>, + <span class="summary-sig-arg">**options</span>)</span><br /> + Constructs a <a href="qpid.messaging.endpoints.Connection-class.html" + class="link">Connection</a> with the supplied parameters and opens + it.</td> + <td align="right" valign="top"> + <span class="codelink"><a href="qpid.messaging.endpoints-pysrc.html#Connection.establish">source code</a></span> + + </td> + </tr> + </table> + + </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="establish"></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">establish</span>(<span class="sig-arg">url</span>=<span class="sig-default">None</span>, + <span class="sig-arg">timeout</span>=<span class="sig-default">None</span>, + <span class="sig-arg">**options</span>)</span> + <br /><em class="fname">Static Method</em> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="qpid.messaging.endpoints-pysrc.html#Connection.establish">source code</a></span> + </td> + </tr></table> + + <p>Constructs a <a href="qpid.messaging.endpoints.Connection-class.html" + class="link">Connection</a> with the supplied parameters and opens + it.</p> + <dl class="fields"> + <dt>Decorators:</dt> + <dd><ul class="nomargin-top"> + <li><code>@static</code></li> + </ul></dd> + </dl> +</td></tr></table> +</div> +<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">url</span>=<span class="sig-default">None</span>, + <span class="sig-arg">**options</span>)</span> + <br /><em class="fname">(Constructor)</em> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="qpid.messaging.endpoints-pysrc.html#Connection.__init__">source code</a></span> + </td> + </tr></table> + + <p>Creates a connection. A newly created connection must be opened with + the Connection.open() method before it can be used.</p> + <dl class="fields"> + <dt>Parameters:</dt> + <dd><ul class="nomargin-top"> + <li><strong class="pname"><code>url</code></strong> (str) - [ <username> [ / <password> ] @ ] <host> [ : + <port> ]</li> + <li><strong class="pname"><code>host</code></strong> (str) - the name or ip address of the remote host (overriden by url)</li> + <li><strong class="pname"><code>port</code></strong> (int) - the port number of the remote host (overriden by url)</li> + <li><strong class="pname"><code>transport</code></strong> (str) - one of tcp, tcp+tls, or ssl (alias for tcp+tls)</li> + <li><strong class="pname"><code>heartbeat</code></strong> (int) - heartbeat interval in seconds</li> + <li><strong class="pname"><code>username</code></strong> (str) - the username for authentication (overriden by url)</li> + <li><strong class="pname"><code>password</code></strong> (str) - the password for authentication (overriden by url)</li> + <li><strong class="pname"><code>sasl_mechanisms</code></strong> (str) - space separated list of permitted sasl mechanisms</li> + <li><strong class="pname"><code>sasl_service</code></strong> (str) - the service name if needed by the SASL mechanism in use</li> + <li><strong class="pname"><code>sasl_min_ssf</code></strong> (int) - the minimum acceptable security strength factor</li> + <li><strong class="pname"><code>sasl_max_ssf</code></strong> (int) - the maximum acceptable security strength factor</li> + <li><strong class="pname"><code>reconnect</code></strong> (bool) - enable/disable automatic reconnect</li> + <li><strong class="pname"><code>reconnect_timeout</code></strong> (float) - total time to attempt reconnect</li> + <li><strong class="pname"><code>reconnect_interval_min</code></strong> (float) - minimum interval between reconnect attempts</li> + <li><strong class="pname"><code>reconnect_interval_max</code></strong> (float) - maximum interval between reconnect attempts</li> + <li><strong class="pname"><code>reconnect_interval</code></strong> (float) - set both min and max reconnect intervals</li> + <li><strong class="pname"><code>reconnect_limit</code></strong> (int) - limit the total number of reconnect attempts</li> + <li><strong class="pname"><code>reconnect_urls</code></strong> (list[str]) - list of backup hosts specified as urls</li> + <li><strong class="pname"><code>address_ttl</code></strong> (float) - time until cached address resolution expires</li> + <li><strong class="pname"><code>ssl_keyfile</code></strong> (str) - file with client's private key (PEM format)</li> + <li><strong class="pname"><code>ssl_certfile</code></strong> (str) - file with client's public (eventually priv+pub) key (PEM format)</li> + <li><strong class="pname"><code>ssl_trustfile</code></strong> (str) - file trusted certificates to validate the server</li> + <li><strong class="pname"><code>ssl_skip_hostname_check</code></strong> (bool) - disable verification of hostname in certificate. Use with caution + - disabling hostname checking leaves you vulnerable to + Man-in-the-Middle attacks.</li> + </ul></dd> + <dt>Returns: Connection</dt> + <dd>a disconnected Connection</dd> + <dt>Overrides: + <a href="qpid.messaging.endpoints.Endpoint-class.html#__init__">Endpoint.__init__</a> + </dt> + </dl> +</td></tr></table> +</div> +<a name="session"></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">session</span>(<span class="sig-arg">self</span>, + <span class="sig-arg">name</span>=<span class="sig-default">None</span>, + <span class="sig-arg">transactional</span>=<span class="sig-default">False</span>)</span> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="qpid.messaging.endpoints-pysrc.html#Connection.session">source code</a></span> + </td> + </tr></table> + + <p>Creates or retrieves the named session. If the name is omitted or + None, then a unique name is chosen based on a randomly generated + uuid.</p> + <dl class="fields"> + <dt>Parameters:</dt> + <dd><ul class="nomargin-top"> + <li><strong class="pname"><code>name</code></strong> (str) - the session name</li> + </ul></dd> + <dt>Returns: Session</dt> + <dd>the named Session</dd> + <dt>Decorators:</dt> + <dd><ul class="nomargin-top"> + <li><code>@synchronized</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 class="sig-arg">timeout</span>=<span class="sig-default">None</span>)</span> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="qpid.messaging.endpoints-pysrc.html#Connection.open">source code</a></span> + </td> + </tr></table> + + <p>Opens a connection.</p> + <dl class="fields"> + <dt>Decorators:</dt> + <dd><ul class="nomargin-top"> + <li><code>@synchronized</code></li> + </ul></dd> + </dl> +</td></tr></table> +</div> +<a name="opened"></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">opened</span>(<span class="sig-arg">self</span>)</span> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="qpid.messaging.endpoints-pysrc.html#Connection.opened">source code</a></span> + </td> + </tr></table> + + <p>Return true if the connection is open, false otherwise.</p> + <dl class="fields"> + <dt>Decorators:</dt> + <dd><ul class="nomargin-top"> + <li><code>@synchronized</code></li> + </ul></dd> + </dl> +</td></tr></table> +</div> +<a name="attach"></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">attach</span>(<span class="sig-arg">self</span>, + <span class="sig-arg">timeout</span>=<span class="sig-default">None</span>)</span> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="qpid.messaging.endpoints-pysrc.html#Connection.attach">source code</a></span> + </td> + </tr></table> + + <p>Attach to the remote endpoint.</p> + <dl class="fields"> + <dt>Decorators:</dt> + <dd><ul class="nomargin-top"> + <li><code>@synchronized</code></li> + </ul></dd> + </dl> +</td></tr></table> +</div> +<a name="detach"></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">detach</span>(<span class="sig-arg">self</span>, + <span class="sig-arg">timeout</span>=<span class="sig-default">None</span>)</span> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="qpid.messaging.endpoints-pysrc.html#Connection.detach">source code</a></span> + </td> + </tr></table> + + <p>Detach from the remote endpoint.</p> + <dl class="fields"> + <dt>Decorators:</dt> + <dd><ul class="nomargin-top"> + <li><code>@synchronized</code></li> + </ul></dd> + </dl> +</td></tr></table> +</div> +<a name="attached"></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">attached</span>(<span class="sig-arg">self</span>)</span> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="qpid.messaging.endpoints-pysrc.html#Connection.attached">source code</a></span> + </td> + </tr></table> + + <p>Return true if the connection is attached, false otherwise.</p> + <dl class="fields"> + <dt>Decorators:</dt> + <dd><ul class="nomargin-top"> + <li><code>@synchronized</code></li> + </ul></dd> + </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 class="sig-arg">timeout</span>=<span class="sig-default">None</span>)</span> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="qpid.messaging.endpoints-pysrc.html#Connection.close">source code</a></span> + </td> + </tr></table> + + <p>Close the connection and all sessions.</p> + <dl class="fields"> + <dt>Decorators:</dt> + <dd><ul class="nomargin-top"> + <li><code>@synchronized</code></li> + </ul></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="qpid.messaging-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 Python Messaging 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>
http://git-wip-us.apache.org/repos/asf/qpid-site/blob/55375a76/content/releases/qpid-python-1.36.0/messaging-api/api/qpid.messaging.endpoints.Endpoint-class.html ---------------------------------------------------------------------- diff --git a/content/releases/qpid-python-1.36.0/messaging-api/api/qpid.messaging.endpoints.Endpoint-class.html b/content/releases/qpid-python-1.36.0/messaging-api/api/qpid.messaging.endpoints.Endpoint-class.html new file mode 100755 index 0000000..4d9c277 --- /dev/null +++ b/content/releases/qpid-python-1.36.0/messaging-api/api/qpid.messaging.endpoints.Endpoint-class.html @@ -0,0 +1,213 @@ +<?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>qpid.messaging.endpoints.Endpoint</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="qpid.messaging-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 Python Messaging 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 qpid :: + <a href="qpid.messaging-module.html">Package messaging</a> :: + <a href="qpid.messaging.endpoints-module.html">Module endpoints</a> :: + Class Endpoint + </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="qpid.messaging.endpoints.Endpoint-class.html" + target="_top">no frames</a>]</span></td></tr> + </table> + </td> + </tr> +</table> +<!-- ==================== TYPE DESCRIPTION ==================== --> +<h1 class="epydoc">type Endpoint</h1><p class="nomargin-top"><span class="codelink"><a href="qpid.messaging.endpoints-pysrc.html#Endpoint">source code</a></span></p> +<center> + +</center> +<dl><dt>Known Subclasses:</dt> +<dd> + <ul class="subclass-list"> +<li><a href="qpid.messaging.endpoints.Connection-class.html">Connection</a></li><li>, <a href="qpid.messaging.endpoints.Receiver-class.html">Receiver</a></li><li>, <a href="qpid.messaging.endpoints.Sender-class.html">Sender</a></li><li>, <a href="qpid.messaging.endpoints.Session-class.html">Session</a></li> </ul> +</dd></dl> + +<hr /> +<p>Base class for all endpoint objects types.</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="qpid.messaging.endpoints.Endpoint-class.html#set_async_exception_notify_handler" class="summary-sig-name">set_async_exception_notify_handler</a>(<span class="summary-sig-arg">self</span>, + <span class="summary-sig-arg">handler</span>)</span><br /> + Register a callable that will be invoked when the driver thread + detects an error on the Endpoint.</td> + <td align="right" valign="top"> + <span class="codelink"><a href="qpid.messaging.endpoints-pysrc.html#Endpoint.set_async_exception_notify_handler">source code</a></span> + + </td> + </tr> + </table> + + </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="set_async_exception_notify_handler"></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">set_async_exception_notify_handler</span>(<span class="sig-arg">self</span>, + <span class="sig-arg">handler</span>)</span> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="qpid.messaging.endpoints-pysrc.html#Endpoint.set_async_exception_notify_handler">source code</a></span> + </td> + </tr></table> + + <p>Register a callable that will be invoked when the driver thread + detects an error on the Endpoint. The callable is invoked with the + instance of the Endpoint object passed as the first argument. The second + argument is an Exception instance describing the failure.</p> + <dl class="fields"> + <dt>Parameters:</dt> + <dd><ul class="nomargin-top"> + <li><strong class="pname"><code>handler</code></strong> (callable object taking an Endpoint and an Exception as arguments.) - invoked by the driver thread when an error occurs.</li> + </ul></dd> + <dt>Returns:</dt> + <dd>None</dd> + <dt>Decorators:</dt> + <dd><ul class="nomargin-top"> + <li><code>@synchronized</code></li> + </ul></dd> + </dl> +<div class="fields"> <p><strong>Note:</strong> + The exception will also be raised the next time the application + invokes one of the blocking messaging APIs. + </p> + <p><strong>Warning:</strong> + <b>Use with caution</b> This callback is invoked in the context of + the driver thread. It is <b>NOT</b> safe to call <b>ANY</b> of the + messaging APIs from within this callback. This includes any of the + Endpoint's methods. The intent of the handler is to provide an + efficient way to notify the application that an exception has + occurred in the driver thread. This can be useful for those + applications that periodically poll the messaging layer for events. + In this case the callback can be used to schedule a task that + retrieves the error using the Endpoint's get_error() or + check_error() methods. + </p> +</div></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="qpid.messaging-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 Python Messaging 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> http://git-wip-us.apache.org/repos/asf/qpid-site/blob/55375a76/content/releases/qpid-python-1.36.0/messaging-api/api/qpid.messaging.endpoints.Receiver-class.html ---------------------------------------------------------------------- diff --git a/content/releases/qpid-python-1.36.0/messaging-api/api/qpid.messaging.endpoints.Receiver-class.html b/content/releases/qpid-python-1.36.0/messaging-api/api/qpid.messaging.endpoints.Receiver-class.html new file mode 100755 index 0000000..ff75a6f --- /dev/null +++ b/content/releases/qpid-python-1.36.0/messaging-api/api/qpid.messaging.endpoints.Receiver-class.html @@ -0,0 +1,462 @@ +<?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>qpid.messaging.endpoints.Receiver</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="qpid.messaging-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 Python Messaging 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 qpid :: + <a href="qpid.messaging-module.html">Package messaging</a> :: + <a href="qpid.messaging.endpoints-module.html">Module endpoints</a> :: + Class Receiver + </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="qpid.messaging.endpoints.Receiver-class.html" + target="_top">no frames</a>]</span></td></tr> + </table> + </td> + </tr> +</table> +<!-- ==================== TYPE DESCRIPTION ==================== --> +<h1 class="epydoc">type Receiver</h1><p class="nomargin-top"><span class="codelink"><a href="qpid.messaging.endpoints-pysrc.html#Receiver">source code</a></span></p> +<center> + +</center> +<hr /> +<p>Receives incoming messages from a remote source. Messages may be + fetched with <a href="qpid.messaging.endpoints.Receiver-class.html#fetch" + class="link">fetch</a>.</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="qpid.messaging.endpoints.Receiver-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>, + <span class="summary-sig-arg">session</span>, + <span class="summary-sig-arg">id</span>, + <span class="summary-sig-arg">source</span>, + <span class="summary-sig-arg">options</span>)</span></td> + <td align="right" valign="top"> + <span class="codelink"><a href="qpid.messaging.endpoints-pysrc.html#Receiver.__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="check_error"></a><span class="summary-sig-name">check_error</span>(<span class="summary-sig-arg">self</span>)</span></td> + <td align="right" valign="top"> + <span class="codelink"><a href="qpid.messaging.endpoints-pysrc.html#Receiver.check_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="get_error"></a><span class="summary-sig-name">get_error</span>(<span class="summary-sig-arg">self</span>)</span></td> + <td align="right" valign="top"> + <span class="codelink"><a href="qpid.messaging.endpoints-pysrc.html#Receiver.get_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="check_closed"></a><span class="summary-sig-name">check_closed</span>(<span class="summary-sig-arg">self</span>)</span></td> + <td align="right" valign="top"> + <span class="codelink"><a href="qpid.messaging.endpoints-pysrc.html#Receiver.check_closed">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="qpid.messaging.endpoints.Receiver-class.html#unsettled" class="summary-sig-name">unsettled</a>(<span class="summary-sig-arg">self</span>)</span><br /> + Returns the number of acknowledged messages awaiting confirmation.</td> + <td align="right" valign="top"> + <span class="codelink"><a href="qpid.messaging.endpoints-pysrc.html#Receiver.unsettled">source code</a></span> + + </td> + </tr> + </table> + + </td> + </tr> +<tr> + <td width="15%" align="right" valign="top" class="summary"> + <span class="summary-type">int</span> + </td><td class="summary"> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr> + <td><span class="summary-sig"><a href="qpid.messaging.endpoints.Receiver-class.html#available" class="summary-sig-name">available</a>(<span class="summary-sig-arg">self</span>)</span><br /> + Returns the number of messages available to be fetched by the + application.</td> + <td align="right" valign="top"> + <span class="codelink"><a href="qpid.messaging.endpoints-pysrc.html#Receiver.available">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="qpid.messaging.endpoints.Receiver-class.html#fetch" class="summary-sig-name">fetch</a>(<span class="summary-sig-arg">self</span>, + <span class="summary-sig-arg">timeout</span>=<span class="summary-sig-default">None</span>)</span><br /> + Fetch and return a single message.</td> + <td align="right" valign="top"> + <span class="codelink"><a href="qpid.messaging.endpoints-pysrc.html#Receiver.fetch">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="qpid.messaging.endpoints.Receiver-class.html#close" class="summary-sig-name">close</a>(<span class="summary-sig-arg">self</span>, + <span class="summary-sig-arg">timeout</span>=<span class="summary-sig-default">None</span>)</span><br /> + Close the receiver.</td> + <td align="right" valign="top"> + <span class="codelink"><a href="qpid.messaging.endpoints-pysrc.html#Receiver.close">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="qpid.messaging.endpoints.Endpoint-class.html">Endpoint</a></code></b>: + <code><a href="qpid.messaging.endpoints.Endpoint-class.html#set_async_exception_notify_handler">set_async_exception_notify_handler</a></code> + </p> + </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="qpid.messaging.endpoints.Receiver-class.html#capacity" class="summary-name">capacity</a> + </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">session</span>, + <span class="sig-arg">id</span>, + <span class="sig-arg">source</span>, + <span class="sig-arg">options</span>)</span> + <br /><em class="fname">(Constructor)</em> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="qpid.messaging.endpoints-pysrc.html#Receiver.__init__">source code</a></span> + </td> + </tr></table> + + + <dl class="fields"> + <dt>Overrides: + <a href="qpid.messaging.endpoints.Endpoint-class.html#__init__">Endpoint.__init__</a> + </dt> + </dl> +</td></tr></table> +</div> +<a name="unsettled"></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">unsettled</span>(<span class="sig-arg">self</span>)</span> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="qpid.messaging.endpoints-pysrc.html#Receiver.unsettled">source code</a></span> + </td> + </tr></table> + + <p>Returns the number of acknowledged messages awaiting confirmation.</p> + <dl class="fields"> + <dt>Decorators:</dt> + <dd><ul class="nomargin-top"> + <li><code>@synchronized</code></li> + </ul></dd> + </dl> +</td></tr></table> +</div> +<a name="available"></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">available</span>(<span class="sig-arg">self</span>)</span> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="qpid.messaging.endpoints-pysrc.html#Receiver.available">source code</a></span> + </td> + </tr></table> + + <p>Returns the number of messages available to be fetched by the + application.</p> + <dl class="fields"> + <dt>Returns: int</dt> + <dd>the number of available messages</dd> + <dt>Decorators:</dt> + <dd><ul class="nomargin-top"> + <li><code>@synchronized</code></li> + </ul></dd> + </dl> +</td></tr></table> +</div> +<a name="fetch"></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">fetch</span>(<span class="sig-arg">self</span>, + <span class="sig-arg">timeout</span>=<span class="sig-default">None</span>)</span> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="qpid.messaging.endpoints-pysrc.html#Receiver.fetch">source code</a></span> + </td> + </tr></table> + + <p>Fetch and return a single message. A timeout of None will block + forever waiting for a message to arrive, a timeout of zero will return + immediately if no messages are available.</p> + <dl class="fields"> + <dt>Parameters:</dt> + <dd><ul class="nomargin-top"> + <li><strong class="pname"><code>timeout</code></strong> (float) - the time to wait for a message to be available</li> + </ul></dd> + <dt>Decorators:</dt> + <dd><ul class="nomargin-top"> + <li><code>@synchronized</code></li> + </ul></dd> + </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 class="sig-arg">timeout</span>=<span class="sig-default">None</span>)</span> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="qpid.messaging.endpoints-pysrc.html#Receiver.close">source code</a></span> + </td> + </tr></table> + + <p>Close the receiver.</p> + <dl class="fields"> + <dt>Decorators:</dt> + <dd><ul class="nomargin-top"> + <li><code>@synchronized</code></li> + </ul></dd> + </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="capacity"></a> +<div> +<table class="details" border="1" cellpadding="3" + cellspacing="0" width="100%" bgcolor="white"> +<tr><td> + <h3 class="epydoc">capacity</h3> + + <dl class="fields"> + <dt>Get Method:</dt> + <dd class="value"><span class="summary-sig"><a href="qpid.messaging.endpoints.Receiver-class.html#_get_capacity" class="summary-sig-name" onclick="show_private();">_get_capacity</a>(<span class="summary-sig-arg">self</span>)</span> + </dd> + <dt>Set Method:</dt> + <dd class="value"><span class="summary-sig"><a href="qpid.messaging.endpoints.Receiver-class.html#_set_capacity" class="summary-sig-name" onclick="show_private();">_set_capacity</a>(<span class="summary-sig-arg">self</span>, + <span class="summary-sig-arg">c</span>, + <span class="summary-sig-arg">wakeup</span>=<span class="summary-sig-default">True</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="qpid.messaging-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 Python Messaging 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> http://git-wip-us.apache.org/repos/asf/qpid-site/blob/55375a76/content/releases/qpid-python-1.36.0/messaging-api/api/qpid.messaging.endpoints.Sender-class.html ---------------------------------------------------------------------- diff --git a/content/releases/qpid-python-1.36.0/messaging-api/api/qpid.messaging.endpoints.Sender-class.html b/content/releases/qpid-python-1.36.0/messaging-api/api/qpid.messaging.endpoints.Sender-class.html new file mode 100755 index 0000000..68bf48e --- /dev/null +++ b/content/releases/qpid-python-1.36.0/messaging-api/api/qpid.messaging.endpoints.Sender-class.html @@ -0,0 +1,470 @@ +<?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>qpid.messaging.endpoints.Sender</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="qpid.messaging-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 Python Messaging 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 qpid :: + <a href="qpid.messaging-module.html">Package messaging</a> :: + <a href="qpid.messaging.endpoints-module.html">Module endpoints</a> :: + Class Sender + </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="qpid.messaging.endpoints.Sender-class.html" + target="_top">no frames</a>]</span></td></tr> + </table> + </td> + </tr> +</table> +<!-- ==================== TYPE DESCRIPTION ==================== --> +<h1 class="epydoc">type Sender</h1><p class="nomargin-top"><span class="codelink"><a href="qpid.messaging.endpoints-pysrc.html#Sender">source code</a></span></p> +<center> + +</center> +<hr /> +<p>Sends outgoing messages.</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="qpid.messaging.endpoints.Sender-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>, + <span class="summary-sig-arg">session</span>, + <span class="summary-sig-arg">id</span>, + <span class="summary-sig-arg">target</span>, + <span class="summary-sig-arg">options</span>)</span></td> + <td align="right" valign="top"> + <span class="codelink"><a href="qpid.messaging.endpoints-pysrc.html#Sender.__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="check_error"></a><span class="summary-sig-name">check_error</span>(<span class="summary-sig-arg">self</span>)</span></td> + <td align="right" valign="top"> + <span class="codelink"><a href="qpid.messaging.endpoints-pysrc.html#Sender.check_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="get_error"></a><span class="summary-sig-name">get_error</span>(<span class="summary-sig-arg">self</span>)</span></td> + <td align="right" valign="top"> + <span class="codelink"><a href="qpid.messaging.endpoints-pysrc.html#Sender.get_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="check_closed"></a><span class="summary-sig-name">check_closed</span>(<span class="summary-sig-arg">self</span>)</span></td> + <td align="right" valign="top"> + <span class="codelink"><a href="qpid.messaging.endpoints-pysrc.html#Sender.check_closed">source code</a></span> + + </td> + </tr> + </table> + + </td> + </tr> +<tr> + <td width="15%" align="right" valign="top" class="summary"> + <span class="summary-type">int</span> + </td><td class="summary"> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr> + <td><span class="summary-sig"><a href="qpid.messaging.endpoints.Sender-class.html#unsettled" class="summary-sig-name">unsettled</a>(<span class="summary-sig-arg">self</span>)</span><br /> + Returns the number of messages awaiting acknowledgment.</td> + <td align="right" valign="top"> + <span class="codelink"><a href="qpid.messaging.endpoints-pysrc.html#Sender.unsettled">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="qpid.messaging.endpoints.Sender-class.html#available" class="summary-sig-name">available</a>(<span class="summary-sig-arg">self</span>)</span></td> + <td align="right" valign="top"> + <span class="codelink"><a href="qpid.messaging.endpoints-pysrc.html#Sender.available">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="qpid.messaging.endpoints.Sender-class.html#send" class="summary-sig-name">send</a>(<span class="summary-sig-arg">self</span>, + <span class="summary-sig-arg">object</span>, + <span class="summary-sig-arg">sync</span>=<span class="summary-sig-default">True</span>, + <span class="summary-sig-arg">timeout</span>=<span class="summary-sig-default">None</span>)</span><br /> + Send a message.</td> + <td align="right" valign="top"> + <span class="codelink"><a href="qpid.messaging.endpoints-pysrc.html#Sender.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="qpid.messaging.endpoints.Sender-class.html#sync" class="summary-sig-name">sync</a>(<span class="summary-sig-arg">self</span>, + <span class="summary-sig-arg">timeout</span>=<span class="summary-sig-default">None</span>)</span></td> + <td align="right" valign="top"> + <span class="codelink"><a href="qpid.messaging.endpoints-pysrc.html#Sender.sync">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="qpid.messaging.endpoints.Sender-class.html#close" class="summary-sig-name">close</a>(<span class="summary-sig-arg">self</span>, + <span class="summary-sig-arg">timeout</span>=<span class="summary-sig-default">None</span>)</span><br /> + Close the Sender.</td> + <td align="right" valign="top"> + <span class="codelink"><a href="qpid.messaging.endpoints-pysrc.html#Sender.close">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="qpid.messaging.endpoints.Endpoint-class.html">Endpoint</a></code></b>: + <code><a href="qpid.messaging.endpoints.Endpoint-class.html#set_async_exception_notify_handler">set_async_exception_notify_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">session</span>, + <span class="sig-arg">id</span>, + <span class="sig-arg">target</span>, + <span class="sig-arg">options</span>)</span> + <br /><em class="fname">(Constructor)</em> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="qpid.messaging.endpoints-pysrc.html#Sender.__init__">source code</a></span> + </td> + </tr></table> + + + <dl class="fields"> + <dt>Overrides: + <a href="qpid.messaging.endpoints.Endpoint-class.html#__init__">Endpoint.__init__</a> + </dt> + </dl> +</td></tr></table> +</div> +<a name="unsettled"></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">unsettled</span>(<span class="sig-arg">self</span>)</span> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="qpid.messaging.endpoints-pysrc.html#Sender.unsettled">source code</a></span> + </td> + </tr></table> + + <p>Returns the number of messages awaiting acknowledgment.</p> + <dl class="fields"> + <dt>Returns: int</dt> + <dd>the number of unacknowledged messages</dd> + <dt>Decorators:</dt> + <dd><ul class="nomargin-top"> + <li><code>@synchronized</code></li> + </ul></dd> + </dl> +</td></tr></table> +</div> +<a name="available"></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">available</span>(<span class="sig-arg">self</span>)</span> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="qpid.messaging.endpoints-pysrc.html#Sender.available">source code</a></span> + </td> + </tr></table> + + + <dl class="fields"> + <dt>Decorators:</dt> + <dd><ul class="nomargin-top"> + <li><code>@synchronized</code></li> + </ul></dd> + </dl> +</td></tr></table> +</div> +<a name="send"></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">send</span>(<span class="sig-arg">self</span>, + <span class="sig-arg">object</span>, + <span class="sig-arg">sync</span>=<span class="sig-default">True</span>, + <span class="sig-arg">timeout</span>=<span class="sig-default">None</span>)</span> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="qpid.messaging.endpoints-pysrc.html#Sender.send">source code</a></span> + </td> + </tr></table> + + <p>Send a message. If the object passed in is of type <code + class="link">unicode</code>, <code class="link">str</code>, <code + class="link">list</code>, or <code class="link">dict</code>, it will + automatically be wrapped in a <a + href="qpid.messaging.message.Message-class.html" class="link">Message</a> + and sent. If it is of type <a + href="qpid.messaging.message.Message-class.html" + class="link">Message</a>, it will be sent directly. If the sender + capacity is not UNLIMITED then send will block until there is available + capacity to send the message. If the timeout parameter is specified, then + send will throw an <a + href="qpid.messaging.exceptions.InsufficientCapacity-class.html" + class="link">InsufficientCapacity</a> exception if capacity does not + become available within the specified time.</p> + <dl class="fields"> + <dt>Parameters:</dt> + <dd><ul class="nomargin-top"> + <li><strong class="pname"><code>object</code></strong> (unicode, str, list, dict, Message) - the message or content to send</li> + <li><strong class="pname"><code>sync</code></strong> (boolean) - if true then block until the message is sent</li> + <li><strong class="pname"><code>timeout</code></strong> (float) - the time to wait for available capacity</li> + </ul></dd> + <dt>Decorators:</dt> + <dd><ul class="nomargin-top"> + <li><code>@synchronized</code></li> + </ul></dd> + </dl> +</td></tr></table> +</div> +<a name="sync"></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">sync</span>(<span class="sig-arg">self</span>, + <span class="sig-arg">timeout</span>=<span class="sig-default">None</span>)</span> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="qpid.messaging.endpoints-pysrc.html#Sender.sync">source code</a></span> + </td> + </tr></table> + + + <dl class="fields"> + <dt>Decorators:</dt> + <dd><ul class="nomargin-top"> + <li><code>@synchronized</code></li> + </ul></dd> + </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 class="sig-arg">timeout</span>=<span class="sig-default">None</span>)</span> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="qpid.messaging.endpoints-pysrc.html#Sender.close">source code</a></span> + </td> + </tr></table> + + <p>Close the Sender.</p> + <dl class="fields"> + <dt>Decorators:</dt> + <dd><ul class="nomargin-top"> + <li><code>@synchronized</code></li> + </ul></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="qpid.messaging-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 Python Messaging 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> --------------------------------------------------------------------- To unsubscribe, e-mail: commits-unsubscr...@qpid.apache.org For additional commands, e-mail: commits-h...@qpid.apache.org