blob: 735f010288a95032d09957d8f5cf08b6e7e6ef33 [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.PerformativeEnvelope&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_1PerformativeEnvelope.html">PerformativeEnvelope</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#properties">Properties</a> &#124;
<a href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1PerformativeEnvelope-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Apache.Qpid.Proton.Engine.PerformativeEnvelope&lt; T &gt; Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Base class for envelope types that travel through the engine.
<a href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1PerformativeEnvelope.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="properties"></a>
Properties</h2></td></tr>
<tr class="memitem:a56026db76bf2290d2b2d5b9281d56ccd"><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"><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"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa7420f97ca9c333d87451c7ad6bd74d3"><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"><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"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af560f525b9a00bb129588fe4dd814026"><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"><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"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adf339e64029ab5d83dd26a67d7e3ad26"><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"><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"><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>Base class for envelope types that travel through the engine. </p>
</div><h2 class="groupheader">Property Documentation</h2>
<a id="a56026db76bf2290d2b2d5b9281d56ccd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a56026db76bf2290d2b2d5b9281d56ccd">&#9670;&nbsp;</a></span>Body</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_1PerformativeEnvelope.html">Apache.Qpid.Proton.Engine.PerformativeEnvelope</a>&lt; T &gt;.Body</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>Access the performative that is the body of this envelope. </p>
</div>
</div>
<a id="aa7420f97ca9c333d87451c7ad6bd74d3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa7420f97ca9c333d87451c7ad6bd74d3">&#9670;&nbsp;</a></span>Channel</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ushort <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1PerformativeEnvelope.html">Apache.Qpid.Proton.Engine.PerformativeEnvelope</a>&lt; T &gt;.Channel</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>Access the channel on which the performative was received. </p>
</div>
</div>
<a id="adf339e64029ab5d83dd26a67d7e3ad26"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adf339e64029ab5d83dd26a67d7e3ad26">&#9670;&nbsp;</a></span>FrameType</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">byte <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1PerformativeEnvelope.html">Apache.Qpid.Proton.Engine.PerformativeEnvelope</a>&lt; T &gt;.FrameType</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>Provides the frame type that defines what types of performatives can be received. </p>
</div>
</div>
<a id="af560f525b9a00bb129588fe4dd814026"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af560f525b9a00bb129588fe4dd814026">&#9670;&nbsp;</a></span>Payload</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="interfaceApache_1_1Qpid_1_1Proton_1_1Buffer_1_1IProtonBuffer.html">IProtonBuffer</a> <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1PerformativeEnvelope.html">Apache.Qpid.Proton.Engine.PerformativeEnvelope</a>&lt; T &gt;.Payload</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>Access the payload bytes that arrived with the performative. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/Proton/Engine/PerformativeEnvelope.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>