Google Git
Sign in
apache / qpid-site / refs/heads/asf-site / . / input / releases / qpid-proton-dotnet-1.0.0-M10 / api / classApache_1_1Qpid_1_1Proton_1_1Engine_1_1IncomingAmqpEnvelope.html
blob: 5c5032b92e03038e7491f2873daa05aba19a4233 [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.IncomingAmqpEnvelope 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="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1IncomingAmqpEnvelope.html">IncomingAmqpEnvelope</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-attribs">Static Public Attributes</a> &#124;
<a href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1IncomingAmqpEnvelope-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Apache.Qpid.Proton.Engine.IncomingAmqpEnvelope 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_1IncomingAmqpEnvelope.html#details">More...</a></p>
<div class="dynheader">
Inheritance diagram for Apache.Qpid.Proton.Engine.IncomingAmqpEnvelope:</div>
<div class="dyncontent">
<div class="center">
<img src="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1IncomingAmqpEnvelope.png" usemap="#Apache.Qpid.Proton.Engine.IncomingAmqpEnvelope_map" alt=""/>
<map id="Apache.Qpid.Proton.Engine.IncomingAmqpEnvelope_map" name="Apache.Qpid.Proton.Engine.IncomingAmqpEnvelope_map">
<area href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1PerformativeEnvelope.html" alt="Apache.Qpid.Proton.Engine.PerformativeEnvelope&lt; IPerformative &gt;" shape="rect" coords="0,0,399,24"/>
<area href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1EmptyEnvelope.html" title="An empty incoming AMQP envelope that is used for signalling that an empty AMQP frame was read." alt="Apache.Qpid.Proton.Engine.EmptyEnvelope" shape="rect" coords="0,112,399,136"/>
</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:a527a7e021ecfc850f0aaed57b0df0b61"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1IncomingAmqpEnvelope.html#a527a7e021ecfc850f0aaed57b0df0b61">Release</a> ()</td></tr>
<tr class="memdesc:a527a7e021ecfc850f0aaed57b0df0b61"><td class="mdescLeft">&#160;</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_1IncomingAmqpEnvelope.html#a527a7e021ecfc850f0aaed57b0df0b61">More...</a><br /></td></tr>
<tr class="separator:a527a7e021ecfc850f0aaed57b0df0b61"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8581efc55755288ccc6ee29b5a9b549c"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1IncomingAmqpEnvelope.html#a8581efc55755288ccc6ee29b5a9b549c">Invoke&lt; T &gt;</a> (<a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Types_1_1Transport_1_1IPerformativeHandler.html">IPerformativeHandler</a>&lt; T &gt; handler, T context)</td></tr>
<tr class="memdesc:a8581efc55755288ccc6ee29b5a9b549c"><td class="mdescLeft">&#160;</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_1IncomingAmqpEnvelope.html#a8581efc55755288ccc6ee29b5a9b549c">More...</a><br /></td></tr>
<tr class="separator:a8581efc55755288ccc6ee29b5a9b549c"><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:aac76c9ed8c4cd19fc7829cd0f0ffed2c"><td class="memItemLeft" align="right" valign="top"><a id="aac76c9ed8c4cd19fc7829cd0f0ffed2c"></a>
static readonly byte&#160;</td><td class="memItemRight" valign="bottom"><b>AmqpFrameType</b> = 0</td></tr>
<tr class="separator:aac76c9ed8c4cd19fc7829cd0f0ffed2c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></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="-"/>&#160;Properties inherited from <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1PerformativeEnvelope.html">Apache.Qpid.Proton.Engine.PerformativeEnvelope&lt; IPerformative &gt;</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&#160;</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">&#160;</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">&#160;</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&#160;</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">&#160;</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">&#160;</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>&#160;</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">&#160;</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">&#160;</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&#160;</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">&#160;</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">&#160;</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="a8581efc55755288ccc6ee29b5a9b549c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8581efc55755288ccc6ee29b5a9b549c">&#9670;&nbsp;</a></span>Invoke&lt; T &gt;()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void Apache.Qpid.Proton.Engine.IncomingAmqpEnvelope.Invoke&lt; T &gt; </td>
<td>(</td>
<td class="paramtype"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Types_1_1Transport_1_1IPerformativeHandler.html">IPerformativeHandler</a>&lt; T &gt;&#160;</td>
<td class="paramname"><em>handler</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T&#160;</td>
<td class="paramname"><em>context</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 class="mlabel">virtual</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>
<p>Reimplemented in <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1EmptyEnvelope.html#aa9f31b078f24085035c3e86dc05e1b7d">Apache.Qpid.Proton.Engine.EmptyEnvelope</a>.</p>
</div>
</div>
<a id="a527a7e021ecfc850f0aaed57b0df0b61"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a527a7e021ecfc850f0aaed57b0df0b61">&#9670;&nbsp;</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.IncomingAmqpEnvelope.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>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/Proton/Engine/IncomingAmqpEnvelope.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>