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_1SaslEnvelope.html
blob: 837eed0bb94994f609e05652281c84f8f439c233 [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.SaslEnvelope 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_1SaslEnvelope.html">SaslEnvelope</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_1SaslEnvelope-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Apache.Qpid.Proton.Engine.SaslEnvelope 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_1SaslEnvelope.html#details">More...</a></p>
<div class="dynheader">
Inheritance diagram for Apache.Qpid.Proton.Engine.SaslEnvelope:</div>
<div class="dyncontent">
<div class="center">
<img src="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1SaslEnvelope.png" usemap="#Apache.Qpid.Proton.Engine.SaslEnvelope_map" alt=""/>
<map id="Apache.Qpid.Proton.Engine.SaslEnvelope_map" name="Apache.Qpid.Proton.Engine.SaslEnvelope_map">
<area href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1PerformativeEnvelope.html" alt="Apache.Qpid.Proton.Engine.PerformativeEnvelope&lt; ISaslPerformative &gt;" shape="rect" coords="0,0,423,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:aff7967c68a97a290ad17855c58b766a5"><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_1SaslEnvelope.html#aff7967c68a97a290ad17855c58b766a5">SaslEnvelope</a> (<a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Types_1_1Security_1_1ISaslPerformative.html">ISaslPerformative</a> performative)</td></tr>
<tr class="memdesc:aff7967c68a97a290ad17855c58b766a5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a new SASL Envelope with the given performative as the body. <a href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1SaslEnvelope.html#aff7967c68a97a290ad17855c58b766a5">More...</a><br /></td></tr>
<tr class="separator:aff7967c68a97a290ad17855c58b766a5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aff1ae489c9d881fee5e043f623592385"><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_1SaslEnvelope.html#aff1ae489c9d881fee5e043f623592385">SaslEnvelope</a> (<a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Types_1_1Security_1_1ISaslPerformative.html">ISaslPerformative</a> performative, <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Buffer_1_1IProtonBuffer.html">IProtonBuffer</a> payload)</td></tr>
<tr class="memdesc:aff1ae489c9d881fee5e043f623592385"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a new SASL Envelope with the given performative as the body and the given proton buffer as the payload. <a href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1SaslEnvelope.html#aff1ae489c9d881fee5e043f623592385">More...</a><br /></td></tr>
<tr class="separator:aff1ae489c9d881fee5e043f623592385"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a21d310366b6244a0c965d45674b44392"><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_1SaslEnvelope.html#a21d310366b6244a0c965d45674b44392">Invoke&lt; T &gt;</a> (<a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Types_1_1Security_1_1ISaslPerformativeHandler.html">ISaslPerformativeHandler</a>&lt; T &gt; handler, T context)</td></tr>
<tr class="memdesc:a21d310366b6244a0c965d45674b44392"><td class="mdescLeft">&#160;</td><td class="mdescRight">Invoke the correct event point in the SASL performative handler based on the type of SASL performative carried in the body and pass along the provided context object to the handler. <a href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1SaslEnvelope.html#a21d310366b6244a0c965d45674b44392">More...</a><br /></td></tr>
<tr class="separator:a21d310366b6244a0c965d45674b44392"><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:a758cfe98025982b6c039e62adb3d5ddb"><td class="memItemLeft" align="right" valign="top"><a id="a758cfe98025982b6c039e62adb3d5ddb"></a>
static readonly byte&#160;</td><td class="memItemRight" valign="bottom"><b>SaslFrameType</b> = 1</td></tr>
<tr class="separator:a758cfe98025982b6c039e62adb3d5ddb"><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; ISaslPerformative &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">Constructor &amp; Destructor Documentation</h2>
<a id="aff7967c68a97a290ad17855c58b766a5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aff7967c68a97a290ad17855c58b766a5">&#9670;&nbsp;</a></span>SaslEnvelope() <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">Apache.Qpid.Proton.Engine.SaslEnvelope.SaslEnvelope </td>
<td>(</td>
<td class="paramtype"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Types_1_1Security_1_1ISaslPerformative.html">ISaslPerformative</a>&#160;</td>
<td class="paramname"><em>performative</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>Creates a new SASL Envelope with the given performative as the body. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">performative</td><td>The performative to carry</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aff1ae489c9d881fee5e043f623592385"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aff1ae489c9d881fee5e043f623592385">&#9670;&nbsp;</a></span>SaslEnvelope() <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">Apache.Qpid.Proton.Engine.SaslEnvelope.SaslEnvelope </td>
<td>(</td>
<td class="paramtype"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Types_1_1Security_1_1ISaslPerformative.html">ISaslPerformative</a>&#160;</td>
<td class="paramname"><em>performative</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>Creates a new SASL Envelope with the given performative as the body and the given proton buffer as the payload. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">performative</td><td>The performative to carry</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a21d310366b6244a0c965d45674b44392"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a21d310366b6244a0c965d45674b44392">&#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">void Apache.Qpid.Proton.Engine.SaslEnvelope.Invoke&lt; T &gt; </td>
<td>(</td>
<td class="paramtype"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Types_1_1Security_1_1ISaslPerformativeHandler.html">ISaslPerformativeHandler</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> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Invoke the correct event point in the SASL performative handler based on the type of SASL performative carried in the body and pass along the provided context object to the handler. </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>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/Proton/Engine/SaslEnvelope.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>