| <!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.Implementation.Sasl.ProtonSaslHandler 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&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&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_1Implementation.html">Implementation</a></li><li class="navelem"><a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1Sasl.html">Sasl</a></li><li class="navelem"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1Sasl_1_1ProtonSaslHandler.html">ProtonSaslHandler</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#properties">Properties</a> | |
| <a href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1Sasl_1_1ProtonSaslHandler-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">Apache.Qpid.Proton.Engine.Implementation.Sasl.ProtonSaslHandler Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p><a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Engine.html">Engine</a> handler that manages the SASL authentication process that occurs either on the client or server end of the SASL exchange. |
| <a href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1Sasl_1_1ProtonSaslHandler.html#details">More...</a></p> |
| <div class="dynheader"> |
| Inheritance diagram for Apache.Qpid.Proton.Engine.Implementation.Sasl.ProtonSaslHandler:</div> |
| <div class="dyncontent"> |
| <div class="center"> |
| <img src="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1Sasl_1_1ProtonSaslHandler.png" usemap="#Apache.Qpid.Proton.Engine.Implementation.Sasl.ProtonSaslHandler_map" alt=""/> |
| <map id="Apache.Qpid.Proton.Engine.Implementation.Sasl.ProtonSaslHandler_map" name="Apache.Qpid.Proton.Engine.Implementation.Sasl.ProtonSaslHandler_map"> |
| <area href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEngineHandler.html" title="Handler of engine events that is queued into the events pipeline." alt="Apache.Qpid.Proton.Engine.IEngineHandler" shape="rect" coords="0,0,395,24"/> |
| </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:a28381bd4e77e98d4079e2f2d14265333"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1Sasl_1_1ProtonSaslHandler.html#a28381bd4e77e98d4079e2f2d14265333">HandlerAdded</a> (<a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEngineHandlerContext.html">IEngineHandlerContext</a> context)</td></tr> |
| <tr class="memdesc:a28381bd4e77e98d4079e2f2d14265333"><td class="mdescLeft"> </td><td class="mdescRight">Called when the handler is successfully added to the engine pipeline and will later be initialized before use. <a href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1Sasl_1_1ProtonSaslHandler.html#a28381bd4e77e98d4079e2f2d14265333">More...</a><br /></td></tr> |
| <tr class="separator:a28381bd4e77e98d4079e2f2d14265333"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a3c745b30499d9f8254bf62edbd5dd9cb"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1Sasl_1_1ProtonSaslHandler.html#a3c745b30499d9f8254bf62edbd5dd9cb">HandlerRemoved</a> (<a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEngineHandlerContext.html">IEngineHandlerContext</a> context)</td></tr> |
| <tr class="memdesc:a3c745b30499d9f8254bf62edbd5dd9cb"><td class="mdescLeft"> </td><td class="mdescRight">Called when the handler is successfully removed from the engine pipeline and will not be invoked again or ever. <a href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1Sasl_1_1ProtonSaslHandler.html#a3c745b30499d9f8254bf62edbd5dd9cb">More...</a><br /></td></tr> |
| <tr class="separator:a3c745b30499d9f8254bf62edbd5dd9cb"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a968293366f79ec50d666eba2f1260d1f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1Sasl_1_1ProtonSaslHandler.html#a968293366f79ec50d666eba2f1260d1f">EngineStarting</a> (<a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEngineHandlerContext.html">IEngineHandlerContext</a> context)</td></tr> |
| <tr class="memdesc:a968293366f79ec50d666eba2f1260d1f"><td class="mdescLeft"> </td><td class="mdescRight">Called when the engine is started to allow handlers to prepare for use based on the configuration state at start of the engine. A handler can fail the engine start by throwing an exception. <a href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1Sasl_1_1ProtonSaslHandler.html#a968293366f79ec50d666eba2f1260d1f">More...</a><br /></td></tr> |
| <tr class="separator:a968293366f79ec50d666eba2f1260d1f"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ae821912e338f1e8001fced7b3ff69800"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1Sasl_1_1ProtonSaslHandler.html#ae821912e338f1e8001fced7b3ff69800">HandleRead</a> (<a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEngineHandlerContext.html">IEngineHandlerContext</a> context, <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1HeaderEnvelope.html">HeaderEnvelope</a> header)</td></tr> |
| <tr class="memdesc:ae821912e338f1e8001fced7b3ff69800"><td class="mdescLeft"> </td><td class="mdescRight">Handle the receipt of an incoming AMQP Header or SASL Header based on the current state of this handler. <a href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1Sasl_1_1ProtonSaslHandler.html#ae821912e338f1e8001fced7b3ff69800">More...</a><br /></td></tr> |
| <tr class="separator:ae821912e338f1e8001fced7b3ff69800"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a217d1c604521a36513b4b3fa83bc26e9"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1Sasl_1_1ProtonSaslHandler.html#a217d1c604521a36513b4b3fa83bc26e9">HandleRead</a> (<a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEngineHandlerContext.html">IEngineHandlerContext</a> context, <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1SaslEnvelope.html">SaslEnvelope</a> frame)</td></tr> |
| <tr class="memdesc:a217d1c604521a36513b4b3fa83bc26e9"><td class="mdescLeft"> </td><td class="mdescRight">Handle the receipt of an incoming SASL performative envelope based on the current state of this handler. <a href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1Sasl_1_1ProtonSaslHandler.html#a217d1c604521a36513b4b3fa83bc26e9">More...</a><br /></td></tr> |
| <tr class="separator:a217d1c604521a36513b4b3fa83bc26e9"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa08b83ec4587dfd8b89039e1bc0d5f66"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1Sasl_1_1ProtonSaslHandler.html#aa08b83ec4587dfd8b89039e1bc0d5f66">HandleRead</a> (<a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEngineHandlerContext.html">IEngineHandlerContext</a> context, <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1IncomingAmqpEnvelope.html">IncomingAmqpEnvelope</a> frame)</td></tr> |
| <tr class="memdesc:aa08b83ec4587dfd8b89039e1bc0d5f66"><td class="mdescLeft"> </td><td class="mdescRight">Handle the receipt of an incoming AMQP performative envelope based on the current state of this handler. <a href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1Sasl_1_1ProtonSaslHandler.html#aa08b83ec4587dfd8b89039e1bc0d5f66">More...</a><br /></td></tr> |
| <tr class="separator:aa08b83ec4587dfd8b89039e1bc0d5f66"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a9db10c1972cd22f88a840cd8fbc200ea"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1Sasl_1_1ProtonSaslHandler.html#a9db10c1972cd22f88a840cd8fbc200ea">HandleWrite</a> (<a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEngineHandlerContext.html">IEngineHandlerContext</a> context, <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1HeaderEnvelope.html">HeaderEnvelope</a> frame)</td></tr> |
| <tr class="memdesc:a9db10c1972cd22f88a840cd8fbc200ea"><td class="mdescLeft"> </td><td class="mdescRight">Handles write of AMQP Header either by directly writing it to the output target or by converting it to bytes and firing a write using the buffer based write API <a href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1Sasl_1_1ProtonSaslHandler.html#a9db10c1972cd22f88a840cd8fbc200ea">More...</a><br /></td></tr> |
| <tr class="separator:a9db10c1972cd22f88a840cd8fbc200ea"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a5d500079fc5d57f48602344379650130"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1Sasl_1_1ProtonSaslHandler.html#a5d500079fc5d57f48602344379650130">HandleWrite</a> (<a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEngineHandlerContext.html">IEngineHandlerContext</a> context, <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1OutgoingAmqpEnvelope.html">OutgoingAmqpEnvelope</a> frame)</td></tr> |
| <tr class="memdesc:a5d500079fc5d57f48602344379650130"><td class="mdescLeft"> </td><td class="mdescRight">Handles write of AMQP performative either by directly writing it to the output target or by converting it to bytes and firing a write using the buffer based write API <a href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1Sasl_1_1ProtonSaslHandler.html#a5d500079fc5d57f48602344379650130">More...</a><br /></td></tr> |
| <tr class="separator:a5d500079fc5d57f48602344379650130"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a47aa79acde56c3c2fda9323bf57cec8a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1Sasl_1_1ProtonSaslHandler.html#a47aa79acde56c3c2fda9323bf57cec8a">HandleWrite</a> (<a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEngineHandlerContext.html">IEngineHandlerContext</a> context, <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1SaslEnvelope.html">SaslEnvelope</a> frame)</td></tr> |
| <tr class="memdesc:a47aa79acde56c3c2fda9323bf57cec8a"><td class="mdescLeft"> </td><td class="mdescRight">Handles write of SASL performative either by directly writing it to the output target or by converting it to bytes and firing a write using the buffer based write API <a href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1Sasl_1_1ProtonSaslHandler.html#a47aa79acde56c3c2fda9323bf57cec8a">More...</a><br /></td></tr> |
| <tr class="separator:a47aa79acde56c3c2fda9323bf57cec8a"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEngineHandler"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEngineHandler')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEngineHandler.html">Apache.Qpid.Proton.Engine.IEngineHandler</a></td></tr> |
| <tr class="memitem:a75d2a1b1a0d907b8a502cdb375c333ab inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEngineHandler"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEngineHandler.html#a75d2a1b1a0d907b8a502cdb375c333ab">HandleEngineStateChanged</a> (<a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEngineHandlerContext.html">IEngineHandlerContext</a> context)</td></tr> |
| <tr class="memdesc:a75d2a1b1a0d907b8a502cdb375c333ab inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEngineHandler"><td class="mdescLeft"> </td><td class="mdescRight">Called when the engine state has changed and handlers may need to update their internal state to respond to the change or prompt some new work based on the change, e.g state changes from not writable to writable. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEngineHandler.html#a75d2a1b1a0d907b8a502cdb375c333ab">More...</a><br /></td></tr> |
| <tr class="separator:a75d2a1b1a0d907b8a502cdb375c333ab inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEngineHandler"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a61cbf6a4d855a334594ef29f94fad208 inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEngineHandler"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEngineHandler.html#a61cbf6a4d855a334594ef29f94fad208">EngineFailed</a> (<a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEngineHandlerContext.html">IEngineHandlerContext</a> context, <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Exceptions_1_1EngineFailedException.html">EngineFailedException</a> failure)</td></tr> |
| <tr class="memdesc:a61cbf6a4d855a334594ef29f94fad208 inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEngineHandler"><td class="mdescLeft"> </td><td class="mdescRight">Called when the engine has transitioned to a failed state and cannot process any additional input or output. The handler can free and resources used for normal operations at this point as the engine is now considered shutdown. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEngineHandler.html#a61cbf6a4d855a334594ef29f94fad208">More...</a><br /></td></tr> |
| <tr class="separator:a61cbf6a4d855a334594ef29f94fad208 inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEngineHandler"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a3ae62f6a35d5a171c91722884fbfb953 inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEngineHandler"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEngineHandler.html#a3ae62f6a35d5a171c91722884fbfb953">HandleRead</a> (<a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEngineHandlerContext.html">IEngineHandlerContext</a> context, <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Buffer_1_1IProtonBuffer.html">IProtonBuffer</a> buffer)</td></tr> |
| <tr class="memdesc:a3ae62f6a35d5a171c91722884fbfb953 inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEngineHandler"><td class="mdescLeft"> </td><td class="mdescRight">Handle the read of new incoming bytes from a remote sender. The handler should generally decode these bytes into an AMQP Performative or SASL Performative based on the current state of the connection and the handler in question. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEngineHandler.html#a3ae62f6a35d5a171c91722884fbfb953">More...</a><br /></td></tr> |
| <tr class="separator:a3ae62f6a35d5a171c91722884fbfb953 inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEngineHandler"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad324195db6e028daa24eac38abf42e2f inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEngineHandler"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEngineHandler.html#ad324195db6e028daa24eac38abf42e2f">HandleWrite</a> (<a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEngineHandlerContext.html">IEngineHandlerContext</a> context, <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Buffer_1_1IProtonBuffer.html">IProtonBuffer</a> buffer, Action ioComplete)</td></tr> |
| <tr class="separator:ad324195db6e028daa24eac38abf42e2f inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEngineHandler"><td class="memSeparator" colspan="2"> </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:a283cd9477edf3c7d4e44e7a6b05e157d"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1Sasl_1_1ProtonSaslHandler.html#a283cd9477edf3c7d4e44e7a6b05e157d">IsDone</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a283cd9477edf3c7d4e44e7a6b05e157d"><td class="mdescLeft"> </td><td class="mdescRight">Determines if the SASL authentication process has completed. <a href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1Sasl_1_1ProtonSaslHandler.html#a283cd9477edf3c7d4e44e7a6b05e157d">More...</a><br /></td></tr> |
| <tr class="separator:a283cd9477edf3c7d4e44e7a6b05e157d"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p><a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Engine.html">Engine</a> handler that manages the SASL authentication process that occurs either on the client or server end of the SASL exchange. </p> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a968293366f79ec50d666eba2f1260d1f"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a968293366f79ec50d666eba2f1260d1f">◆ </a></span>EngineStarting()</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.Engine.Implementation.Sasl.ProtonSaslHandler.EngineStarting </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEngineHandlerContext.html">IEngineHandlerContext</a> </td> |
| <td class="paramname"><em>context</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>Called when the engine is started to allow handlers to prepare for use based on the configuration state at start of the engine. A handler can fail the engine start by throwing an exception. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">context</td><td>The handler context that is assigned to this handler</td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p>Implements <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEngineHandler.html#a203e0109b323aed70424c2470a4ee801">Apache.Qpid.Proton.Engine.IEngineHandler</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a28381bd4e77e98d4079e2f2d14265333"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a28381bd4e77e98d4079e2f2d14265333">◆ </a></span>HandlerAdded()</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.Engine.Implementation.Sasl.ProtonSaslHandler.HandlerAdded </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEngineHandlerContext.html">IEngineHandlerContext</a> </td> |
| <td class="paramname"><em>context</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>Called when the handler is successfully added to the engine pipeline and will later be initialized before use. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">context</td><td>The handler context that is assigned to this handler</td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p>Implements <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEngineHandler.html#ade600cd80e89ed0c712ba1326e75d5ef">Apache.Qpid.Proton.Engine.IEngineHandler</a>.</p> |
| |
| </div> |
| </div> |
| <a id="ae821912e338f1e8001fced7b3ff69800"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ae821912e338f1e8001fced7b3ff69800">◆ </a></span>HandleRead() <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">void Apache.Qpid.Proton.Engine.Implementation.Sasl.ProtonSaslHandler.HandleRead </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEngineHandlerContext.html">IEngineHandlerContext</a> </td> |
| <td class="paramname"><em>context</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1HeaderEnvelope.html">HeaderEnvelope</a> </td> |
| <td class="paramname"><em>envelope</em> </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>Handle the receipt of an incoming AMQP Header or SASL Header based on the current state of this handler. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">context</td><td>The handler context that is assigned to this handler</td></tr> |
| <tr><td class="paramname">envelope</td><td>The envelope that was read</td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p>Implements <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEngineHandler.html#af86fff8055462cfce1c4cef89e5606ce">Apache.Qpid.Proton.Engine.IEngineHandler</a>.</p> |
| |
| </div> |
| </div> |
| <a id="aa08b83ec4587dfd8b89039e1bc0d5f66"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aa08b83ec4587dfd8b89039e1bc0d5f66">◆ </a></span>HandleRead() <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">void Apache.Qpid.Proton.Engine.Implementation.Sasl.ProtonSaslHandler.HandleRead </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEngineHandlerContext.html">IEngineHandlerContext</a> </td> |
| <td class="paramname"><em>context</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1IncomingAmqpEnvelope.html">IncomingAmqpEnvelope</a> </td> |
| <td class="paramname"><em>envelope</em> </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>Handle the receipt of an incoming AMQP performative envelope based on the current state of this handler. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">context</td><td>The handler context that is assigned to this handler</td></tr> |
| <tr><td class="paramname">envelope</td><td>The envelope that was read</td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p>Implements <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEngineHandler.html#a8316fc48ff39920fa18551294fff41a3">Apache.Qpid.Proton.Engine.IEngineHandler</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a217d1c604521a36513b4b3fa83bc26e9"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a217d1c604521a36513b4b3fa83bc26e9">◆ </a></span>HandleRead() <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">void Apache.Qpid.Proton.Engine.Implementation.Sasl.ProtonSaslHandler.HandleRead </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEngineHandlerContext.html">IEngineHandlerContext</a> </td> |
| <td class="paramname"><em>context</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1SaslEnvelope.html">SaslEnvelope</a> </td> |
| <td class="paramname"><em>envelope</em> </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>Handle the receipt of an incoming SASL performative envelope based on the current state of this handler. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">context</td><td>The handler context that is assigned to this handler</td></tr> |
| <tr><td class="paramname">envelope</td><td>The envelope that was read</td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p>Implements <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEngineHandler.html#a074c6fcbbfb204391f6295dfa7e96ba7">Apache.Qpid.Proton.Engine.IEngineHandler</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a3c745b30499d9f8254bf62edbd5dd9cb"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a3c745b30499d9f8254bf62edbd5dd9cb">◆ </a></span>HandlerRemoved()</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.Engine.Implementation.Sasl.ProtonSaslHandler.HandlerRemoved </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEngineHandlerContext.html">IEngineHandlerContext</a> </td> |
| <td class="paramname"><em>context</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>Called when the handler is successfully removed from the engine pipeline and will not be invoked again or ever. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">context</td><td>The handler context that is assigned to this handler</td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p>Implements <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEngineHandler.html#ad76f20cd8933d3d6f1905d9729242b34">Apache.Qpid.Proton.Engine.IEngineHandler</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a9db10c1972cd22f88a840cd8fbc200ea"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a9db10c1972cd22f88a840cd8fbc200ea">◆ </a></span>HandleWrite() <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">void Apache.Qpid.Proton.Engine.Implementation.Sasl.ProtonSaslHandler.HandleWrite </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEngineHandlerContext.html">IEngineHandlerContext</a> </td> |
| <td class="paramname"><em>context</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1HeaderEnvelope.html">HeaderEnvelope</a> </td> |
| <td class="paramname"><em>envelope</em> </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>Handles write of AMQP Header either by directly writing it to the output target or by converting it to bytes and firing a write using the buffer based write API </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">context</td><td>The handler context that is assigned to this handler</td></tr> |
| <tr><td class="paramname">envelope</td><td>The envelope that is to be written</td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p>Implements <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEngineHandler.html#acfbc24ae39f5c5ac5195ec217c7b3ae5">Apache.Qpid.Proton.Engine.IEngineHandler</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a5d500079fc5d57f48602344379650130"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a5d500079fc5d57f48602344379650130">◆ </a></span>HandleWrite() <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">void Apache.Qpid.Proton.Engine.Implementation.Sasl.ProtonSaslHandler.HandleWrite </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEngineHandlerContext.html">IEngineHandlerContext</a> </td> |
| <td class="paramname"><em>context</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1OutgoingAmqpEnvelope.html">OutgoingAmqpEnvelope</a> </td> |
| <td class="paramname"><em>envelope</em> </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>Handles write of AMQP performative either by directly writing it to the output target or by converting it to bytes and firing a write using the buffer based write API </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">context</td><td>The handler context that is assigned to this handler</td></tr> |
| <tr><td class="paramname">envelope</td><td>The envelope that is to be written</td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p>Implements <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEngineHandler.html#aa0f1a0de574f0518f64a9f97778da502">Apache.Qpid.Proton.Engine.IEngineHandler</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a47aa79acde56c3c2fda9323bf57cec8a"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a47aa79acde56c3c2fda9323bf57cec8a">◆ </a></span>HandleWrite() <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">void Apache.Qpid.Proton.Engine.Implementation.Sasl.ProtonSaslHandler.HandleWrite </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEngineHandlerContext.html">IEngineHandlerContext</a> </td> |
| <td class="paramname"><em>context</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1SaslEnvelope.html">SaslEnvelope</a> </td> |
| <td class="paramname"><em>envelope</em> </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>Handles write of SASL performative either by directly writing it to the output target or by converting it to bytes and firing a write using the buffer based write API </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">context</td><td>The handler context that is assigned to this handler</td></tr> |
| <tr><td class="paramname">envelope</td><td>The envelope that is to be written</td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p>Implements <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEngineHandler.html#adaf35ec25af74e2d90bdb897c18607e2">Apache.Qpid.Proton.Engine.IEngineHandler</a>.</p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Property Documentation</h2> |
| <a id="a283cd9477edf3c7d4e44e7a6b05e157d"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a283cd9477edf3c7d4e44e7a6b05e157d">◆ </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.Implementation.Sasl.ProtonSaslHandler.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>Determines if the SASL authentication process has completed. </p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>src/Proton/Engine/Implementation/Sasl/ProtonSaslHandler.cs</li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated by <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> |
