blob: c4f1f699613fe0eb0be0fac46a82a0f27f35c3f2 [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.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>&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;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
>]&nbsp;|&nbsp;<a href="proton._endpoints.Receiver-class.html"
target="_top">no&nbsp;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="proton._endpoints-pysrc.html#Receiver">source&nbsp;code</a></span></p>
<center>
</center>
<hr />
<p>A link over which messages are received.</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">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="flow"></a><span class="summary-sig-name">flow</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">n</span>)</span><br />
Increases the credit issued to the remote sender by the specified
number of messages.</td>
<td align="right" valign="top">
<span class="codelink"><a href="proton._endpoints-pysrc.html#Receiver.flow">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="recv"></a><span class="summary-sig-name">recv</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">limit</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="proton._endpoints-pysrc.html#Receiver.recv">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="drain"></a><span class="summary-sig-name">drain</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">n</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="proton._endpoints-pysrc.html#Receiver.drain">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="draining"></a><span class="summary-sig-name">draining</span>(<span class="summary-sig-arg">self</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="proton._endpoints-pysrc.html#Receiver.draining">source&nbsp;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._endpoints.Link-class.html">Link</a></code></b>:
<code><a href="proton._endpoints.Link-class.html#__init__">__init__</a></code>,
<code><a href="proton._endpoints.Link-class.html#advance">advance</a></code>,
<code><a href="proton._endpoints.Link-class.html#close">close</a></code>,
<code><a href="proton._endpoints.Link-class.html#delivery">delivery</a></code>,
<code><a href="proton._endpoints.Link-class.html#detach">detach</a></code>,
<code><a href="proton._endpoints.Link-class.html#drained">drained</a></code>,
<code><a href="proton._endpoints.Link-class.html#free">free</a></code>,
<code><a href="proton._endpoints.Link-class.html#next">next</a></code>,
<code><a href="proton._endpoints.Link-class.html#open">open</a></code>
</p>
<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>
</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 colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="proton._endpoints.Link-class.html">Link</a></code></b>:
<code><a href="proton._endpoints.Link-class.html#wrap">wrap</a></code>
</p>
</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 colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="proton._endpoints.Link-class.html">Link</a></code></b>:
<code><a href="proton._endpoints.Link-class.html#RCV_FIRST">RCV_FIRST</a></code>,
<code><a href="proton._endpoints.Link-class.html#RCV_SECOND">RCV_SECOND</a></code>,
<code><a href="proton._endpoints.Link-class.html#SND_MIXED">SND_MIXED</a></code>,
<code><a href="proton._endpoints.Link-class.html#SND_SETTLED">SND_SETTLED</a></code>,
<code><a href="proton._endpoints.Link-class.html#SND_UNSETTLED">SND_UNSETTLED</a></code>
</p>
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="proton._endpoints.Endpoint-class.html">Endpoint</a></code></b>:
<code><a href="proton._endpoints.Endpoint-class.html#LOCAL_ACTIVE">LOCAL_ACTIVE</a></code>,
<code><a href="proton._endpoints.Endpoint-class.html#LOCAL_CLOSED">LOCAL_CLOSED</a></code>,
<code><a href="proton._endpoints.Endpoint-class.html#LOCAL_UNINIT">LOCAL_UNINIT</a></code>,
<code><a href="proton._endpoints.Endpoint-class.html#REMOTE_ACTIVE">REMOTE_ACTIVE</a></code>,
<code><a href="proton._endpoints.Endpoint-class.html#REMOTE_CLOSED">REMOTE_CLOSED</a></code>,
<code><a href="proton._endpoints.Endpoint-class.html#REMOTE_UNINIT">REMOTE_UNINIT</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 colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="proton._endpoints.Link-class.html">Link</a></code></b>:
<code><a href="proton._endpoints.Link-class.html#available">available</a></code>,
<code><a href="proton._endpoints.Link-class.html#connection">connection</a></code>,
<code><a href="proton._endpoints.Link-class.html#credit">credit</a></code>,
<code><a href="proton._endpoints.Link-class.html#current">current</a></code>,
<code><a href="proton._endpoints.Link-class.html#drain_mode">drain_mode</a></code>,
<code><a href="proton._endpoints.Link-class.html#is_receiver">is_receiver</a></code>,
<code><a href="proton._endpoints.Link-class.html#is_sender">is_sender</a></code>,
<code><a href="proton._endpoints.Link-class.html#max_message_size">max_message_size</a></code>,
<code><a href="proton._endpoints.Link-class.html#name">name</a></code>,
<code><a href="proton._endpoints.Link-class.html#queued">queued</a></code>,
<code><a href="proton._endpoints.Link-class.html#rcv_settle_mode">rcv_settle_mode</a></code>,
<code><a href="proton._endpoints.Link-class.html#remote_max_message_size">remote_max_message_size</a></code>,
<code><a href="proton._endpoints.Link-class.html#remote_rcv_settle_mode">remote_rcv_settle_mode</a></code>,
<code><a href="proton._endpoints.Link-class.html#remote_snd_settle_mode">remote_snd_settle_mode</a></code>,
<code><a href="proton._endpoints.Link-class.html#remote_source">remote_source</a></code>,
<code><a href="proton._endpoints.Link-class.html#remote_target">remote_target</a></code>,
<code><a href="proton._endpoints.Link-class.html#session">session</a></code>,
<code><a href="proton._endpoints.Link-class.html#snd_settle_mode">snd_settle_mode</a></code>,
<code><a href="proton._endpoints.Link-class.html#source">source</a></code>,
<code><a href="proton._endpoints.Link-class.html#state">state</a></code>,
<code><a href="proton._endpoints.Link-class.html#target">target</a></code>,
<code><a href="proton._endpoints.Link-class.html#unsettled">unsettled</a></code>
</p>
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="proton._endpoints.Endpoint-class.html">Endpoint</a></code></b>:
<code><a href="proton._endpoints.Endpoint-class.html#handler">handler</a></code>,
<code><a href="proton._endpoints.Endpoint-class.html#remote_condition">remote_condition</a></code>,
<code><a href="proton._endpoints.Endpoint-class.html#transport">transport</a></code>
</p>
</td>
</tr>
</table>
<!-- ==================== 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>