Google Git
Sign in
apache / qpid-site / 272c6d73993dde755108dc4a2bb13407463f8bbf / . / input / releases / qpid-proton-dotnet-1.0.0-M7 / api / classApache_1_1Qpid_1_1Proton_1_1Types_1_1Security_1_1SaslInit.html
blob: bf9b073a8f945fcdd5c9796ddb25d7568450fbf4 [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.Types.Security.SaslInit 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_1Types.html">Types</a></li><li class="navelem"><a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Types_1_1Security.html">Security</a></li><li class="navelem"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Types_1_1Security_1_1SaslInit.html">SaslInit</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="#properties">Properties</a> &#124;
<a href="classApache_1_1Qpid_1_1Proton_1_1Types_1_1Security_1_1SaslInit-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Apache.Qpid.Proton.Types.Security.SaslInit Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Inheritance diagram for Apache.Qpid.Proton.Types.Security.SaslInit:</div>
<div class="dyncontent">
<div class="center">
<img src="classApache_1_1Qpid_1_1Proton_1_1Types_1_1Security_1_1SaslInit.png" usemap="#Apache.Qpid.Proton.Types.Security.SaslInit_map" alt=""/>
<map id="Apache.Qpid.Proton.Types.Security.SaslInit_map" name="Apache.Qpid.Proton.Types.Security.SaslInit_map">
<area href="interfaceApache_1_1Qpid_1_1Proton_1_1Types_1_1Security_1_1ISaslPerformative.html" alt="Apache.Qpid.Proton.Types.Security.ISaslPerformative" shape="rect" coords="0,56,320,80"/>
</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:afc3a17f455ac3593111c409018f43434"><td class="memItemLeft" align="right" valign="top"><a id="afc3a17f455ac3593111c409018f43434"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>SaslInit</b> (<a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Types_1_1Symbol.html">Symbol</a> mechanism, <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Buffer_1_1IProtonBuffer.html">IProtonBuffer</a> initialResponse, string hostname)</td></tr>
<tr class="separator:afc3a17f455ac3593111c409018f43434"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a50d4d5487fadf8ee8834841ead572a5d"><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_1Types_1_1Security_1_1SaslInit.html#a50d4d5487fadf8ee8834841ead572a5d">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:a50d4d5487fadf8ee8834841ead572a5d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Invokes the appropriate handler method for the type where this method was called. Provides a context object type that is passed to aid in the event processing. <a href="classApache_1_1Qpid_1_1Proton_1_1Types_1_1Security_1_1SaslInit.html#a50d4d5487fadf8ee8834841ead572a5d">More...</a><br /></td></tr>
<tr class="separator:a50d4d5487fadf8ee8834841ead572a5d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a76ead5d8ef4bb7750b326307b5f85b1c"><td class="memItemLeft" align="right" valign="top"><a id="a76ead5d8ef4bb7750b326307b5f85b1c"></a>
object&#160;</td><td class="memItemRight" valign="bottom"><b>Clone</b> ()</td></tr>
<tr class="separator:a76ead5d8ef4bb7750b326307b5f85b1c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af8cf0e66d2b58b6a7cd24bbea6a11a13"><td class="memItemLeft" align="right" valign="top"><a id="af8cf0e66d2b58b6a7cd24bbea6a11a13"></a>
<a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Types_1_1Security_1_1SaslInit.html">SaslInit</a>&#160;</td><td class="memItemRight" valign="bottom"><b>Copy</b> ()</td></tr>
<tr class="separator:af8cf0e66d2b58b6a7cd24bbea6a11a13"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a82646e44f6f4a7a3384903714f496376"><td class="memItemLeft" align="right" valign="top"><a id="a82646e44f6f4a7a3384903714f496376"></a>
override string&#160;</td><td class="memItemRight" valign="bottom"><b>ToString</b> ()</td></tr>
<tr class="separator:a82646e44f6f4a7a3384903714f496376"><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:adc3a4deaf5076fb8d452414aff987612"><td class="memItemLeft" align="right" valign="top"><a id="adc3a4deaf5076fb8d452414aff987612"></a>
static readonly ulong&#160;</td><td class="memItemRight" valign="bottom"><b>DescriptorCode</b> = 0x0000000000000041UL</td></tr>
<tr class="separator:adc3a4deaf5076fb8d452414aff987612"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a18e273e84042aaa95bc79d9ccfb3db0e"><td class="memItemLeft" align="right" valign="top"><a id="a18e273e84042aaa95bc79d9ccfb3db0e"></a>
static readonly <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Types_1_1Symbol.html">Symbol</a>&#160;</td><td class="memItemRight" valign="bottom"><b>DescriptorSymbol</b> = <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Types_1_1Symbol.html#a9d67d0bc768260bc01c0f0f789d8a490">Symbol.Lookup</a>(&quot;amqp:sasl-init:list&quot;)</td></tr>
<tr class="separator:a18e273e84042aaa95bc79d9ccfb3db0e"><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:a3b161748ba5babe72cca452c41635850"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Types_1_1Symbol.html">Symbol</a>??&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Types_1_1Security_1_1SaslInit.html#a3b161748ba5babe72cca452c41635850">Mechanism</a><code> [get, set]</code></td></tr>
<tr class="memdesc:a3b161748ba5babe72cca452c41635850"><td class="mdescLeft">&#160;</td><td class="mdescRight">The SASL mechanism that the remote has selected to use for the authentication <a href="classApache_1_1Qpid_1_1Proton_1_1Types_1_1Security_1_1SaslInit.html#a3b161748ba5babe72cca452c41635850">More...</a><br /></td></tr>
<tr class="separator:a3b161748ba5babe72cca452c41635850"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4a4fdc64277dbf8e8425d2b8836947f5"><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_1Types_1_1Security_1_1SaslInit.html#a4a4fdc64277dbf8e8425d2b8836947f5">InitialResponse</a><code> [get, set]</code></td></tr>
<tr class="memdesc:a4a4fdc64277dbf8e8425d2b8836947f5"><td class="mdescLeft">&#160;</td><td class="mdescRight">The initial response value for use in the authentication exchange <a href="classApache_1_1Qpid_1_1Proton_1_1Types_1_1Security_1_1SaslInit.html#a4a4fdc64277dbf8e8425d2b8836947f5">More...</a><br /></td></tr>
<tr class="separator:a4a4fdc64277dbf8e8425d2b8836947f5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1cf9093b620a71d64fe028f3a06f8cfc"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Types_1_1Security_1_1SaslInit.html#a1cf9093b620a71d64fe028f3a06f8cfc">Hostname</a><code> [get, set]</code></td></tr>
<tr class="memdesc:a1cf9093b620a71d64fe028f3a06f8cfc"><td class="mdescLeft">&#160;</td><td class="mdescRight">The hostname value for use in the authentication exchange <a href="classApache_1_1Qpid_1_1Proton_1_1Types_1_1Security_1_1SaslInit.html#a1cf9093b620a71d64fe028f3a06f8cfc">More...</a><br /></td></tr>
<tr class="separator:a1cf9093b620a71d64fe028f3a06f8cfc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa12041c60414e1023662132ffb0febb6"><td class="memItemLeft" align="right" valign="top"><a id="aa12041c60414e1023662132ffb0febb6"></a>
<a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Types_1_1Security.html#aa2e0e8d18ce054d86eac9be7c2162dc0">SaslPerformativeType</a>&#160;</td><td class="memItemRight" valign="bottom"><b>Type</b><code> [get]</code></td></tr>
<tr class="separator:aa12041c60414e1023662132ffb0febb6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header properties_interfaceApache_1_1Qpid_1_1Proton_1_1Types_1_1Security_1_1ISaslPerformative"><td colspan="2" onclick="javascript:toggleInherit('properties_interfaceApache_1_1Qpid_1_1Proton_1_1Types_1_1Security_1_1ISaslPerformative')"><img src="closed.png" alt="-"/>&#160;Properties inherited from <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Types_1_1Security_1_1ISaslPerformative.html">Apache.Qpid.Proton.Types.Security.ISaslPerformative</a></td></tr>
<tr class="memitem:ad1eec9653e86178677483808e6317b09 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Types_1_1Security_1_1ISaslPerformative"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Types_1_1Security.html#aa2e0e8d18ce054d86eac9be7c2162dc0">SaslPerformativeType</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Types_1_1Security_1_1ISaslPerformative.html#ad1eec9653e86178677483808e6317b09">Type</a><code> [get]</code></td></tr>
<tr class="memdesc:ad1eec9653e86178677483808e6317b09 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Types_1_1Security_1_1ISaslPerformative"><td class="mdescLeft">&#160;</td><td class="mdescRight">Provides the enumeration value that identifies this type. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Types_1_1Security_1_1ISaslPerformative.html#ad1eec9653e86178677483808e6317b09">More...</a><br /></td></tr>
<tr class="separator:ad1eec9653e86178677483808e6317b09 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Types_1_1Security_1_1ISaslPerformative"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a50d4d5487fadf8ee8834841ead572a5d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a50d4d5487fadf8ee8834841ead572a5d">&#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.Types.Security.SaslInit.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>Invokes the appropriate handler method for the type where this method was called. Provides a context object type that is passed to aid in the event processing. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">T</td><td>context type to provide to the event handler</td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">handler</td><td>The SASL performative handler to invoke</td></tr>
<tr><td class="paramname">context</td><td>The context object to provide to the handler</td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Types_1_1Security_1_1ISaslPerformative.html#ae73a6bfcd13482446b047b4856731f20">Apache.Qpid.Proton.Types.Security.ISaslPerformative</a>.</p>
</div>
</div>
<h2 class="groupheader">Property Documentation</h2>
<a id="a1cf9093b620a71d64fe028f3a06f8cfc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1cf9093b620a71d64fe028f3a06f8cfc">&#9670;&nbsp;</a></span>Hostname</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">string Apache.Qpid.Proton.Types.Security.SaslInit.Hostname</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The hostname value for use in the authentication exchange </p>
</div>
</div>
<a id="a4a4fdc64277dbf8e8425d2b8836947f5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4a4fdc64277dbf8e8425d2b8836947f5">&#9670;&nbsp;</a></span>InitialResponse</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> Apache.Qpid.Proton.Types.Security.SaslInit.InitialResponse</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The initial response value for use in the authentication exchange </p>
</div>
</div>
<a id="a3b161748ba5babe72cca452c41635850"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3b161748ba5babe72cca452c41635850">&#9670;&nbsp;</a></span>Mechanism</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_1Types_1_1Symbol.html">Symbol</a>?? Apache.Qpid.Proton.Types.Security.SaslInit.Mechanism</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The SASL mechanism that the remote has selected to use for the authentication </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/Proton/Types/Security/SaslInit.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>