blob: 5af542c8a4f4a3b340b7664e70b994e3285e01a6 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Proton DotNet: Apache.Qpid.Proton.Engine.Implementation.ProtonSessionIncomingWindow Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Proton DotNet
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceApache.html">Apache</a></li><li class="navelem"><a class="el" href="namespaceApache_1_1Qpid.html">Qpid</a></li><li class="navelem"><a class="el" href="namespaceApache_1_1Qpid_1_1Proton.html">Proton</a></li><li class="navelem"><a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Engine.html">Engine</a></li><li class="navelem"><a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation.html">Implementation</a></li><li class="navelem"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1ProtonSessionIncomingWindow.html">ProtonSessionIncomingWindow</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#properties">Properties</a> &#124;
<a href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1ProtonSessionIncomingWindow-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Apache.Qpid.Proton.Engine.Implementation.ProtonSessionIncomingWindow Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Tracks the incoming window and provides management of that window in relation to receiver links.
<a href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1ProtonSessionIncomingWindow.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:acc81d4e976ad00cc89a0f7d4ebc00319"><td class="memItemLeft" align="right" valign="top"><a id="acc81d4e976ad00cc89a0f7d4ebc00319"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>ProtonSessionIncomingWindow</b> (<a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1ProtonSession.html">ProtonSession</a> session)</td></tr>
<tr class="separator:acc81d4e976ad00cc89a0f7d4ebc00319"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="properties"></a>
Properties</h2></td></tr>
<tr class="memitem:a398e7a7c5ebadd6d604680c067085a91"><td class="memItemLeft" align="right" valign="top"><a id="a398e7a7c5ebadd6d604680c067085a91"></a>
uint&#160;</td><td class="memItemRight" valign="bottom"><b>IncomingCapacity</b><code> [get, set]</code></td></tr>
<tr class="separator:a398e7a7c5ebadd6d604680c067085a91"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a002eaea8e4323d19ada47ec184329ae1"><td class="memItemLeft" align="right" valign="top"><a id="a002eaea8e4323d19ada47ec184329ae1"></a>
uint&#160;</td><td class="memItemRight" valign="bottom"><b>RemainingIncomingCapacity</b><code> [get]</code></td></tr>
<tr class="separator:a002eaea8e4323d19ada47ec184329ae1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac974df439e88df12ca6ba476f4bf1d58"><td class="memItemLeft" align="right" valign="top"><a id="ac974df439e88df12ca6ba476f4bf1d58"></a>
uint&#160;</td><td class="memItemRight" valign="bottom"><b>IncomingBytes</b><code> [get]</code></td></tr>
<tr class="separator:ac974df439e88df12ca6ba476f4bf1d58"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ade0a0246c7a7a5742acb27a9988496eb"><td class="memItemLeft" align="right" valign="top"><a id="ade0a0246c7a7a5742acb27a9988496eb"></a>
uint&#160;</td><td class="memItemRight" valign="bottom"><b>NextIncomingId</b><code> [get]</code></td></tr>
<tr class="separator:ade0a0246c7a7a5742acb27a9988496eb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af7e3e76ed22e2dbb5493904aad203191"><td class="memItemLeft" align="right" valign="top"><a id="af7e3e76ed22e2dbb5493904aad203191"></a>
uint&#160;</td><td class="memItemRight" valign="bottom"><b>IncomingWindow</b><code> [get]</code></td></tr>
<tr class="separator:af7e3e76ed22e2dbb5493904aad203191"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Tracks the incoming window and provides management of that window in relation to receiver links. </p>
<p>The incoming window decreases as Transfer frames arrive and is replenished when the user reads the bytes received in the accumulated payload of a delivery. The window is expanded by sending a Flow frame to the remote with an updated incoming window value at configured intervals based on reads from the pending deliveries.</p>
</div><hr/>The documentation for this class was generated from the following file:<ul>
<li>src/Proton/Engine/Implementation/ProtonSessionIncomingWindow.cs</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</body>
</html>