blob: c4aba586e213c97fff96c086c06ea1b634feb5bf [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.8.20"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Qpid Proton C++ API: sasl</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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.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>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function() { init_search(); });
/* @license-end */
</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">Qpid Proton C++ API
&#160;<span id="projectnumber">0.32.0</span>
</div>
</td>
<td> <div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.svg"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.20 -->
<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');
/* @license-end */
</script>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('classproton_1_1sasl.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- 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 class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classproton_1_1sasl-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">sasl</div> </div>
</div><!--header-->
<div class="contents">
<p>SASL information.
<a href="classproton_1_1sasl.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="sasl_8hpp_source.html">sasl.hpp</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:af47997198e7e7301a1cd8602c7f02acd"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1sasl.html#af47997198e7e7301a1cd8602c7f02acd">outcome</a> { <br />
&#160;&#160;<a class="el" href="classproton_1_1sasl.html#af47997198e7e7301a1cd8602c7f02acdac157bdf0b85a40d2619cbc8bc1ae5fe2">NONE</a>,
<a class="el" href="classproton_1_1sasl.html#af47997198e7e7301a1cd8602c7f02acda2bc49ec37d6a5715dd23e85f1ff5bb59">OK</a>,
<a class="el" href="classproton_1_1sasl.html#af47997198e7e7301a1cd8602c7f02acda8b22fbb60fcbd7a4a5e1e6ff6ee38218">AUTH</a>,
<a class="el" href="classproton_1_1sasl.html#af47997198e7e7301a1cd8602c7f02acda69a8d053cf3b5b28fa0c7dde6f883e10">SYS</a>,
<br />
&#160;&#160;<a class="el" href="classproton_1_1sasl.html#af47997198e7e7301a1cd8602c7f02acdae0a57d717d9f8c8fdba757be1b0afdcf">PERM</a>,
<a class="el" href="classproton_1_1sasl.html#af47997198e7e7301a1cd8602c7f02acda5937389a60030a604f0efdf5e3927325">TEMP</a>
<br />
}</td></tr>
<tr class="memdesc:af47997198e7e7301a1cd8602c7f02acd"><td class="mdescLeft">&#160;</td><td class="mdescRight">The result of the SASL negotiation. <a href="classproton_1_1sasl.html#af47997198e7e7301a1cd8602c7f02acd">More...</a><br /></td></tr>
<tr class="separator:af47997198e7e7301a1cd8602c7f02acd"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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:aee5a4997bbfa58f1b8176f936618de00"><td class="memItemLeft" align="right" valign="top"><a id="aee5a4997bbfa58f1b8176f936618de00"></a>
enum <a class="el" href="classproton_1_1sasl.html#af47997198e7e7301a1cd8602c7f02acd">outcome</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1sasl.html#aee5a4997bbfa58f1b8176f936618de00">outcome</a> () const</td></tr>
<tr class="memdesc:aee5a4997bbfa58f1b8176f936618de00"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the outcome. <br /></td></tr>
<tr class="separator:aee5a4997bbfa58f1b8176f936618de00"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9444df7d81bd265e0a8e1726fd12b058"><td class="memItemLeft" align="right" valign="top"><a id="a9444df7d81bd265e0a8e1726fd12b058"></a>
std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1sasl.html#a9444df7d81bd265e0a8e1726fd12b058">user</a> () const</td></tr>
<tr class="memdesc:a9444df7d81bd265e0a8e1726fd12b058"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the user name. <br /></td></tr>
<tr class="separator:a9444df7d81bd265e0a8e1726fd12b058"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae4d8c99395936130ece8495be232b9c2"><td class="memItemLeft" align="right" valign="top"><a id="ae4d8c99395936130ece8495be232b9c2"></a>
std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1sasl.html#ae4d8c99395936130ece8495be232b9c2">mech</a> () const</td></tr>
<tr class="memdesc:ae4d8c99395936130ece8495be232b9c2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the mechanism. <br /></td></tr>
<tr class="separator:ae4d8c99395936130ece8495be232b9c2"><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>SASL information. </p>
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a id="af47997198e7e7301a1cd8602c7f02acd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af47997198e7e7301a1cd8602c7f02acd">&#9670;&nbsp;</a></span>outcome</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classproton_1_1sasl.html#af47997198e7e7301a1cd8602c7f02acd">outcome</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>The result of the SASL negotiation. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="af47997198e7e7301a1cd8602c7f02acdac157bdf0b85a40d2619cbc8bc1ae5fe2"></a>NONE&#160;</td><td class="fielddoc"><p>Negotiation not completed. </p>
</td></tr>
<tr><td class="fieldname"><a id="af47997198e7e7301a1cd8602c7f02acda2bc49ec37d6a5715dd23e85f1ff5bb59"></a>OK&#160;</td><td class="fielddoc"><p>Authentication succeeded. </p>
</td></tr>
<tr><td class="fieldname"><a id="af47997198e7e7301a1cd8602c7f02acda8b22fbb60fcbd7a4a5e1e6ff6ee38218"></a>AUTH&#160;</td><td class="fielddoc"><p>Failed due to bad credentials. </p>
</td></tr>
<tr><td class="fieldname"><a id="af47997198e7e7301a1cd8602c7f02acda69a8d053cf3b5b28fa0c7dde6f883e10"></a>SYS&#160;</td><td class="fielddoc"><p>Failed due to a system error. </p>
</td></tr>
<tr><td class="fieldname"><a id="af47997198e7e7301a1cd8602c7f02acdae0a57d717d9f8c8fdba757be1b0afdcf"></a>PERM&#160;</td><td class="fielddoc"><p>Failed due to unrecoverable error. </p>
</td></tr>
<tr><td class="fieldname"><a id="af47997198e7e7301a1cd8602c7f02acda5937389a60030a604f0efdf5e3927325"></a>TEMP&#160;</td><td class="fielddoc"><p>Failed due to transient error. </p>
</td></tr>
</table>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>proton/<a class="el" href="sasl_8hpp_source.html">sasl.hpp</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="namespaceproton.html">proton</a></li><li class="navelem"><a class="el" href="classproton_1_1sasl.html">sasl</a></li>
<li class="footer">Generated by <a href="http://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.8.20 </li>
</ul>
</div>
</body>
</html>