| <!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.IEngineHandlerContext 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&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="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEngineHandlerContext.html">IEngineHandlerContext</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="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEngineHandlerContext-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">Apache.Qpid.Proton.Engine.IEngineHandlerContext Interface Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Context object that is provided to the engine handler APIs to allow for forwarding of events to the next handler or other updates. |
| <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEngineHandlerContext.html#details">More...</a></p> |
| <div class="dynheader"> |
| Inheritance diagram for Apache.Qpid.Proton.Engine.IEngineHandlerContext:</div> |
| <div class="dyncontent"> |
| <div class="center"> |
| <img src="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEngineHandlerContext.png" usemap="#Apache.Qpid.Proton.Engine.IEngineHandlerContext_map" alt=""/> |
| <map id="Apache.Qpid.Proton.Engine.IEngineHandlerContext_map" name="Apache.Qpid.Proton.Engine.IEngineHandlerContext_map"> |
| <area href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1ProtonEngineHandlerContext.html" title="A context object that is assigned to each new engine handler that is inserted into an engine handler ..." alt="Apache.Qpid.Proton.Engine.Implementation.ProtonEngineHandlerContext" shape="rect" coords="0,56,424,80"/> |
| </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:a4b94364ba482218eaa2973b3c5f7ea3a"><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_1IEngineHandlerContext.html#a4b94364ba482218eaa2973b3c5f7ea3a">FireEngineStarting</a> ()</td></tr> |
| <tr class="memdesc:a4b94364ba482218eaa2973b3c5f7ea3a"><td class="mdescLeft"> </td><td class="mdescRight">Fires the engine starting event into the next handler in the engine pipeline. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEngineHandlerContext.html#a4b94364ba482218eaa2973b3c5f7ea3a">More...</a><br /></td></tr> |
| <tr class="separator:a4b94364ba482218eaa2973b3c5f7ea3a"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a403af49a17e3818117ab3ac2749adb68"><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_1IEngineHandlerContext.html#a403af49a17e3818117ab3ac2749adb68">FireEngineStateChanged</a> ()</td></tr> |
| <tr class="memdesc:a403af49a17e3818117ab3ac2749adb68"><td class="mdescLeft"> </td><td class="mdescRight">Fires the engine state changed event into the next handler in the <a class="el" href="">EnginePipeline</a> chain. The state change events occur after the engine starting event and generally signify that the engine has been shutdown normally. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEngineHandlerContext.html#a403af49a17e3818117ab3ac2749adb68">More...</a><br /></td></tr> |
| <tr class="separator:a403af49a17e3818117ab3ac2749adb68"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a27ab8ae03e4de588d5c6596bf1a47363"><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_1IEngineHandlerContext.html#a27ab8ae03e4de588d5c6596bf1a47363">FireFailed</a> (<a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Exceptions_1_1EngineFailedException.html">EngineFailedException</a> ex)</td></tr> |
| <tr class="memdesc:a27ab8ae03e4de588d5c6596bf1a47363"><td class="mdescLeft"> </td><td class="mdescRight">Fires the engine failed event into the next handler in the {engine pipeline chain. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEngineHandlerContext.html#a27ab8ae03e4de588d5c6596bf1a47363">More...</a><br /></td></tr> |
| <tr class="separator:a27ab8ae03e4de588d5c6596bf1a47363"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a43b8e80225d68962146ba3c5b2cac1a4"><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_1IEngineHandlerContext.html#a43b8e80225d68962146ba3c5b2cac1a4">FireRead</a> (<a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Buffer_1_1IProtonBuffer.html">IProtonBuffer</a> buffer)</td></tr> |
| <tr class="memdesc:a43b8e80225d68962146ba3c5b2cac1a4"><td class="mdescLeft"> </td><td class="mdescRight">Fires a read event into the previous handler in the engine pipeline for further processing or dispatch to the next in line. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEngineHandlerContext.html#a43b8e80225d68962146ba3c5b2cac1a4">More...</a><br /></td></tr> |
| <tr class="separator:a43b8e80225d68962146ba3c5b2cac1a4"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aeaad5b7d4efe193c9103118d6358103a"><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_1IEngineHandlerContext.html#aeaad5b7d4efe193c9103118d6358103a">FireRead</a> (<a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1HeaderEnvelope.html">HeaderEnvelope</a> header)</td></tr> |
| <tr class="memdesc:aeaad5b7d4efe193c9103118d6358103a"><td class="mdescLeft"> </td><td class="mdescRight">Fires a read of AMQP header events into the previous handler in the engine pipeline for further processing. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEngineHandlerContext.html#aeaad5b7d4efe193c9103118d6358103a">More...</a><br /></td></tr> |
| <tr class="separator:aeaad5b7d4efe193c9103118d6358103a"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a4265d75f73ba0be102dc2a18d57c5bcd"><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_1IEngineHandlerContext.html#a4265d75f73ba0be102dc2a18d57c5bcd">FireRead</a> (<a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1SaslEnvelope.html">SaslEnvelope</a> envelope)</td></tr> |
| <tr class="memdesc:a4265d75f73ba0be102dc2a18d57c5bcd"><td class="mdescLeft"> </td><td class="mdescRight">Fires a read of SASL performative envelope events into the previous handler in the engine pipeline for further processing. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEngineHandlerContext.html#a4265d75f73ba0be102dc2a18d57c5bcd">More...</a><br /></td></tr> |
| <tr class="separator:a4265d75f73ba0be102dc2a18d57c5bcd"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a047107818288337233946fa5d4945cd9"><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_1IEngineHandlerContext.html#a047107818288337233946fa5d4945cd9">FireRead</a> (<a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1IncomingAmqpEnvelope.html">IncomingAmqpEnvelope</a> envelope)</td></tr> |
| <tr class="memdesc:a047107818288337233946fa5d4945cd9"><td class="mdescLeft"> </td><td class="mdescRight">Fires a read of AMQP performative envelope events into the previous handler in the engine pipeline for further processing. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEngineHandlerContext.html#a047107818288337233946fa5d4945cd9">More...</a><br /></td></tr> |
| <tr class="separator:a047107818288337233946fa5d4945cd9"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a369571543b27e7b1e634c4d2cfbdd70c"><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_1IEngineHandlerContext.html#a369571543b27e7b1e634c4d2cfbdd70c">FireWrite</a> (<a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1OutgoingAmqpEnvelope.html">OutgoingAmqpEnvelope</a> envelope)</td></tr> |
| <tr class="memdesc:a369571543b27e7b1e634c4d2cfbdd70c"><td class="mdescLeft"> </td><td class="mdescRight">Fires a write of the given AMQP performative envelope which should be passed along the engine pipeline for processing. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEngineHandlerContext.html#a369571543b27e7b1e634c4d2cfbdd70c">More...</a><br /></td></tr> |
| <tr class="separator:a369571543b27e7b1e634c4d2cfbdd70c"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af6f793ccea17dc7332614c761a814b56"><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_1IEngineHandlerContext.html#af6f793ccea17dc7332614c761a814b56">FireWrite</a> (<a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1SaslEnvelope.html">SaslEnvelope</a> envelope)</td></tr> |
| <tr class="memdesc:af6f793ccea17dc7332614c761a814b56"><td class="mdescLeft"> </td><td class="mdescRight">Fires a write of the given SASL performative envelope which should be passed along the engine pipeline for processing. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEngineHandlerContext.html#af6f793ccea17dc7332614c761a814b56">More...</a><br /></td></tr> |
| <tr class="separator:af6f793ccea17dc7332614c761a814b56"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a59624e3b27415834b94adc1c18597dcd"><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_1IEngineHandlerContext.html#a59624e3b27415834b94adc1c18597dcd">FireWrite</a> (<a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1HeaderEnvelope.html">HeaderEnvelope</a> envelope)</td></tr> |
| <tr class="memdesc:a59624e3b27415834b94adc1c18597dcd"><td class="mdescLeft"> </td><td class="mdescRight">Fires a write of the given AMQP Header envelope which should be passed along the engine pipeline for processing. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEngineHandlerContext.html#a59624e3b27415834b94adc1c18597dcd">More...</a><br /></td></tr> |
| <tr class="separator:a59624e3b27415834b94adc1c18597dcd"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a179ebf0593c1f4d2a234f58baf783106"><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_1IEngineHandlerContext.html#a179ebf0593c1f4d2a234f58baf783106">FireWrite</a> (<a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Buffer_1_1IProtonBuffer.html">IProtonBuffer</a> buffer, Action ioComplete)</td></tr> |
| <tr class="memdesc:a179ebf0593c1f4d2a234f58baf783106"><td class="mdescLeft"> </td><td class="mdescRight">Fires a write of the given proton buffer into the engine pipeline for processing and provides an action delegate which should be invoked when the IO has written the bytes fully. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEngineHandlerContext.html#a179ebf0593c1f4d2a234f58baf783106">More...</a><br /></td></tr> |
| <tr class="separator:a179ebf0593c1f4d2a234f58baf783106"><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:a540dd7ab0f43f4cbc92532b0e52b4511"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEngineHandler.html">IEngineHandler</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEngineHandlerContext.html#a540dd7ab0f43f4cbc92532b0e52b4511">Handler</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a540dd7ab0f43f4cbc92532b0e52b4511"><td class="mdescLeft"> </td><td class="mdescRight">Access the engine handler that this context is assigned to. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEngineHandlerContext.html#a540dd7ab0f43f4cbc92532b0e52b4511">More...</a><br /></td></tr> |
| <tr class="separator:a540dd7ab0f43f4cbc92532b0e52b4511"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a327f23c40025a5dde81e849896d216ce"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEngine.html">IEngine</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEngineHandlerContext.html#a327f23c40025a5dde81e849896d216ce">Engine</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a327f23c40025a5dde81e849896d216ce"><td class="mdescLeft"> </td><td class="mdescRight">Access the engine instance where this context and its handler are assigned. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEngineHandlerContext.html#a327f23c40025a5dde81e849896d216ce">More...</a><br /></td></tr> |
| <tr class="separator:a327f23c40025a5dde81e849896d216ce"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a75acebc465e23d3478ad1ca72055466f"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEngineHandlerContext.html#a75acebc465e23d3478ad1ca72055466f">Name</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a75acebc465e23d3478ad1ca72055466f"><td class="mdescLeft"> </td><td class="mdescRight">Access the name that was given to the handler assigned to this context. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEngineHandlerContext.html#a75acebc465e23d3478ad1ca72055466f">More...</a><br /></td></tr> |
| <tr class="separator:a75acebc465e23d3478ad1ca72055466f"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Context object that is provided to the engine handler APIs to allow for forwarding of events to the next handler or other updates. </p> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a4b94364ba482218eaa2973b3c5f7ea3a"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a4b94364ba482218eaa2973b3c5f7ea3a">◆ </a></span>FireEngineStarting()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void Apache.Qpid.Proton.Engine.IEngineHandlerContext.FireEngineStarting </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Fires the engine starting event into the next handler in the engine pipeline. </p> |
| |
| <p>Implemented in <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1ProtonEngineHandlerContext.html#a11e435d76003318ab2591d2d6b010176">Apache.Qpid.Proton.Engine.Implementation.ProtonEngineHandlerContext</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a403af49a17e3818117ab3ac2749adb68"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a403af49a17e3818117ab3ac2749adb68">◆ </a></span>FireEngineStateChanged()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void Apache.Qpid.Proton.Engine.IEngineHandlerContext.FireEngineStateChanged </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Fires the engine state changed event into the next handler in the <a class="el" href="">EnginePipeline</a> chain. The state change events occur after the engine starting event and generally signify that the engine has been shutdown normally. </p> |
| |
| <p>Implemented in <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1ProtonEngineHandlerContext.html#a82f5584111f28af9110295a7b7a6a865">Apache.Qpid.Proton.Engine.Implementation.ProtonEngineHandlerContext</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a27ab8ae03e4de588d5c6596bf1a47363"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a27ab8ae03e4de588d5c6596bf1a47363">◆ </a></span>FireFailed()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void Apache.Qpid.Proton.Engine.IEngineHandlerContext.FireFailed </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Exceptions_1_1EngineFailedException.html">EngineFailedException</a> </td> |
| <td class="paramname"><em>ex</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Fires the engine failed event into the next handler in the {engine pipeline chain. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">ex</td><td>The exception that triggered the failure</td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p>Implemented in <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1ProtonEngineHandlerContext.html#aa04aed56364ed6755e3c66a22f88f8cb">Apache.Qpid.Proton.Engine.Implementation.ProtonEngineHandlerContext</a>.</p> |
| |
| </div> |
| </div> |
| <a id="aeaad5b7d4efe193c9103118d6358103a"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aeaad5b7d4efe193c9103118d6358103a">◆ </a></span>FireRead() <span class="overload">[1/4]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void Apache.Qpid.Proton.Engine.IEngineHandlerContext.FireRead </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>header</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Fires a read of AMQP header events into the previous handler in the engine pipeline for further processing. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">header</td><td></td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p>Implemented in <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1ProtonEngineHandlerContext.html#adf849ea6e6fc7ae4c4e107304931f947">Apache.Qpid.Proton.Engine.Implementation.ProtonEngineHandlerContext</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a047107818288337233946fa5d4945cd9"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a047107818288337233946fa5d4945cd9">◆ </a></span>FireRead() <span class="overload">[2/4]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void Apache.Qpid.Proton.Engine.IEngineHandlerContext.FireRead </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><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Fires a read of AMQP performative envelope events into the previous handler in the engine pipeline for further processing. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">envelope</td><td>The incoming envelope that was read.</td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p>Implemented in <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1ProtonEngineHandlerContext.html#ad48778a58729a0d99767c5e145904e03">Apache.Qpid.Proton.Engine.Implementation.ProtonEngineHandlerContext</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a43b8e80225d68962146ba3c5b2cac1a4"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a43b8e80225d68962146ba3c5b2cac1a4">◆ </a></span>FireRead() <span class="overload">[3/4]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void Apache.Qpid.Proton.Engine.IEngineHandlerContext.FireRead </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Buffer_1_1IProtonBuffer.html">IProtonBuffer</a> </td> |
| <td class="paramname"><em>buffer</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Fires a read event into the previous handler in the engine pipeline for further processing or dispatch to the next in line. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">buffer</td><td>The buffer containing the bytes read</td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p>Implemented in <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1ProtonEngineHandlerContext.html#a05988cbc83977e1e299c95ffbedf81c9">Apache.Qpid.Proton.Engine.Implementation.ProtonEngineHandlerContext</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a4265d75f73ba0be102dc2a18d57c5bcd"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a4265d75f73ba0be102dc2a18d57c5bcd">◆ </a></span>FireRead() <span class="overload">[4/4]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void Apache.Qpid.Proton.Engine.IEngineHandlerContext.FireRead </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><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Fires a read of SASL performative envelope events into the previous handler in the engine pipeline for further processing. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">envelope</td><td>The incoming envelope that was read.</td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p>Implemented in <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1ProtonEngineHandlerContext.html#a7b93b80498b170f3ee9b79008ae45f0c">Apache.Qpid.Proton.Engine.Implementation.ProtonEngineHandlerContext</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a59624e3b27415834b94adc1c18597dcd"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a59624e3b27415834b94adc1c18597dcd">◆ </a></span>FireWrite() <span class="overload">[1/4]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void Apache.Qpid.Proton.Engine.IEngineHandlerContext.FireWrite </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><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Fires a write of the given AMQP Header envelope which should be passed along the engine pipeline for processing. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">envelope</td><td>The outgoing envelope that should be written.</td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p>Implemented in <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1ProtonEngineHandlerContext.html#ab4577b18145c0600cceb77a319a18055">Apache.Qpid.Proton.Engine.Implementation.ProtonEngineHandlerContext</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a179ebf0593c1f4d2a234f58baf783106"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a179ebf0593c1f4d2a234f58baf783106">◆ </a></span>FireWrite() <span class="overload">[2/4]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void Apache.Qpid.Proton.Engine.IEngineHandlerContext.FireWrite </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Buffer_1_1IProtonBuffer.html">IProtonBuffer</a> </td> |
| <td class="paramname"><em>buffer</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">Action </td> |
| <td class="paramname"><em>ioComplete</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Fires a write of the given proton buffer into the engine pipeline for processing and provides an action delegate which should be invoked when the IO has written the bytes fully. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">buffer</td><td>The buffer that should be written to the IO layer</td></tr> |
| <tr><td class="paramname">ioComplete</td><td>The completion action to invoke when the IO is done</td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p>Implemented in <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1ProtonEngineHandlerContext.html#aee4fd485bdf7c1c788d06deaa806d9a8">Apache.Qpid.Proton.Engine.Implementation.ProtonEngineHandlerContext</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a369571543b27e7b1e634c4d2cfbdd70c"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a369571543b27e7b1e634c4d2cfbdd70c">◆ </a></span>FireWrite() <span class="overload">[3/4]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void Apache.Qpid.Proton.Engine.IEngineHandlerContext.FireWrite </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><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Fires a write of the given AMQP performative envelope which should be passed along the engine pipeline for processing. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">envelope</td><td>The outgoing envelope that should be written.</td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p>Implemented in <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1ProtonEngineHandlerContext.html#a9722897341597ef0560ea49d3d0e2646">Apache.Qpid.Proton.Engine.Implementation.ProtonEngineHandlerContext</a>.</p> |
| |
| </div> |
| </div> |
| <a id="af6f793ccea17dc7332614c761a814b56"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#af6f793ccea17dc7332614c761a814b56">◆ </a></span>FireWrite() <span class="overload">[4/4]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void Apache.Qpid.Proton.Engine.IEngineHandlerContext.FireWrite </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><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Fires a write of the given SASL performative envelope which should be passed along the engine pipeline for processing. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">envelope</td><td>The outgoing envelope that should be written.</td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p>Implemented in <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1ProtonEngineHandlerContext.html#ac2dc0a6ddb1e61f7583feeef8803d8c0">Apache.Qpid.Proton.Engine.Implementation.ProtonEngineHandlerContext</a>.</p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Property Documentation</h2> |
| <a id="a327f23c40025a5dde81e849896d216ce"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a327f23c40025a5dde81e849896d216ce">◆ </a></span>Engine</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_1IEngine.html">IEngine</a> Apache.Qpid.Proton.Engine.IEngineHandlerContext.Engine</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 the engine instance where this context and its handler are assigned. </p> |
| |
| </div> |
| </div> |
| <a id="a540dd7ab0f43f4cbc92532b0e52b4511"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a540dd7ab0f43f4cbc92532b0e52b4511">◆ </a></span>Handler</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_1IEngineHandler.html">IEngineHandler</a> Apache.Qpid.Proton.Engine.IEngineHandlerContext.Handler</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 the engine handler that this context is assigned to. </p> |
| |
| </div> |
| </div> |
| <a id="a75acebc465e23d3478ad1ca72055466f"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a75acebc465e23d3478ad1ca72055466f">◆ </a></span>Name</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.IEngineHandlerContext.Name</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 the name that was given to the handler assigned to this context. </p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this interface was generated from the following file:<ul> |
| <li>src/Proton/Engine/IEngineHandlerContext.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> |
