| <!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: proton/sasl.hpp Source File</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&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 |
|  <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&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&dn=gpl-2.0.txt GPL-v2 */ |
| $(document).ready(function(){initNavTree('sasl_8hpp_source.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="headertitle"> |
| <div class="title">sasl.hpp</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <a href="sasl_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="preprocessor">#ifndef PROTON_SASL_HPP</span></div> |
| <div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define PROTON_SASL_HPP</span></div> |
| <div class="line"><a name="l00003"></a><span class="lineno"> 3</span>  </div> |
| <div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">/*</span></div> |
| <div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> *</span></div> |
| <div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * Licensed to the Apache Software Foundation (ASF) under one</span></div> |
| <div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * or more contributor license agreements. See the NOTICE file</span></div> |
| <div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * distributed with this work for additional information</span></div> |
| <div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * regarding copyright ownership. The ASF licenses this file</span></div> |
| <div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * to you under the Apache License, Version 2.0 (the</span></div> |
| <div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * "License"); you may not use this file except in compliance</span></div> |
| <div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * with the License. You may obtain a copy of the License at</span></div> |
| <div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> *</span></div> |
| <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div> |
| <div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> *</span></div> |
| <div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * Unless required by applicable law or agreed to in writing,</span></div> |
| <div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * software distributed under the License is distributed on an</span></div> |
| <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span></div> |
| <div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * KIND, either express or implied. See the License for the</span></div> |
| <div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * specific language governing permissions and limitations</span></div> |
| <div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> * under the License.</span></div> |
| <div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> *</span></div> |
| <div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> */</span></div> |
| <div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  </div> |
| <div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include "./internal/export.hpp"</span></div> |
| <div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include "./internal/config.hpp"</span></div> |
| <div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include "./internal/object.hpp"</span></div> |
| <div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  </div> |
| <div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#include <proton/sasl.h></span></div> |
| <div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  </div> |
| <div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#include <string></span></div> |
| <div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  </div> |
| <div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  </div> |
| <div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="keyword">namespace </span><a class="code" href="namespaceproton.html">proton</a> {</div> |
| <div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  </div> |
| <div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="classproton_1_1sasl.html"> 39</a></span> <span class="keyword">class </span><a class="code" href="classproton_1_1sasl.html">sasl</a> {</div> |
| <div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <a class="code" href="classproton_1_1sasl.html">sasl</a>(pn_sasl_t* s) : object_(s) {}</div> |
| <div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  </div> |
| <div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="preprocessor">#if PN_CPP_HAS_DELETED_FUNCTIONS</span></div> |
| <div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="classproton_1_1sasl.html#aee5a4997bbfa58f1b8176f936618de00"> 45</a></span>  <a class="code" href="classproton_1_1sasl.html">sasl</a>() = <span class="keyword">delete</span>;</div> |
| <div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="preprocessor">#else</span></div> |
| <div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <a class="code" href="classproton_1_1sasl.html">sasl</a>();</div> |
| <div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="preprocessor">#endif</span></div> |
| <div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  </div> |
| <div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="keyword">public</span>:</div> |
| <div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="classproton_1_1sasl.html#af47997198e7e7301a1cd8602c7f02acd"> 52</a></span>  <span class="keyword">enum</span> <a class="code" href="classproton_1_1sasl.html#af47997198e7e7301a1cd8602c7f02acd">outcome</a> {</div> |
| <div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="classproton_1_1sasl.html#af47997198e7e7301a1cd8602c7f02acdac157bdf0b85a40d2619cbc8bc1ae5fe2"> 53</a></span>  <a class="code" href="classproton_1_1sasl.html#af47997198e7e7301a1cd8602c7f02acdac157bdf0b85a40d2619cbc8bc1ae5fe2">NONE</a> = PN_SASL_NONE, </div> |
| <div class="line"><a name="l00054"></a><span class="lineno"><a class="line" href="classproton_1_1sasl.html#af47997198e7e7301a1cd8602c7f02acda2bc49ec37d6a5715dd23e85f1ff5bb59"> 54</a></span>  <a class="code" href="classproton_1_1sasl.html#af47997198e7e7301a1cd8602c7f02acda2bc49ec37d6a5715dd23e85f1ff5bb59">OK</a> = PN_SASL_OK, </div> |
| <div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="classproton_1_1sasl.html#af47997198e7e7301a1cd8602c7f02acda8b22fbb60fcbd7a4a5e1e6ff6ee38218"> 55</a></span>  <a class="code" href="classproton_1_1sasl.html#af47997198e7e7301a1cd8602c7f02acda8b22fbb60fcbd7a4a5e1e6ff6ee38218">AUTH</a> = PN_SASL_AUTH, </div> |
| <div class="line"><a name="l00056"></a><span class="lineno"><a class="line" href="classproton_1_1sasl.html#af47997198e7e7301a1cd8602c7f02acda69a8d053cf3b5b28fa0c7dde6f883e10"> 56</a></span>  <a class="code" href="classproton_1_1sasl.html#af47997198e7e7301a1cd8602c7f02acda69a8d053cf3b5b28fa0c7dde6f883e10">SYS</a> = PN_SASL_SYS, </div> |
| <div class="line"><a name="l00057"></a><span class="lineno"><a class="line" href="classproton_1_1sasl.html#af47997198e7e7301a1cd8602c7f02acdae0a57d717d9f8c8fdba757be1b0afdcf"> 57</a></span>  <a class="code" href="classproton_1_1sasl.html#af47997198e7e7301a1cd8602c7f02acdae0a57d717d9f8c8fdba757be1b0afdcf">PERM</a> = PN_SASL_PERM, </div> |
| <div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <a class="code" href="classproton_1_1sasl.html#af47997198e7e7301a1cd8602c7f02acda5937389a60030a604f0efdf5e3927325">TEMP</a> = PN_SASL_TEMP </div> |
| <div class="line"><a name="l00059"></a><span class="lineno"><a class="line" href="classproton_1_1sasl.html#af47997198e7e7301a1cd8602c7f02acda5937389a60030a604f0efdf5e3927325"> 59</a></span>  };</div> |
| <div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  </div> |
| <div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  PN_CPP_EXTERN <span class="keyword">enum</span> <a class="code" href="classproton_1_1sasl.html#af47997198e7e7301a1cd8602c7f02acd">outcome</a> <a class="code" href="classproton_1_1sasl.html#af47997198e7e7301a1cd8602c7f02acd">outcome</a>() <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  </div> |
| <div class="line"><a name="l00065"></a><span class="lineno"><a class="line" href="classproton_1_1sasl.html#a9444df7d81bd265e0a8e1726fd12b058"> 65</a></span>  PN_CPP_EXTERN std::string <a class="code" href="classproton_1_1sasl.html#a9444df7d81bd265e0a8e1726fd12b058">user</a>() <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  </div> |
| <div class="line"><a name="l00068"></a><span class="lineno"><a class="line" href="classproton_1_1sasl.html#ae4d8c99395936130ece8495be232b9c2"> 68</a></span>  PN_CPP_EXTERN std::string <a class="code" href="classproton_1_1sasl.html#ae4d8c99395936130ece8495be232b9c2">mech</a>() <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  </div> |
| <div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="keyword">private</span>:</div> |
| <div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  pn_sasl_t* <span class="keyword">const</span> object_;</div> |
| <div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  </div> |
| <div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classproton_1_1transport.html">transport</a>;</div> |
| <div class="line"><a name="l00076"></a><span class="lineno"> 76</span> };</div> |
| <div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  </div> |
| <div class="line"><a name="l00078"></a><span class="lineno"> 78</span> } <span class="comment">// proton</span></div> |
| <div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  </div> |
| <div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="preprocessor">#endif // PROTON_SASL_HPP</span></div> |
| </div><!-- fragment --></div><!-- contents --> |
| </div><!-- doc-content --> |
| <div class="ttc" id="aclassproton_1_1sasl_html_ae4d8c99395936130ece8495be232b9c2"><div class="ttname"><a href="classproton_1_1sasl.html#ae4d8c99395936130ece8495be232b9c2">proton::sasl::mech</a></div><div class="ttdeci">std::string mech() const</div><div class="ttdoc">Get the mechanism.</div></div> |
| <div class="ttc" id="aclassproton_1_1sasl_html_a9444df7d81bd265e0a8e1726fd12b058"><div class="ttname"><a href="classproton_1_1sasl.html#a9444df7d81bd265e0a8e1726fd12b058">proton::sasl::user</a></div><div class="ttdeci">std::string user() const</div><div class="ttdoc">Get the user name.</div></div> |
| <div class="ttc" id="aclassproton_1_1sasl_html_af47997198e7e7301a1cd8602c7f02acda5937389a60030a604f0efdf5e3927325"><div class="ttname"><a href="classproton_1_1sasl.html#af47997198e7e7301a1cd8602c7f02acda5937389a60030a604f0efdf5e3927325">proton::sasl::TEMP</a></div><div class="ttdeci">@ TEMP</div><div class="ttdoc">Failed due to transient error.</div><div class="ttdef"><b>Definition:</b> sasl.hpp:58</div></div> |
| <div class="ttc" id="aclassproton_1_1sasl_html_af47997198e7e7301a1cd8602c7f02acdac157bdf0b85a40d2619cbc8bc1ae5fe2"><div class="ttname"><a href="classproton_1_1sasl.html#af47997198e7e7301a1cd8602c7f02acdac157bdf0b85a40d2619cbc8bc1ae5fe2">proton::sasl::NONE</a></div><div class="ttdeci">@ NONE</div><div class="ttdoc">Negotiation not completed.</div><div class="ttdef"><b>Definition:</b> sasl.hpp:53</div></div> |
| <div class="ttc" id="aclassproton_1_1sasl_html_af47997198e7e7301a1cd8602c7f02acda69a8d053cf3b5b28fa0c7dde6f883e10"><div class="ttname"><a href="classproton_1_1sasl.html#af47997198e7e7301a1cd8602c7f02acda69a8d053cf3b5b28fa0c7dde6f883e10">proton::sasl::SYS</a></div><div class="ttdeci">@ SYS</div><div class="ttdoc">Failed due to a system error.</div><div class="ttdef"><b>Definition:</b> sasl.hpp:56</div></div> |
| <div class="ttc" id="aclassproton_1_1sasl_html_af47997198e7e7301a1cd8602c7f02acda8b22fbb60fcbd7a4a5e1e6ff6ee38218"><div class="ttname"><a href="classproton_1_1sasl.html#af47997198e7e7301a1cd8602c7f02acda8b22fbb60fcbd7a4a5e1e6ff6ee38218">proton::sasl::AUTH</a></div><div class="ttdeci">@ AUTH</div><div class="ttdoc">Failed due to bad credentials.</div><div class="ttdef"><b>Definition:</b> sasl.hpp:55</div></div> |
| <div class="ttc" id="aclassproton_1_1sasl_html_af47997198e7e7301a1cd8602c7f02acd"><div class="ttname"><a href="classproton_1_1sasl.html#af47997198e7e7301a1cd8602c7f02acd">proton::sasl::outcome</a></div><div class="ttdeci">outcome</div><div class="ttdoc">The result of the SASL negotiation.</div><div class="ttdef"><b>Definition:</b> sasl.hpp:52</div></div> |
| <div class="ttc" id="aclassproton_1_1transport_html"><div class="ttname"><a href="classproton_1_1transport.html">proton::transport</a></div><div class="ttdoc">A network channel supporting an AMQP connection.</div><div class="ttdef"><b>Definition:</b> transport.hpp:37</div></div> |
| <div class="ttc" id="anamespaceproton_html"><div class="ttname"><a href="namespaceproton.html">proton</a></div><div class="ttdoc">The main Proton namespace.</div><div class="ttdef"><b>Definition:</b> annotation_key.hpp:33</div></div> |
| <div class="ttc" id="aclassproton_1_1sasl_html"><div class="ttname"><a href="classproton_1_1sasl.html">proton::sasl</a></div><div class="ttdoc">SASL information.</div><div class="ttdef"><b>Definition:</b> sasl.hpp:39</div></div> |
| <div class="ttc" id="aclassproton_1_1sasl_html_af47997198e7e7301a1cd8602c7f02acda2bc49ec37d6a5715dd23e85f1ff5bb59"><div class="ttname"><a href="classproton_1_1sasl.html#af47997198e7e7301a1cd8602c7f02acda2bc49ec37d6a5715dd23e85f1ff5bb59">proton::sasl::OK</a></div><div class="ttdeci">@ OK</div><div class="ttdoc">Authentication succeeded.</div><div class="ttdef"><b>Definition:</b> sasl.hpp:54</div></div> |
| <div class="ttc" id="aclassproton_1_1sasl_html_af47997198e7e7301a1cd8602c7f02acdae0a57d717d9f8c8fdba757be1b0afdcf"><div class="ttname"><a href="classproton_1_1sasl.html#af47997198e7e7301a1cd8602c7f02acdae0a57d717d9f8c8fdba757be1b0afdcf">proton::sasl::PERM</a></div><div class="ttdeci">@ PERM</div><div class="ttdoc">Failed due to unrecoverable error.</div><div class="ttdef"><b>Definition:</b> sasl.hpp:57</div></div> |
| <!-- start footer part --> |
| <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> |
| <ul> |
| <li class="navelem"><a class="el" href="dir_3a71568e5d046e5ed52679664c3002a5.html">proton</a></li><li class="navelem"><a class="el" href="sasl_8hpp.html">sasl.hpp</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> |
