Google Git
Sign in
apache / qpid-site / refs/heads/asf-site / . / content / releases / qpid-proton-dotnet-1.0.0-M10 / api / classApache_1_1Qpid_1_1Proton_1_1Engine_1_1AmqpPerformativeEnvelopePool.html
blob: 0c467546308842eff99e6c3c3dfde7c7b084a574 [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.AmqpPerformativeEnvelopePool&lt; T &gt; Class Template 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="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1AmqpPerformativeEnvelopePool.html">AmqpPerformativeEnvelopePool</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#pub-static-attribs">Static Public Attributes</a> &#124;
<a href="#properties">Properties</a> &#124;
<a href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1AmqpPerformativeEnvelopePool-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Apache.Qpid.Proton.Engine.AmqpPerformativeEnvelopePool&lt; T &gt; Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<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:a895cff3a677ff82d1b63d561c6da6da0"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1AmqpPerformativeEnvelopePool.html#a895cff3a677ff82d1b63d561c6da6da0">AmqpPerformativeEnvelopePool</a> (Func&lt; <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1AmqpPerformativeEnvelopePool.html">AmqpPerformativeEnvelopePool</a>&lt; T &gt;, T &gt; envelopeBuilder)</td></tr>
<tr class="memdesc:a895cff3a677ff82d1b63d561c6da6da0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a new envelope pool using the default pool size. <a href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1AmqpPerformativeEnvelopePool.html#a895cff3a677ff82d1b63d561c6da6da0">More...</a><br /></td></tr>
<tr class="separator:a895cff3a677ff82d1b63d561c6da6da0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3d44d7e429c21732d72d8af3c0dfa878"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1AmqpPerformativeEnvelopePool.html#a3d44d7e429c21732d72d8af3c0dfa878">AmqpPerformativeEnvelopePool</a> (Func&lt; <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1AmqpPerformativeEnvelopePool.html">AmqpPerformativeEnvelopePool</a>&lt; T &gt;, T &gt; envelopeBuilder, int maxPoolSize)</td></tr>
<tr class="memdesc:a3d44d7e429c21732d72d8af3c0dfa878"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a new envelope pool using the given pool size. <a href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1AmqpPerformativeEnvelopePool.html#a3d44d7e429c21732d72d8af3c0dfa878">More...</a><br /></td></tr>
<tr class="separator:a3d44d7e429c21732d72d8af3c0dfa878"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a647b58813644dbeae39070106b0e2c4e"><td class="memItemLeft" align="right" valign="top">T&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1AmqpPerformativeEnvelopePool.html#a647b58813644dbeae39070106b0e2c4e">Take</a> (<a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Types_1_1Transport_1_1IPerformative.html">IPerformative</a> body, ushort channel, <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Buffer_1_1IProtonBuffer.html">IProtonBuffer</a> payload)</td></tr>
<tr class="memdesc:a647b58813644dbeae39070106b0e2c4e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Request to borrow a pooled object or create a new non-pooled instance if no pooled values are available. <a href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1AmqpPerformativeEnvelopePool.html#a647b58813644dbeae39070106b0e2c4e">More...</a><br /></td></tr>
<tr class="separator:a647b58813644dbeae39070106b0e2c4e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:aba2c1ee2a75d724cff6f0d89cdde909a"><td class="memItemLeft" align="right" valign="top"><a id="aba2c1ee2a75d724cff6f0d89cdde909a"></a>
static <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1AmqpPerformativeEnvelopePool.html">AmqpPerformativeEnvelopePool</a>&lt; <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1IncomingAmqpEnvelope.html">IncomingAmqpEnvelope</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>IncomingEnvelopePool</b> (int maxPoolSize)</td></tr>
<tr class="separator:aba2c1ee2a75d724cff6f0d89cdde909a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2228ad6828d1e9074f7df2ae5a820429"><td class="memItemLeft" align="right" valign="top"><a id="a2228ad6828d1e9074f7df2ae5a820429"></a>
static <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1AmqpPerformativeEnvelopePool.html">AmqpPerformativeEnvelopePool</a>&lt; <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1IncomingAmqpEnvelope.html">IncomingAmqpEnvelope</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>IncomingEnvelopePool</b> ()</td></tr>
<tr class="separator:a2228ad6828d1e9074f7df2ae5a820429"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a73ccf5eb0d2d62817051cef58250b9f3"><td class="memItemLeft" align="right" valign="top"><a id="a73ccf5eb0d2d62817051cef58250b9f3"></a>
static <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1AmqpPerformativeEnvelopePool.html">AmqpPerformativeEnvelopePool</a>&lt; <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1OutgoingAmqpEnvelope.html">OutgoingAmqpEnvelope</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>OutgoingEnvelopePool</b> (int maxPoolSize)</td></tr>
<tr class="separator:a73ccf5eb0d2d62817051cef58250b9f3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a34afbb7fa99cbaff61724a2b337873a2"><td class="memItemLeft" align="right" valign="top"><a id="a34afbb7fa99cbaff61724a2b337873a2"></a>
static <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1AmqpPerformativeEnvelopePool.html">AmqpPerformativeEnvelopePool</a>&lt; <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1OutgoingAmqpEnvelope.html">OutgoingAmqpEnvelope</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>OutgoingEnvelopePool</b> ()</td></tr>
<tr class="separator:a34afbb7fa99cbaff61724a2b337873a2"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr class="memitem:a58a9c67f694a1d9fc98c5295f681bcfa"><td class="memItemLeft" align="right" valign="top">static readonly int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1AmqpPerformativeEnvelopePool.html#a58a9c67f694a1d9fc98c5295f681bcfa">DEFAULT_MAX_POOL_SIZE</a> = 10</td></tr>
<tr class="memdesc:a58a9c67f694a1d9fc98c5295f681bcfa"><td class="mdescLeft">&#160;</td><td class="mdescRight">The default maximum pool size to use if not otherwise configured. <a href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1AmqpPerformativeEnvelopePool.html#a58a9c67f694a1d9fc98c5295f681bcfa">More...</a><br /></td></tr>
<tr class="separator:a58a9c67f694a1d9fc98c5295f681bcfa"><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:a366e414dfd295ed22857f486435460c4"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1AmqpPerformativeEnvelopePool.html#a366e414dfd295ed22857f486435460c4">MaxPoolSize</a><code> [get]</code></td></tr>
<tr class="memdesc:a366e414dfd295ed22857f486435460c4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the configured maximum pool size which indicates how many elements can be pooled before new non-pooled values are created when a request arrives but all the current elements are on loan. <a href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1AmqpPerformativeEnvelopePool.html#a366e414dfd295ed22857f486435460c4">More...</a><br /></td></tr>
<tr class="separator:a366e414dfd295ed22857f486435460c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a895cff3a677ff82d1b63d561c6da6da0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a895cff3a677ff82d1b63d561c6da6da0">&#9670;&nbsp;</a></span>AmqpPerformativeEnvelopePool() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1AmqpPerformativeEnvelopePool.html">Apache.Qpid.Proton.Engine.AmqpPerformativeEnvelopePool</a>&lt; T &gt;.<a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1AmqpPerformativeEnvelopePool.html">AmqpPerformativeEnvelopePool</a> </td>
<td>(</td>
<td class="paramtype">Func&lt; <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1AmqpPerformativeEnvelopePool.html">AmqpPerformativeEnvelopePool</a>&lt; T &gt;, T &gt;&#160;</td>
<td class="paramname"><em>envelopeBuilder</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a new envelope pool using the default pool size. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">envelopeBuilder</td><td>A function that can build the envelopes</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a3d44d7e429c21732d72d8af3c0dfa878"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3d44d7e429c21732d72d8af3c0dfa878">&#9670;&nbsp;</a></span>AmqpPerformativeEnvelopePool() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1AmqpPerformativeEnvelopePool.html">Apache.Qpid.Proton.Engine.AmqpPerformativeEnvelopePool</a>&lt; T &gt;.<a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1AmqpPerformativeEnvelopePool.html">AmqpPerformativeEnvelopePool</a> </td>
<td>(</td>
<td class="paramtype">Func&lt; <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1AmqpPerformativeEnvelopePool.html">AmqpPerformativeEnvelopePool</a>&lt; T &gt;, T &gt;&#160;</td>
<td class="paramname"><em>envelopeBuilder</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>maxPoolSize</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a new envelope pool using the given pool size. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">envelopeBuilder</td><td>A function that can build the envelopes</td></tr>
<tr><td class="paramname">maxPoolSize</td><td>The maximum number of entries in the pool</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a647b58813644dbeae39070106b0e2c4e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a647b58813644dbeae39070106b0e2c4e">&#9670;&nbsp;</a></span>Take()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">T <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1AmqpPerformativeEnvelopePool.html">Apache.Qpid.Proton.Engine.AmqpPerformativeEnvelopePool</a>&lt; T &gt;.Take </td>
<td>(</td>
<td class="paramtype"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Types_1_1Transport_1_1IPerformative.html">IPerformative</a>&#160;</td>
<td class="paramname"><em>body</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">ushort&#160;</td>
<td class="paramname"><em>channel</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Buffer_1_1IProtonBuffer.html">IProtonBuffer</a>&#160;</td>
<td class="paramname"><em>payload</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Request to borrow a pooled object or create a new non-pooled instance if no pooled values are available. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">body</td><td></td></tr>
<tr><td class="paramname">channel</td><td></td></tr>
<tr><td class="paramname">payload</td><td></td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd></dd></dl>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a58a9c67f694a1d9fc98c5295f681bcfa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a58a9c67f694a1d9fc98c5295f681bcfa">&#9670;&nbsp;</a></span>DEFAULT_MAX_POOL_SIZE</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">readonly int <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1AmqpPerformativeEnvelopePool.html">Apache.Qpid.Proton.Engine.AmqpPerformativeEnvelopePool</a>&lt; T &gt;.DEFAULT_MAX_POOL_SIZE = 10</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The default maximum pool size to use if not otherwise configured. </p>
</div>
</div>
<h2 class="groupheader">Property Documentation</h2>
<a id="a366e414dfd295ed22857f486435460c4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a366e414dfd295ed22857f486435460c4">&#9670;&nbsp;</a></span>MaxPoolSize</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1AmqpPerformativeEnvelopePool.html">Apache.Qpid.Proton.Engine.AmqpPerformativeEnvelopePool</a>&lt; T &gt;.MaxPoolSize</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the configured maximum pool size which indicates how many elements can be pooled before new non-pooled values are created when a request arrives but all the current elements are on loan. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/Proton/Engine/AmqpPerformativeEnvelopePool.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>