| <!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.OutgoingAmqpEnvelope 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&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&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_1OutgoingAmqpEnvelope.html">OutgoingAmqpEnvelope</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#pub-static-attribs">Static Public Attributes</a> | |
| <a href="#properties">Properties</a> | |
| <a href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1OutgoingAmqpEnvelope-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">Apache.Qpid.Proton.Engine.OutgoingAmqpEnvelope Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Frame object that carries an AMQP Performative. |
| <a href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1OutgoingAmqpEnvelope.html#details">More...</a></p> |
| <div class="dynheader"> |
| Inheritance diagram for Apache.Qpid.Proton.Engine.OutgoingAmqpEnvelope:</div> |
| <div class="dyncontent"> |
| <div class="center"> |
| <img src="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1OutgoingAmqpEnvelope.png" usemap="#Apache.Qpid.Proton.Engine.OutgoingAmqpEnvelope_map" alt=""/> |
| <map id="Apache.Qpid.Proton.Engine.OutgoingAmqpEnvelope_map" name="Apache.Qpid.Proton.Engine.OutgoingAmqpEnvelope_map"> |
| <area href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1PerformativeEnvelope.html" alt="Apache.Qpid.Proton.Engine.PerformativeEnvelope< IPerformative >" shape="rect" coords="0,0,399,24"/> |
| </map> |
| </div></div> |
| <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:afaddfce1bd80f3a07f635320324ac04a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1OutgoingAmqpEnvelope.html#afaddfce1bd80f3a07f635320324ac04a">Release</a> ()</td></tr> |
| <tr class="memdesc:afaddfce1bd80f3a07f635320324ac04a"><td class="mdescLeft"> </td><td class="mdescRight">Used to release a Frame that was taken from a Frame pool in order to make it available for the next input operations. Once called the contents of the Frame are invalid and cannot be used again inside the same context. <a href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1OutgoingAmqpEnvelope.html#afaddfce1bd80f3a07f635320324ac04a">More...</a><br /></td></tr> |
| <tr class="separator:afaddfce1bd80f3a07f635320324ac04a"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa92dfb825c8226189e6d03652c4a23fa"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1OutgoingAmqpEnvelope.html">OutgoingAmqpEnvelope</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1OutgoingAmqpEnvelope.html#aa92dfb825c8226189e6d03652c4a23fa">HandlePayloadToLarge</a> ()</td></tr> |
| <tr class="memdesc:aa92dfb825c8226189e6d03652c4a23fa"><td class="mdescLeft"> </td><td class="mdescRight">Called when the encoder determines that the encoding of the Performative plus any payload value is to large for a single AMQP frame. The configured handler should update the performative in preparation for encoding as a split framed AMQP transfer. <a href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1OutgoingAmqpEnvelope.html#aa92dfb825c8226189e6d03652c4a23fa">More...</a><br /></td></tr> |
| <tr class="separator:aa92dfb825c8226189e6d03652c4a23fa"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a81f3b05706f65ad7912b5ef857d7115e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1OutgoingAmqpEnvelope.html">OutgoingAmqpEnvelope</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1OutgoingAmqpEnvelope.html#a81f3b05706f65ad7912b5ef857d7115e">HandleOutgoingFrameWriteComplete</a> ()</td></tr> |
| <tr class="memdesc:a81f3b05706f65ad7912b5ef857d7115e"><td class="mdescLeft"> </td><td class="mdescRight">Called by the encoder when the write of a frame that comprises the transfer of the AMQP performative plus any assigned payload has completed. If the transfer comprises multiple frame writes this handler should be invoked as each frame is successfully written by the IO layer. <a href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1OutgoingAmqpEnvelope.html#a81f3b05706f65ad7912b5ef857d7115e">More...</a><br /></td></tr> |
| <tr class="separator:a81f3b05706f65ad7912b5ef857d7115e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a5b7d6110cf258c939cfb194915c4b07e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1OutgoingAmqpEnvelope.html#a5b7d6110cf258c939cfb194915c4b07e">Invoke< T ></a> (<a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Types_1_1Transport_1_1IPerformativeHandler.html">IPerformativeHandler</a>< T > handler, T context)</td></tr> |
| <tr class="memdesc:a5b7d6110cf258c939cfb194915c4b07e"><td class="mdescLeft"> </td><td class="mdescRight">Invoke the correct performative handler event based on the body of this AMQP performative. <a href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1OutgoingAmqpEnvelope.html#a5b7d6110cf258c939cfb194915c4b07e">More...</a><br /></td></tr> |
| <tr class="separator:a5b7d6110cf258c939cfb194915c4b07e"><td class="memSeparator" colspan="2"> </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:aeb59e07a49eec2f4a93dfc39049ab3c1"><td class="memItemLeft" align="right" valign="top"><a id="aeb59e07a49eec2f4a93dfc39049ab3c1"></a> |
| static readonly byte </td><td class="memItemRight" valign="bottom"><b>AmqpFrameType</b> = 0</td></tr> |
| <tr class="separator:aeb59e07a49eec2f4a93dfc39049ab3c1"><td class="memSeparator" colspan="2"> </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:a55580b219a4bae5bfb70878d68f140f5"><td class="memItemLeft" align="right" valign="top">Action< <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Types_1_1Transport_1_1IPerformative.html">IPerformative</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1OutgoingAmqpEnvelope.html#a55580b219a4bae5bfb70878d68f140f5">PayloadToLargeHandler</a><code> [set]</code></td></tr> |
| <tr class="memdesc:a55580b219a4bae5bfb70878d68f140f5"><td class="mdescLeft"> </td><td class="mdescRight">Configures a handler to be invoked if the payload that is being transmitted with this performative is to large to allow encoding the frame within the maximum configured AMQP frame size limit. <a href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1OutgoingAmqpEnvelope.html#a55580b219a4bae5bfb70878d68f140f5">More...</a><br /></td></tr> |
| <tr class="separator:a55580b219a4bae5bfb70878d68f140f5"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab342241c269a29fe9e2ffc64abc85414"><td class="memItemLeft" align="right" valign="top">Action </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1OutgoingAmqpEnvelope.html#ab342241c269a29fe9e2ffc64abc85414">FrameWriteCompletionHandler</a><code> [set]</code></td></tr> |
| <tr class="memdesc:ab342241c269a29fe9e2ffc64abc85414"><td class="mdescLeft"> </td><td class="mdescRight">Configures a handler to be invoked when a write operation that was handed off to the I/O layer has completed indicated that a single frame portion of the payload has been fully written. <a href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1OutgoingAmqpEnvelope.html#ab342241c269a29fe9e2ffc64abc85414">More...</a><br /></td></tr> |
| <tr class="separator:ab342241c269a29fe9e2ffc64abc85414"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header properties_classApache_1_1Qpid_1_1Proton_1_1Engine_1_1PerformativeEnvelope"><td colspan="2" onclick="javascript:toggleInherit('properties_classApache_1_1Qpid_1_1Proton_1_1Engine_1_1PerformativeEnvelope')"><img src="closed.png" alt="-"/> Properties inherited from <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1PerformativeEnvelope.html">Apache.Qpid.Proton.Engine.PerformativeEnvelope< IPerformative ></a></td></tr> |
| <tr class="memitem:a56026db76bf2290d2b2d5b9281d56ccd inherit properties_classApache_1_1Qpid_1_1Proton_1_1Engine_1_1PerformativeEnvelope"><td class="memItemLeft" align="right" valign="top">T </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1PerformativeEnvelope.html#a56026db76bf2290d2b2d5b9281d56ccd">Body</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a56026db76bf2290d2b2d5b9281d56ccd inherit properties_classApache_1_1Qpid_1_1Proton_1_1Engine_1_1PerformativeEnvelope"><td class="mdescLeft"> </td><td class="mdescRight">Access the performative that is the body of this envelope. <a href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1PerformativeEnvelope.html#a56026db76bf2290d2b2d5b9281d56ccd">More...</a><br /></td></tr> |
| <tr class="separator:a56026db76bf2290d2b2d5b9281d56ccd inherit properties_classApache_1_1Qpid_1_1Proton_1_1Engine_1_1PerformativeEnvelope"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa7420f97ca9c333d87451c7ad6bd74d3 inherit properties_classApache_1_1Qpid_1_1Proton_1_1Engine_1_1PerformativeEnvelope"><td class="memItemLeft" align="right" valign="top">ushort </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1PerformativeEnvelope.html#aa7420f97ca9c333d87451c7ad6bd74d3">Channel</a><code> [get]</code></td></tr> |
| <tr class="memdesc:aa7420f97ca9c333d87451c7ad6bd74d3 inherit properties_classApache_1_1Qpid_1_1Proton_1_1Engine_1_1PerformativeEnvelope"><td class="mdescLeft"> </td><td class="mdescRight">Access the channel on which the performative was received. <a href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1PerformativeEnvelope.html#aa7420f97ca9c333d87451c7ad6bd74d3">More...</a><br /></td></tr> |
| <tr class="separator:aa7420f97ca9c333d87451c7ad6bd74d3 inherit properties_classApache_1_1Qpid_1_1Proton_1_1Engine_1_1PerformativeEnvelope"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af560f525b9a00bb129588fe4dd814026 inherit properties_classApache_1_1Qpid_1_1Proton_1_1Engine_1_1PerformativeEnvelope"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Buffer_1_1IProtonBuffer.html">IProtonBuffer</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1PerformativeEnvelope.html#af560f525b9a00bb129588fe4dd814026">Payload</a><code> [get]</code></td></tr> |
| <tr class="memdesc:af560f525b9a00bb129588fe4dd814026 inherit properties_classApache_1_1Qpid_1_1Proton_1_1Engine_1_1PerformativeEnvelope"><td class="mdescLeft"> </td><td class="mdescRight">Access the payload bytes that arrived with the performative. <a href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1PerformativeEnvelope.html#af560f525b9a00bb129588fe4dd814026">More...</a><br /></td></tr> |
| <tr class="separator:af560f525b9a00bb129588fe4dd814026 inherit properties_classApache_1_1Qpid_1_1Proton_1_1Engine_1_1PerformativeEnvelope"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:adf339e64029ab5d83dd26a67d7e3ad26 inherit properties_classApache_1_1Qpid_1_1Proton_1_1Engine_1_1PerformativeEnvelope"><td class="memItemLeft" align="right" valign="top">byte </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1PerformativeEnvelope.html#adf339e64029ab5d83dd26a67d7e3ad26">FrameType</a><code> [get]</code></td></tr> |
| <tr class="memdesc:adf339e64029ab5d83dd26a67d7e3ad26 inherit properties_classApache_1_1Qpid_1_1Proton_1_1Engine_1_1PerformativeEnvelope"><td class="mdescLeft"> </td><td class="mdescRight">Provides the frame type that defines what types of performatives can be received. <a href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1PerformativeEnvelope.html#adf339e64029ab5d83dd26a67d7e3ad26">More...</a><br /></td></tr> |
| <tr class="separator:adf339e64029ab5d83dd26a67d7e3ad26 inherit properties_classApache_1_1Qpid_1_1Proton_1_1Engine_1_1PerformativeEnvelope"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Frame object that carries an AMQP Performative. </p> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a81f3b05706f65ad7912b5ef857d7115e"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a81f3b05706f65ad7912b5ef857d7115e">◆ </a></span>HandleOutgoingFrameWriteComplete()</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_1OutgoingAmqpEnvelope.html">OutgoingAmqpEnvelope</a> Apache.Qpid.Proton.Engine.OutgoingAmqpEnvelope.HandleOutgoingFrameWriteComplete </td> |
| <td>(</td> |
| <td class="paramname"></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>Called by the encoder when the write of a frame that comprises the transfer of the AMQP performative plus any assigned payload has completed. If the transfer comprises multiple frame writes this handler should be invoked as each frame is successfully written by the IO layer. </p> |
| <dl class="section return"><dt>Returns</dt><dd>This outgoing performative envelope instance.</dd></dl> |
| |
| </div> |
| </div> |
| <a id="aa92dfb825c8226189e6d03652c4a23fa"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aa92dfb825c8226189e6d03652c4a23fa">◆ </a></span>HandlePayloadToLarge()</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_1OutgoingAmqpEnvelope.html">OutgoingAmqpEnvelope</a> Apache.Qpid.Proton.Engine.OutgoingAmqpEnvelope.HandlePayloadToLarge </td> |
| <td>(</td> |
| <td class="paramname"></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>Called when the encoder determines that the encoding of the Performative plus any payload value is to large for a single AMQP frame. The configured handler should update the performative in preparation for encoding as a split framed AMQP transfer. </p> |
| <dl class="section return"><dt>Returns</dt><dd>This outgoing performative envelope instance.</dd></dl> |
| |
| </div> |
| </div> |
| <a id="a5b7d6110cf258c939cfb194915c4b07e"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a5b7d6110cf258c939cfb194915c4b07e">◆ </a></span>Invoke< T >()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void Apache.Qpid.Proton.Engine.OutgoingAmqpEnvelope.Invoke< T > </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Types_1_1Transport_1_1IPerformativeHandler.html">IPerformativeHandler</a>< T > </td> |
| <td class="paramname"><em>handler</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">T </td> |
| <td class="paramname"><em>context</em> </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>Invoke the correct performative handler event based on the body of this AMQP performative. </p> |
| <dl class="tparams"><dt>Template Parameters</dt><dd> |
| <table class="tparams"> |
| <tr><td class="paramname">T</td><td>The type of context that will be provided to the invocation</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">handler</td><td>The handle to invoke an event on.</td></tr> |
| <tr><td class="paramname">context</td><td>The context to pass to the event invocation</td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="afaddfce1bd80f3a07f635320324ac04a"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#afaddfce1bd80f3a07f635320324ac04a">◆ </a></span>Release()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void Apache.Qpid.Proton.Engine.OutgoingAmqpEnvelope.Release </td> |
| <td>(</td> |
| <td class="paramname"></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>Used to release a Frame that was taken from a Frame pool in order to make it available for the next input operations. Once called the contents of the Frame are invalid and cannot be used again inside the same context. </p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Property Documentation</h2> |
| <a id="ab342241c269a29fe9e2ffc64abc85414"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ab342241c269a29fe9e2ffc64abc85414">◆ </a></span>FrameWriteCompletionHandler</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Action Apache.Qpid.Proton.Engine.OutgoingAmqpEnvelope.FrameWriteCompletionHandler</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">set</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Configures a handler to be invoked when a write operation that was handed off to the I/O layer has completed indicated that a single frame portion of the payload has been fully written. </p> |
| |
| </div> |
| </div> |
| <a id="a55580b219a4bae5bfb70878d68f140f5"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a55580b219a4bae5bfb70878d68f140f5">◆ </a></span>PayloadToLargeHandler</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Action<<a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Types_1_1Transport_1_1IPerformative.html">IPerformative</a>> Apache.Qpid.Proton.Engine.OutgoingAmqpEnvelope.PayloadToLargeHandler</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">set</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Configures a handler to be invoked if the payload that is being transmitted with this performative is to large to allow encoding the frame within the maximum configured AMQP frame size limit. </p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>src/Proton/Engine/OutgoingAmqpEnvelope.cs</li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated by <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> |
