blob: 269c09458726eb85c77d7c2dd7afd4e395c3bbd3 [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.SaslException 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="namespaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl.html">Sasl</a></li><li class="navelem"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1SaslException.html">SaslException</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1SaslException-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Apache.Qpid.Proton.Engine.Sasl.SaslException Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Base exception type for exceptions encountered during SASL authentication.
<a href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1SaslException.html#details">More...</a></p>
<div class="dynheader">
Inheritance diagram for Apache.Qpid.Proton.Engine.Sasl.SaslException:</div>
<div class="dyncontent">
<div class="center">
<img src="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1SaslException.png" usemap="#Apache.Qpid.Proton.Engine.Sasl.SaslException_map" alt=""/>
<map id="Apache.Qpid.Proton.Engine.Sasl.SaslException_map" name="Apache.Qpid.Proton.Engine.Sasl.SaslException_map">
<area href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1AuthenticationException.html" title="Indicates the remote failed the Authentication of the client." alt="Apache.Qpid.Proton.Engine.Sasl.AuthenticationException" shape="rect" coords="0,112,375,136"/>
<area href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1MechanismMismatchException.html" title="Base exception type for exceptions encountered during SASL authentication." alt="Apache.Qpid.Proton.Engine.Sasl.MechanismMismatchException" shape="rect" coords="385,112,760,136"/>
<area href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1SaslSystemException.html" title="Indicates that a SASL handshake has failed with a &#39;sys&quot;, &#39;sys-perm&#39;, or &#39;sys-temp&#39; outcome code as de..." alt="Apache.Qpid.Proton.Engine.Sasl.SaslSystemException" shape="rect" coords="770,112,1145,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:a5e634b97ac46fb547f5a2be8e9f90db1"><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_1Sasl_1_1SaslException.html#a5e634b97ac46fb547f5a2be8e9f90db1">SaslException</a> ()</td></tr>
<tr class="memdesc:a5e634b97ac46fb547f5a2be8e9f90db1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a default version of this exception type. <a href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1SaslException.html#a5e634b97ac46fb547f5a2be8e9f90db1">More...</a><br /></td></tr>
<tr class="separator:a5e634b97ac46fb547f5a2be8e9f90db1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac8b5f3109cf7ee2815f5d79f48643445"><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_1Sasl_1_1SaslException.html#ac8b5f3109cf7ee2815f5d79f48643445">SaslException</a> (string message)</td></tr>
<tr class="memdesc:ac8b5f3109cf7ee2815f5d79f48643445"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a new instance with the given message that describes the specifics of the error. <a href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1SaslException.html#ac8b5f3109cf7ee2815f5d79f48643445">More...</a><br /></td></tr>
<tr class="separator:ac8b5f3109cf7ee2815f5d79f48643445"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a190dcf29cabcfe601f42de3044457342"><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_1Sasl_1_1SaslException.html#a190dcf29cabcfe601f42de3044457342">SaslException</a> (string message, Exception cause)</td></tr>
<tr class="memdesc:a190dcf29cabcfe601f42de3044457342"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a new instance with the given message that describes the specifics of the error. <a href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1SaslException.html#a190dcf29cabcfe601f42de3044457342">More...</a><br /></td></tr>
<tr class="separator:a190dcf29cabcfe601f42de3044457342"><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 exception type for exceptions encountered during SASL authentication. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a5e634b97ac46fb547f5a2be8e9f90db1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5e634b97ac46fb547f5a2be8e9f90db1">&#9670;&nbsp;</a></span>SaslException() <span class="overload">[1/3]</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.Sasl.SaslException.SaslException </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>Creates a default version of this exception type. </p>
</div>
</div>
<a id="ac8b5f3109cf7ee2815f5d79f48643445"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac8b5f3109cf7ee2815f5d79f48643445">&#9670;&nbsp;</a></span>SaslException() <span class="overload">[2/3]</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.Sasl.SaslException.SaslException </td>
<td>(</td>
<td class="paramtype">string&#160;</td>
<td class="paramname"><em>message</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>Create a new instance with the given message that describes the specifics of the error. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">message</td><td>Description of the error</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a190dcf29cabcfe601f42de3044457342"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a190dcf29cabcfe601f42de3044457342">&#9670;&nbsp;</a></span>SaslException() <span class="overload">[3/3]</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.Sasl.SaslException.SaslException </td>
<td>(</td>
<td class="paramtype">string&#160;</td>
<td class="paramname"><em>message</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Exception&#160;</td>
<td class="paramname"><em>cause</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>Create a new instance with the given message that describes the specifics of the error. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">message</td><td>Description of the error</td></tr>
<tr><td class="paramname">cause</td><td>The exception that causes this error</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/Proton/Engine/Sasl/SaslException.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>