Google Git
Sign in
apache / qpid-site / refs/heads/asf-site / . / content / releases / qpid-proton-dotnet-1.0.0-M10 / api / interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1ISaslContext.html
blob: 8516301d62deb1b032d570b6aac14a9fe1dd32cb [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.Sasl.ISaslContext Interface 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="namespaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl.html">Sasl</a></li><li class="navelem"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1ISaslContext.html">ISaslContext</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#properties">Properties</a> &#124;
<a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1ISaslContext-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Apache.Qpid.Proton.Engine.Sasl.ISaslContext Interface Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Root context of a SASL authentication API which provides common elements used in both clients and servers.
<a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1ISaslContext.html#details">More...</a></p>
<div class="dynheader">
Inheritance diagram for Apache.Qpid.Proton.Engine.Sasl.ISaslContext:</div>
<div class="dyncontent">
<div class="center">
<img src="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1ISaslContext.png" usemap="#Apache.Qpid.Proton.Engine.Sasl.ISaslContext_map" alt=""/>
<map id="Apache.Qpid.Proton.Engine.Sasl.ISaslContext_map" name="Apache.Qpid.Proton.Engine.Sasl.ISaslContext_map">
<area href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1Sasl_1_1ProtonSaslContext.html" title="Engine handler that manages the SASL authentication process that occurs either on the client or serve..." alt="Apache.Qpid.Proton.Engine.Implementation.Sasl.ProtonSaslContext" shape="rect" coords="220,56,651,80"/>
<area href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1ISaslClientContext.html" title="Root context of a SASL authentication API which provides common elements used in both clients and ser..." alt="Apache.Qpid.Proton.Engine.Sasl.ISaslClientContext" shape="rect" coords="882,56,1313,80"/>
<area href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1ISaslServerContext.html" title="SASL Server operating context used by an Engine that has been configured as a SASL server or that has..." alt="Apache.Qpid.Proton.Engine.Sasl.ISaslServerContext" shape="rect" coords="1323,56,1754,80"/>
<area href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1Sasl_1_1ProtonSaslClientContext.html" title="SASL Context for SASL client instances which handles the client side management of the SASL exchange." alt="Apache.Qpid.Proton.Engine.Implementation.Sasl.ProtonSaslClientContext" shape="rect" coords="0,112,431,136"/>
<area href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1Sasl_1_1ProtonSaslServerContext.html" title="SASL Context for SASL client instances which handles the client side management of the SASL exchange." alt="Apache.Qpid.Proton.Engine.Implementation.Sasl.ProtonSaslServerContext" shape="rect" coords="441,112,872,136"/>
<area href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1Sasl_1_1ProtonSaslClientContext.html" title="SASL Context for SASL client instances which handles the client side management of the SASL exchange." alt="Apache.Qpid.Proton.Engine.Implementation.Sasl.ProtonSaslClientContext" shape="rect" coords="882,112,1313,136"/>
<area href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1Sasl_1_1ProtonSaslServerContext.html" title="SASL Context for SASL client instances which handles the client side management of the SASL exchange." alt="Apache.Qpid.Proton.Engine.Implementation.Sasl.ProtonSaslServerContext" shape="rect" coords="1323,112,1754,136"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="properties"></a>
Properties</h2></td></tr>
<tr class="memitem:a6972d4297705f3d575103188e5fbb11a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl.html#a52f941085984113db91d0318285d9040">SaslContextRole</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1ISaslContext.html#a6972d4297705f3d575103188e5fbb11a">Role</a><code> [get]</code></td></tr>
<tr class="memdesc:a6972d4297705f3d575103188e5fbb11a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the role this context plays either client or server <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1ISaslContext.html#a6972d4297705f3d575103188e5fbb11a">More...</a><br /></td></tr>
<tr class="separator:a6972d4297705f3d575103188e5fbb11a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a75ef27dafac5b8b0728b306433eba0bb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IAttachments.html">IAttachments</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1ISaslContext.html#a75ef27dafac5b8b0728b306433eba0bb">Attachments</a><code> [get]</code></td></tr>
<tr class="memdesc:a75ef27dafac5b8b0728b306433eba0bb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Access to the linked attachments instance where properties can be attached to this context for later application use. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1ISaslContext.html#a75ef27dafac5b8b0728b306433eba0bb">More...</a><br /></td></tr>
<tr class="separator:a75ef27dafac5b8b0728b306433eba0bb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a403e1fdc89fa90668b749a1002a2c96a"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1ISaslContext.html#a403e1fdc89fa90668b749a1002a2c96a">IsDone</a><code> [get]</code></td></tr>
<tr class="memdesc:a403e1fdc89fa90668b749a1002a2c96a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks if SASL authentication has completed and an outcome is available. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1ISaslContext.html#a403e1fdc89fa90668b749a1002a2c96a">More...</a><br /></td></tr>
<tr class="separator:a403e1fdc89fa90668b749a1002a2c96a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af8e4ee537c294a75f46070616f542a9b"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1ISaslContext.html#af8e4ee537c294a75f46070616f542a9b">IsServer</a><code> [get]</code></td></tr>
<tr class="memdesc:af8e4ee537c294a75f46070616f542a9b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Provides a quick check for this context being a server context <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1ISaslContext.html#af8e4ee537c294a75f46070616f542a9b">More...</a><br /></td></tr>
<tr class="separator:af8e4ee537c294a75f46070616f542a9b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2ecbba6508822305643bb1c267d73418"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1ISaslContext.html#a2ecbba6508822305643bb1c267d73418">IsClient</a><code> [get]</code></td></tr>
<tr class="memdesc:a2ecbba6508822305643bb1c267d73418"><td class="mdescLeft">&#160;</td><td class="mdescRight">Provides a quick check for this context being a server context <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1ISaslContext.html#a2ecbba6508822305643bb1c267d73418">More...</a><br /></td></tr>
<tr class="separator:a2ecbba6508822305643bb1c267d73418"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a19c2730e84df0a9c407043256cfbae87"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl.html#a007ac2ee5719c195cd362bfa2aec1b3a">SaslAuthOutcome</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1ISaslContext.html#a19c2730e84df0a9c407043256cfbae87">Outcome</a><code> [get]</code></td></tr>
<tr class="memdesc:a19c2730e84df0a9c407043256cfbae87"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the outcome of the SASL authentication process. If the SASL exchange is ongoing or the SASL layer was skipped because a particular engine configuration allows such behavior then this method should return null to indicate no SASL outcome is available. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1ISaslContext.html#a19c2730e84df0a9c407043256cfbae87">More...</a><br /></td></tr>
<tr class="separator:a19c2730e84df0a9c407043256cfbae87"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a32e0f2ca8ae8112a5ff7fef29823aa3a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Engine.html#ae14090a56ba2b8dc9b9bdccb6c5fdfb5">EngineSaslState</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1ISaslContext.html#a32e0f2ca8ae8112a5ff7fef29823aa3a">State</a><code> [get]</code></td></tr>
<tr class="memdesc:a32e0f2ca8ae8112a5ff7fef29823aa3a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a state enum that indicates the current operating state of the SASL negotiation process or conversely if no SASL layer is configured this method should return the no-SASL state. This method must never return a null result. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1ISaslContext.html#a32e0f2ca8ae8112a5ff7fef29823aa3a">More...</a><br /></td></tr>
<tr class="separator:a32e0f2ca8ae8112a5ff7fef29823aa3a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a11538259185fc4d7a5b3231ee5f41acd"><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="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1ISaslContext.html#a11538259185fc4d7a5b3231ee5f41acd">ServerMechanisms</a><code> [get]</code></td></tr>
<tr class="memdesc:a11538259185fc4d7a5b3231ee5f41acd"><td class="mdescLeft">&#160;</td><td class="mdescRight">After the server has sent its supported mechanisms this method will return a copy of that list for review by the server event handler. If called before the server has sent the mechanisms list this method will return null. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1ISaslContext.html#a11538259185fc4d7a5b3231ee5f41acd">More...</a><br /></td></tr>
<tr class="separator:a11538259185fc4d7a5b3231ee5f41acd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a84ffa464643531a99cbe8b93fe7e52a5"><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="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1ISaslContext.html#a84ffa464643531a99cbe8b93fe7e52a5">ChosenMechanism</a><code> [get]</code></td></tr>
<tr class="memdesc:a84ffa464643531a99cbe8b93fe7e52a5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the mechanism that was sent to the server to select the SASL mechanism to use for negotiations. If called before the client has sent its chosen mechanism this method returns null. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1ISaslContext.html#a84ffa464643531a99cbe8b93fe7e52a5">More...</a><br /></td></tr>
<tr class="separator:a84ffa464643531a99cbe8b93fe7e52a5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6c7a8f0228fe0de0aacf0ac55acf8e28"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1ISaslContext.html#a6c7a8f0228fe0de0aacf0ac55acf8e28">Hostname</a><code> [get]</code></td></tr>
<tr class="memdesc:a6c7a8f0228fe0de0aacf0ac55acf8e28"><td class="mdescLeft">&#160;</td><td class="mdescRight">The DNS name of the host (either fully qualified or relative) that was sent to the server which define the host the sending peer is connecting to. If called before the client sent the host name information to the server this method returns null. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1ISaslContext.html#a6c7a8f0228fe0de0aacf0ac55acf8e28">More...</a><br /></td></tr>
<tr class="separator:a6c7a8f0228fe0de0aacf0ac55acf8e28"><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>Root context of a SASL authentication API which provides common elements used in both clients and servers. </p>
</div><h2 class="groupheader">Property Documentation</h2>
<a id="a75ef27dafac5b8b0728b306433eba0bb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a75ef27dafac5b8b0728b306433eba0bb">&#9670;&nbsp;</a></span>Attachments</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_1Engine_1_1IAttachments.html">IAttachments</a> Apache.Qpid.Proton.Engine.Sasl.ISaslContext.Attachments</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 to the linked attachments instance where properties can be attached to this context for later application use. </p>
</div>
</div>
<a id="a84ffa464643531a99cbe8b93fe7e52a5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a84ffa464643531a99cbe8b93fe7e52a5">&#9670;&nbsp;</a></span>ChosenMechanism</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.Engine.Sasl.ISaslContext.ChosenMechanism</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>Returns the mechanism that was sent to the server to select the SASL mechanism to use for negotiations. If called before the client has sent its chosen mechanism this method returns null. </p>
</div>
</div>
<a id="a6c7a8f0228fe0de0aacf0ac55acf8e28"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6c7a8f0228fe0de0aacf0ac55acf8e28">&#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.Engine.Sasl.ISaslContext.Hostname</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>The DNS name of the host (either fully qualified or relative) that was sent to the server which define the host the sending peer is connecting to. If called before the client sent the host name information to the server this method returns null. </p>
</div>
</div>
<a id="a2ecbba6508822305643bb1c267d73418"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2ecbba6508822305643bb1c267d73418">&#9670;&nbsp;</a></span>IsClient</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool Apache.Qpid.Proton.Engine.Sasl.ISaslContext.IsClient</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 a quick check for this context being a server context </p>
</div>
</div>
<a id="a403e1fdc89fa90668b749a1002a2c96a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a403e1fdc89fa90668b749a1002a2c96a">&#9670;&nbsp;</a></span>IsDone</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool Apache.Qpid.Proton.Engine.Sasl.ISaslContext.IsDone</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>Checks if SASL authentication has completed and an outcome is available. </p>
</div>
</div>
<a id="af8e4ee537c294a75f46070616f542a9b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af8e4ee537c294a75f46070616f542a9b">&#9670;&nbsp;</a></span>IsServer</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool Apache.Qpid.Proton.Engine.Sasl.ISaslContext.IsServer</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 a quick check for this context being a server context </p>
</div>
</div>
<a id="a19c2730e84df0a9c407043256cfbae87"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a19c2730e84df0a9c407043256cfbae87">&#9670;&nbsp;</a></span>Outcome</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="namespaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl.html#a007ac2ee5719c195cd362bfa2aec1b3a">SaslAuthOutcome</a> Apache.Qpid.Proton.Engine.Sasl.ISaslContext.Outcome</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>Gets the outcome of the SASL authentication process. If the SASL exchange is ongoing or the SASL layer was skipped because a particular engine configuration allows such behavior then this method should return null to indicate no SASL outcome is available. </p>
</div>
</div>
<a id="a6972d4297705f3d575103188e5fbb11a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6972d4297705f3d575103188e5fbb11a">&#9670;&nbsp;</a></span>Role</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="namespaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl.html#a52f941085984113db91d0318285d9040">SaslContextRole</a> Apache.Qpid.Proton.Engine.Sasl.ISaslContext.Role</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>Returns the role this context plays either client or server </p>
</div>
</div>
<a id="a11538259185fc4d7a5b3231ee5f41acd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a11538259185fc4d7a5b3231ee5f41acd">&#9670;&nbsp;</a></span>ServerMechanisms</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.Engine.Sasl.ISaslContext.ServerMechanisms</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>After the server has sent its supported mechanisms this method will return a copy of that list for review by the server event handler. If called before the server has sent the mechanisms list this method will return null. </p>
</div>
</div>
<a id="a32e0f2ca8ae8112a5ff7fef29823aa3a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a32e0f2ca8ae8112a5ff7fef29823aa3a">&#9670;&nbsp;</a></span>State</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="namespaceApache_1_1Qpid_1_1Proton_1_1Engine.html#ae14090a56ba2b8dc9b9bdccb6c5fdfb5">EngineSaslState</a> Apache.Qpid.Proton.Engine.Sasl.ISaslContext.State</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>Returns a state enum that indicates the current operating state of the SASL negotiation process or conversely if no SASL layer is configured this method should return the no-SASL state. This method must never return a null result. </p>
</div>
</div>
<hr/>The documentation for this interface was generated from the following file:<ul>
<li>src/Proton/Engine/Sasl/ISaslContext.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>