blob: 641d9bb51e69fc28b6a898a1d136ab91b65fd7b2 [file] [log] [blame]
<?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._endpoints.Terminus</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>&nbsp;&nbsp;&nbsp;<a
href="proton-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Tree link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Index link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Help link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</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&nbsp;proton</a> ::
<a href="proton._endpoints-module.html" onclick="show_private();">Module&nbsp;_endpoints</a> ::
Class&nbsp;Terminus
</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
>]&nbsp;|&nbsp;<a href="proton._endpoints.Terminus-class.html"
target="_top">no&nbsp;frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== TYPE DESCRIPTION ==================== -->
<h1 class="epydoc">type Terminus</h1><p class="nomargin-top"><span class="codelink"><a href="proton._endpoints-pysrc.html#Terminus">source&nbsp;code</a></span></p>
<center>
</center>
<hr />
<!-- ==================== 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">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="proton._endpoints.Terminus-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">impl</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="proton._endpoints-pysrc.html#Terminus.__init__">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="copy"></a><span class="summary-sig-name">copy</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">src</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="proton._endpoints-pysrc.html#Terminus.copy">source&nbsp;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">&nbsp;</span>
</td><td class="summary">
<a name="UNSPECIFIED"></a><span class="summary-name">UNSPECIFIED</span> = <code title="0">0</code>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<a name="SOURCE"></a><span class="summary-name">SOURCE</span> = <code title="1">1</code>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<a name="TARGET"></a><span class="summary-name">TARGET</span> = <code title="2">2</code>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<a name="COORDINATOR"></a><span class="summary-name">COORDINATOR</span> = <code title="3">3</code>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<a name="NONDURABLE"></a><span class="summary-name">NONDURABLE</span> = <code title="0">0</code>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<a name="CONFIGURATION"></a><span class="summary-name">CONFIGURATION</span> = <code title="1">1</code>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<a name="DELIVERIES"></a><span class="summary-name">DELIVERIES</span> = <code title="2">2</code>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<a name="DIST_MODE_UNSPECIFIED"></a><span class="summary-name">DIST_MODE_UNSPECIFIED</span> = <code title="0">0</code>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<a name="DIST_MODE_COPY"></a><span class="summary-name">DIST_MODE_COPY</span> = <code title="1">1</code>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<a name="DIST_MODE_MOVE"></a><span class="summary-name">DIST_MODE_MOVE</span> = <code title="2">2</code>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<a name="EXPIRE_WITH_LINK"></a><span class="summary-name">EXPIRE_WITH_LINK</span> = <code title="0">0</code>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<a name="EXPIRE_WITH_SESSION"></a><span class="summary-name">EXPIRE_WITH_SESSION</span> = <code title="1">1</code>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<a name="EXPIRE_WITH_CONNECTION"></a><span class="summary-name">EXPIRE_WITH_CONNECTION</span> = <code title="2">2</code>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<a name="EXPIRE_NEVER"></a><span class="summary-name">EXPIRE_NEVER</span> = <code title="3">3</code>
</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">&nbsp;</span>
</td><td class="summary">
<a href="proton._endpoints.Terminus-class.html#type" class="summary-name">type</a>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<a href="proton._endpoints.Terminus-class.html#address" class="summary-name">address</a><br />
The address that identifies the source or target node
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<a href="proton._endpoints.Terminus-class.html#durability" class="summary-name">durability</a>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<a href="proton._endpoints.Terminus-class.html#expiry_policy" class="summary-name">expiry_policy</a>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<a href="proton._endpoints.Terminus-class.html#timeout" class="summary-name">timeout</a>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<a href="proton._endpoints.Terminus-class.html#dynamic" class="summary-name">dynamic</a><br />
Indicates whether the source or target node was dynamically created
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<a href="proton._endpoints.Terminus-class.html#distribution_mode" class="summary-name">distribution_mode</a>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<a href="proton._endpoints.Terminus-class.html#properties" class="summary-name">properties</a><br />
Properties of a dynamic source or target.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<a href="proton._endpoints.Terminus-class.html#capabilities" class="summary-name">capabilities</a><br />
Capabilities of the source or target.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<a href="proton._endpoints.Terminus-class.html#outcomes" class="summary-name">outcomes</a>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<a href="proton._endpoints.Terminus-class.html#filter" class="summary-name">filter</a><br />
A filter on a source allows the set of messages transfered over the
link to be restricted
</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>
<br /><em class="fname">(Constructor)</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="proton._endpoints-pysrc.html#Terminus.__init__">source&nbsp;code</a></span>&nbsp;
</td>
</tr></table>
<dl class="fields">
<dt>Overrides:
object.__init__
<dd><em class="note">(inherited documentation)</em></dd>
</dt>
</dl>
</td></tr></table>
</div>
<br />
<!-- ==================== PROPERTY DETAILS ==================== -->
<a name="section-PropertyDetails"></a>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td align="left" colspan="2" class="table-header">
<span class="table-header">Property Details</span></td>
</tr>
</table>
<a name="type"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">type</h3>
<dl class="fields">
<dt>Get Method:</dt>
<dd class="value"><span class="summary-sig"><a href="proton._endpoints.Terminus-class.html#_get_type" class="summary-sig-name" onclick="show_private();">_get_type</a>(<span class="summary-sig-arg">self</span>)</span>
</dd>
<dt>Set Method:</dt>
<dd class="value"><span class="summary-sig"><a href="proton._endpoints.Terminus-class.html#_set_type" class="summary-sig-name" onclick="show_private();">_set_type</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">type</span>)</span>
</dd>
</dl>
</td></tr></table>
</div>
<a name="address"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">address</h3>
<p>The address that identifies the source or target node</p>
<dl class="fields">
<dt>Get Method:</dt>
<dd class="value"><span class="summary-sig"><a href="proton._endpoints.Terminus-class.html#_get_address" class="summary-sig-name" onclick="show_private();">_get_address</a>(<span class="summary-sig-arg">self</span>)</span>
- The address that identifies the source or target node
</dd>
<dt>Set Method:</dt>
<dd class="value"><span class="summary-sig"><a href="proton._endpoints.Terminus-class.html#_set_address" class="summary-sig-name" onclick="show_private();">_set_address</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">address</span>)</span>
</dd>
</dl>
</td></tr></table>
</div>
<a name="durability"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">durability</h3>
<dl class="fields">
<dt>Get Method:</dt>
<dd class="value"><span class="summary-sig"><a href="proton._endpoints.Terminus-class.html#_get_durability" class="summary-sig-name" onclick="show_private();">_get_durability</a>(<span class="summary-sig-arg">self</span>)</span>
</dd>
<dt>Set Method:</dt>
<dd class="value"><span class="summary-sig"><a href="proton._endpoints.Terminus-class.html#_set_durability" class="summary-sig-name" onclick="show_private();">_set_durability</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">seconds</span>)</span>
</dd>
</dl>
</td></tr></table>
</div>
<a name="expiry_policy"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">expiry_policy</h3>
<dl class="fields">
<dt>Get Method:</dt>
<dd class="value"><span class="summary-sig"><a href="proton._endpoints.Terminus-class.html#_get_expiry_policy" class="summary-sig-name" onclick="show_private();">_get_expiry_policy</a>(<span class="summary-sig-arg">self</span>)</span>
</dd>
<dt>Set Method:</dt>
<dd class="value"><span class="summary-sig"><a href="proton._endpoints.Terminus-class.html#_set_expiry_policy" class="summary-sig-name" onclick="show_private();">_set_expiry_policy</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">seconds</span>)</span>
</dd>
</dl>
</td></tr></table>
</div>
<a name="timeout"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">timeout</h3>
<dl class="fields">
<dt>Get Method:</dt>
<dd class="value"><span class="summary-sig"><a href="proton._endpoints.Terminus-class.html#_get_timeout" class="summary-sig-name" onclick="show_private();">_get_timeout</a>(<span class="summary-sig-arg">self</span>)</span>
</dd>
<dt>Set Method:</dt>
<dd class="value"><span class="summary-sig"><a href="proton._endpoints.Terminus-class.html#_set_timeout" class="summary-sig-name" onclick="show_private();">_set_timeout</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">seconds</span>)</span>
</dd>
</dl>
</td></tr></table>
</div>
<a name="dynamic"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">dynamic</h3>
<p>Indicates whether the source or target node was dynamically
created</p>
<dl class="fields">
<dt>Get Method:</dt>
<dd class="value"><span class="summary-sig"><a href="proton._endpoints.Terminus-class.html#_is_dynamic" class="summary-sig-name" onclick="show_private();">_is_dynamic</a>(<span class="summary-sig-arg">self</span>)</span>
- Indicates whether the source or target node was dynamically created
</dd>
<dt>Set Method:</dt>
<dd class="value"><span class="summary-sig"><a href="proton._endpoints.Terminus-class.html#_set_dynamic" class="summary-sig-name" onclick="show_private();">_set_dynamic</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">dynamic</span>)</span>
</dd>
</dl>
</td></tr></table>
</div>
<a name="distribution_mode"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">distribution_mode</h3>
<dl class="fields">
<dt>Get Method:</dt>
<dd class="value"><span class="summary-sig"><a href="proton._endpoints.Terminus-class.html#_get_distribution_mode" class="summary-sig-name" onclick="show_private();">_get_distribution_mode</a>(<span class="summary-sig-arg">self</span>)</span>
</dd>
<dt>Set Method:</dt>
<dd class="value"><span class="summary-sig"><a href="proton._endpoints.Terminus-class.html#_set_distribution_mode" class="summary-sig-name" onclick="show_private();">_set_distribution_mode</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">mode</span>)</span>
</dd>
</dl>
</td></tr></table>
</div>
<a name="properties"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">properties</h3>
<p>Properties of a dynamic source or target.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="capabilities"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">capabilities</h3>
<p>Capabilities of the source or target.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="outcomes"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">outcomes</h3>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="filter"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">filter</h3>
<p>A filter on a source allows the set of messages transfered over the
link to be restricted</p>
<dl class="fields">
</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>&nbsp;&nbsp;&nbsp;<a
href="proton-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Tree link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Index link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Help link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</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>