| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.11) on Wed May 12 10:10:59 EDT 2021 --> |
| <title>ProtonEngineHandlerContext (Qpid ProtonJ2 Parent 1.0.0-M1 API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2021-05-12"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../jquery/jquery-ui.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../../jquery/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../../../jquery/jquery-3.5.1.js"></script> |
| <script type="text/javascript" src="../../../../../../jquery/jquery-ui.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="ProtonEngineHandlerContext (Qpid ProtonJ2 Parent 1.0.0-M1 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| var pathtoroot = "../../../../../../"; |
| var useModuleDirectories = true; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/ProtonEngineHandlerContext.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <main role="main"> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.apache.qpid.protonj2.engine.impl</a></div> |
| <h2 title="Class ProtonEngineHandlerContext" class="title">Class ProtonEngineHandlerContext</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.qpid.protonj2.engine.impl.ProtonEngineHandlerContext</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="../EngineHandlerContext.html" title="interface in org.apache.qpid.protonj2.engine">EngineHandlerContext</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public class <span class="typeNameLabel">ProtonEngineHandlerContext</span> |
| extends java.lang.Object |
| implements <a href="../EngineHandlerContext.html" title="interface in org.apache.qpid.protonj2.engine">EngineHandlerContext</a></pre> |
| <div class="block">Context for a registered EngineHandler</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Field</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#HANDLER_ALL_EVENTS">HANDLER_ALL_EVENTS</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#HANDLER_READS">HANDLER_READS</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#HANDLER_WRITES">HANDLER_WRITES</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Constructor</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.lang.String,org.apache.qpid.protonj2.engine.Engine,org.apache.qpid.protonj2.engine.EngineHandler)">ProtonEngineHandlerContext</a></span>​(java.lang.String name, |
| <a href="../Engine.html" title="interface in org.apache.qpid.protonj2.engine">Engine</a> engine, |
| <a href="../EngineHandler.html" title="interface in org.apache.qpid.protonj2.engine">EngineHandler</a> handler)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="../Engine.html" title="interface in org.apache.qpid.protonj2.engine">Engine</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#engine()">engine</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#fireEngineStarting()">fireEngineStarting</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Fires the engine starting event into the next handler in the <a href="../EnginePipeline.html" title="interface in org.apache.qpid.protonj2.engine"><code>EnginePipeline</code></a> chain.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#fireEngineStateChanged()">fireEngineStateChanged</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Fires the engine state changed event into the next handler in the <a href="../EnginePipeline.html" title="interface in org.apache.qpid.protonj2.engine"><code>EnginePipeline</code></a> chain.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#fireFailed(org.apache.qpid.protonj2.engine.exceptions.EngineFailedException)">fireFailed</a></span>​(<a href="../exceptions/EngineFailedException.html" title="class in org.apache.qpid.protonj2.engine.exceptions">EngineFailedException</a> failure)</code></th> |
| <td class="colLast"> |
| <div class="block">Fires the <a href="../Engine.html" title="interface in org.apache.qpid.protonj2.engine"><code>Engine</code></a> failed event into the next handler in the <a href="../EnginePipeline.html" title="interface in org.apache.qpid.protonj2.engine"><code>EnginePipeline</code></a> chain.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#fireRead(org.apache.qpid.protonj2.buffer.ProtonBuffer)">fireRead</a></span>​(<a href="../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a> buffer)</code></th> |
| <td class="colLast"> |
| <div class="block">Fires a read of ProtonBuffer events into the previous handler in the <a href="../EnginePipeline.html" title="interface in org.apache.qpid.protonj2.engine"><code>EnginePipeline</code></a> for further |
| processing.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#fireRead(org.apache.qpid.protonj2.engine.HeaderEnvelope)">fireRead</a></span>​(<a href="../HeaderEnvelope.html" title="class in org.apache.qpid.protonj2.engine">HeaderEnvelope</a> header)</code></th> |
| <td class="colLast"> |
| <div class="block">Fires a read of HeaderFrame events into the previous handler in the <a href="../EnginePipeline.html" title="interface in org.apache.qpid.protonj2.engine"><code>EnginePipeline</code></a> for further |
| processing.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#fireRead(org.apache.qpid.protonj2.engine.IncomingAMQPEnvelope)">fireRead</a></span>​(<a href="../IncomingAMQPEnvelope.html" title="class in org.apache.qpid.protonj2.engine">IncomingAMQPEnvelope</a> envelope)</code></th> |
| <td class="colLast"> |
| <div class="block">Fires a read of IncomingProtocolFrame events into the previous handler in the <a href="../EnginePipeline.html" title="interface in org.apache.qpid.protonj2.engine"><code>EnginePipeline</code></a> for further |
| processing.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#fireRead(org.apache.qpid.protonj2.engine.SASLEnvelope)">fireRead</a></span>​(<a href="../SASLEnvelope.html" title="class in org.apache.qpid.protonj2.engine">SASLEnvelope</a> envelope)</code></th> |
| <td class="colLast"> |
| <div class="block">Fires a read of SASL events into the previous handler in the <a href="../EnginePipeline.html" title="interface in org.apache.qpid.protonj2.engine"><code>EnginePipeline</code></a> for further |
| processing.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#fireWrite(org.apache.qpid.protonj2.buffer.ProtonBuffer,java.lang.Runnable)">fireWrite</a></span>​(<a href="../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a> buffer, |
| java.lang.Runnable ioComplete)</code></th> |
| <td class="colLast"> |
| <div class="block">Fires a write of ProtonBuffer events into the next handler in the <a href="../EnginePipeline.html" title="interface in org.apache.qpid.protonj2.engine"><code>EnginePipeline</code></a> for further |
| processing.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#fireWrite(org.apache.qpid.protonj2.engine.HeaderEnvelope)">fireWrite</a></span>​(<a href="../HeaderEnvelope.html" title="class in org.apache.qpid.protonj2.engine">HeaderEnvelope</a> envelope)</code></th> |
| <td class="colLast"> |
| <div class="block">Fires a write of HeaderFrame events into the next handler in the <a href="../EnginePipeline.html" title="interface in org.apache.qpid.protonj2.engine"><code>EnginePipeline</code></a> for further |
| processing.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#fireWrite(org.apache.qpid.protonj2.engine.OutgoingAMQPEnvelope)">fireWrite</a></span>​(<a href="../OutgoingAMQPEnvelope.html" title="class in org.apache.qpid.protonj2.engine">OutgoingAMQPEnvelope</a> envelope)</code></th> |
| <td class="colLast"> |
| <div class="block">Fires a write of <a href="../OutgoingAMQPEnvelope.html" title="class in org.apache.qpid.protonj2.engine"><code>OutgoingAMQPEnvelope</code></a> events into the next handler in the <a href="../EnginePipeline.html" title="interface in org.apache.qpid.protonj2.engine"><code>EnginePipeline</code></a> for further |
| processing.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#fireWrite(org.apache.qpid.protonj2.engine.SASLEnvelope)">fireWrite</a></span>​(<a href="../SASLEnvelope.html" title="class in org.apache.qpid.protonj2.engine">SASLEnvelope</a> envelope)</code></th> |
| <td class="colLast"> |
| <div class="block">Fires a write of <a href="../SASLEnvelope.html" title="class in org.apache.qpid.protonj2.engine"><code>SASLEnvelope</code></a> events into the next handler in the <a href="../EnginePipeline.html" title="interface in org.apache.qpid.protonj2.engine"><code>EnginePipeline</code></a> for further |
| processing.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code><a href="../EngineHandler.html" title="interface in org.apache.qpid.protonj2.engine">EngineHandler</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#handler()">handler</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#interestMask()">interestMask</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Allows a handler to indicate if it wants to be notified of a Engine Handler events for |
| specific operations or opt into all engine handler events.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code><a href="ProtonEngineHandlerContext.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonEngineHandlerContext</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#interestMask(int)">interestMask</a></span>​(int mask)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#name()">name</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.Object</h3> |
| <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a id="HANDLER_READS"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>HANDLER_READS</h4> |
| <pre>public static final int HANDLER_READS</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../constant-values.html#org.apache.qpid.protonj2.engine.impl.ProtonEngineHandlerContext.HANDLER_READS">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="HANDLER_WRITES"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>HANDLER_WRITES</h4> |
| <pre>public static final int HANDLER_WRITES</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../constant-values.html#org.apache.qpid.protonj2.engine.impl.ProtonEngineHandlerContext.HANDLER_WRITES">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="HANDLER_ALL_EVENTS"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>HANDLER_ALL_EVENTS</h4> |
| <pre>public static final int HANDLER_ALL_EVENTS</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../constant-values.html#org.apache.qpid.protonj2.engine.impl.ProtonEngineHandlerContext.HANDLER_ALL_EVENTS">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a id="<init>(java.lang.String,org.apache.qpid.protonj2.engine.Engine,org.apache.qpid.protonj2.engine.EngineHandler)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>ProtonEngineHandlerContext</h4> |
| <pre>public ProtonEngineHandlerContext​(java.lang.String name, |
| <a href="../Engine.html" title="interface in org.apache.qpid.protonj2.engine">Engine</a> engine, |
| <a href="../EngineHandler.html" title="interface in org.apache.qpid.protonj2.engine">EngineHandler</a> handler)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="handler()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>handler</h4> |
| <pre class="methodSignature">public <a href="../EngineHandler.html" title="interface in org.apache.qpid.protonj2.engine">EngineHandler</a> handler()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../EngineHandlerContext.html#handler()">handler</a></code> in interface <code><a href="../EngineHandlerContext.html" title="interface in org.apache.qpid.protonj2.engine">EngineHandlerContext</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the <a href="../EngineHandler.html" title="interface in org.apache.qpid.protonj2.engine"><code>EngineHandler</code></a> that is associated with the context.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="name()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>name</h4> |
| <pre class="methodSignature">public java.lang.String name()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../EngineHandlerContext.html#name()">name</a></code> in interface <code><a href="../EngineHandlerContext.html" title="interface in org.apache.qpid.protonj2.engine">EngineHandlerContext</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the name that assigned to this <a href="../EngineHandler.html" title="interface in org.apache.qpid.protonj2.engine"><code>EngineHandler</code></a> when added to the <a href="../EnginePipeline.html" title="interface in org.apache.qpid.protonj2.engine"><code>EnginePipeline</code></a>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="engine()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>engine</h4> |
| <pre class="methodSignature">public <a href="../Engine.html" title="interface in org.apache.qpid.protonj2.engine">Engine</a> engine()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../EngineHandlerContext.html#engine()">engine</a></code> in interface <code><a href="../EngineHandlerContext.html" title="interface in org.apache.qpid.protonj2.engine">EngineHandlerContext</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the <a href="../Engine.html" title="interface in org.apache.qpid.protonj2.engine"><code>Engine</code></a> where this handler is registered.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="interestMask()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>interestMask</h4> |
| <pre class="methodSignature">public int interestMask()</pre> |
| <div class="block">Allows a handler to indicate if it wants to be notified of a Engine Handler events for |
| specific operations or opt into all engine handler events. By opting out of the events |
| that the handler does not process the call chain can be reduced when processing engine |
| events.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the interest mask that should be used to determine if a handler should be signaled.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="interestMask(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>interestMask</h4> |
| <pre class="methodSignature">public <a href="ProtonEngineHandlerContext.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonEngineHandlerContext</a> interestMask​(int mask)</pre> |
| </li> |
| </ul> |
| <a id="fireEngineStarting()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>fireEngineStarting</h4> |
| <pre class="methodSignature">public void fireEngineStarting()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../EngineHandlerContext.html#fireEngineStarting()">EngineHandlerContext</a></code></span></div> |
| <div class="block">Fires the engine starting event into the next handler in the <a href="../EnginePipeline.html" title="interface in org.apache.qpid.protonj2.engine"><code>EnginePipeline</code></a> chain.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../EngineHandlerContext.html#fireEngineStarting()">fireEngineStarting</a></code> in interface <code><a href="../EngineHandlerContext.html" title="interface in org.apache.qpid.protonj2.engine">EngineHandlerContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="fireEngineStateChanged()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>fireEngineStateChanged</h4> |
| <pre class="methodSignature">public void fireEngineStateChanged()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../EngineHandlerContext.html#fireEngineStateChanged()">EngineHandlerContext</a></code></span></div> |
| <div class="block">Fires the engine state changed event into the next handler in the <a href="../EnginePipeline.html" title="interface in org.apache.qpid.protonj2.engine"><code>EnginePipeline</code></a> chain. The |
| state change events occur after the engine starting event and generally signify that the engine has been |
| shutdown normally.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../EngineHandlerContext.html#fireEngineStateChanged()">fireEngineStateChanged</a></code> in interface <code><a href="../EngineHandlerContext.html" title="interface in org.apache.qpid.protonj2.engine">EngineHandlerContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="fireFailed(org.apache.qpid.protonj2.engine.exceptions.EngineFailedException)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>fireFailed</h4> |
| <pre class="methodSignature">public void fireFailed​(<a href="../exceptions/EngineFailedException.html" title="class in org.apache.qpid.protonj2.engine.exceptions">EngineFailedException</a> failure)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../EngineHandlerContext.html#fireFailed(org.apache.qpid.protonj2.engine.exceptions.EngineFailedException)">EngineHandlerContext</a></code></span></div> |
| <div class="block">Fires the <a href="../Engine.html" title="interface in org.apache.qpid.protonj2.engine"><code>Engine</code></a> failed event into the next handler in the <a href="../EnginePipeline.html" title="interface in org.apache.qpid.protonj2.engine"><code>EnginePipeline</code></a> chain.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../EngineHandlerContext.html#fireFailed(org.apache.qpid.protonj2.engine.exceptions.EngineFailedException)">fireFailed</a></code> in interface <code><a href="../EngineHandlerContext.html" title="interface in org.apache.qpid.protonj2.engine">EngineHandlerContext</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>failure</code> - The exception that describes the conditions under which the engine failed.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="fireRead(org.apache.qpid.protonj2.buffer.ProtonBuffer)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>fireRead</h4> |
| <pre class="methodSignature">public void fireRead​(<a href="../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a> buffer)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../EngineHandlerContext.html#fireRead(org.apache.qpid.protonj2.buffer.ProtonBuffer)">EngineHandlerContext</a></code></span></div> |
| <div class="block">Fires a read of ProtonBuffer events into the previous handler in the <a href="../EnginePipeline.html" title="interface in org.apache.qpid.protonj2.engine"><code>EnginePipeline</code></a> for further |
| processing.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../EngineHandlerContext.html#fireRead(org.apache.qpid.protonj2.buffer.ProtonBuffer)">fireRead</a></code> in interface <code><a href="../EngineHandlerContext.html" title="interface in org.apache.qpid.protonj2.engine">EngineHandlerContext</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>buffer</code> - The <a href="../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer"><code>ProtonBuffer</code></a> that carries the bytes read.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="fireRead(org.apache.qpid.protonj2.engine.HeaderEnvelope)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>fireRead</h4> |
| <pre class="methodSignature">public void fireRead​(<a href="../HeaderEnvelope.html" title="class in org.apache.qpid.protonj2.engine">HeaderEnvelope</a> header)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../EngineHandlerContext.html#fireRead(org.apache.qpid.protonj2.engine.HeaderEnvelope)">EngineHandlerContext</a></code></span></div> |
| <div class="block">Fires a read of HeaderFrame events into the previous handler in the <a href="../EnginePipeline.html" title="interface in org.apache.qpid.protonj2.engine"><code>EnginePipeline</code></a> for further |
| processing.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../EngineHandlerContext.html#fireRead(org.apache.qpid.protonj2.engine.HeaderEnvelope)">fireRead</a></code> in interface <code><a href="../EngineHandlerContext.html" title="interface in org.apache.qpid.protonj2.engine">EngineHandlerContext</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>header</code> - The <a href="../HeaderEnvelope.html" title="class in org.apache.qpid.protonj2.engine"><code>HeaderEnvelope</code></a> that carries the header bytes read.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="fireRead(org.apache.qpid.protonj2.engine.SASLEnvelope)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>fireRead</h4> |
| <pre class="methodSignature">public void fireRead​(<a href="../SASLEnvelope.html" title="class in org.apache.qpid.protonj2.engine">SASLEnvelope</a> envelope)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../EngineHandlerContext.html#fireRead(org.apache.qpid.protonj2.engine.SASLEnvelope)">EngineHandlerContext</a></code></span></div> |
| <div class="block">Fires a read of SASL events into the previous handler in the <a href="../EnginePipeline.html" title="interface in org.apache.qpid.protonj2.engine"><code>EnginePipeline</code></a> for further |
| processing.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../EngineHandlerContext.html#fireRead(org.apache.qpid.protonj2.engine.SASLEnvelope)">fireRead</a></code> in interface <code><a href="../EngineHandlerContext.html" title="interface in org.apache.qpid.protonj2.engine">EngineHandlerContext</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>envelope</code> - The <a href="../SASLEnvelope.html" title="class in org.apache.qpid.protonj2.engine"><code>SASLEnvelope</code></a> that carries the SASL performative read.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="fireRead(org.apache.qpid.protonj2.engine.IncomingAMQPEnvelope)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>fireRead</h4> |
| <pre class="methodSignature">public void fireRead​(<a href="../IncomingAMQPEnvelope.html" title="class in org.apache.qpid.protonj2.engine">IncomingAMQPEnvelope</a> envelope)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../EngineHandlerContext.html#fireRead(org.apache.qpid.protonj2.engine.IncomingAMQPEnvelope)">EngineHandlerContext</a></code></span></div> |
| <div class="block">Fires a read of IncomingProtocolFrame events into the previous handler in the <a href="../EnginePipeline.html" title="interface in org.apache.qpid.protonj2.engine"><code>EnginePipeline</code></a> for further |
| processing.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../EngineHandlerContext.html#fireRead(org.apache.qpid.protonj2.engine.IncomingAMQPEnvelope)">fireRead</a></code> in interface <code><a href="../EngineHandlerContext.html" title="interface in org.apache.qpid.protonj2.engine">EngineHandlerContext</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>envelope</code> - The <a href="../IncomingAMQPEnvelope.html" title="class in org.apache.qpid.protonj2.engine"><code>IncomingAMQPEnvelope</code></a> that carries the AMQP performative read.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="fireWrite(org.apache.qpid.protonj2.engine.OutgoingAMQPEnvelope)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>fireWrite</h4> |
| <pre class="methodSignature">public void fireWrite​(<a href="../OutgoingAMQPEnvelope.html" title="class in org.apache.qpid.protonj2.engine">OutgoingAMQPEnvelope</a> envelope)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../EngineHandlerContext.html#fireWrite(org.apache.qpid.protonj2.engine.OutgoingAMQPEnvelope)">EngineHandlerContext</a></code></span></div> |
| <div class="block">Fires a write of <a href="../OutgoingAMQPEnvelope.html" title="class in org.apache.qpid.protonj2.engine"><code>OutgoingAMQPEnvelope</code></a> events into the next handler in the <a href="../EnginePipeline.html" title="interface in org.apache.qpid.protonj2.engine"><code>EnginePipeline</code></a> for further |
| processing.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../EngineHandlerContext.html#fireWrite(org.apache.qpid.protonj2.engine.OutgoingAMQPEnvelope)">fireWrite</a></code> in interface <code><a href="../EngineHandlerContext.html" title="interface in org.apache.qpid.protonj2.engine">EngineHandlerContext</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>envelope</code> - The <a href="../OutgoingAMQPEnvelope.html" title="class in org.apache.qpid.protonj2.engine"><code>OutgoingAMQPEnvelope</code></a> that carries the AMQP performative being written.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="fireWrite(org.apache.qpid.protonj2.engine.SASLEnvelope)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>fireWrite</h4> |
| <pre class="methodSignature">public void fireWrite​(<a href="../SASLEnvelope.html" title="class in org.apache.qpid.protonj2.engine">SASLEnvelope</a> envelope)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../EngineHandlerContext.html#fireWrite(org.apache.qpid.protonj2.engine.SASLEnvelope)">EngineHandlerContext</a></code></span></div> |
| <div class="block">Fires a write of <a href="../SASLEnvelope.html" title="class in org.apache.qpid.protonj2.engine"><code>SASLEnvelope</code></a> events into the next handler in the <a href="../EnginePipeline.html" title="interface in org.apache.qpid.protonj2.engine"><code>EnginePipeline</code></a> for further |
| processing.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../EngineHandlerContext.html#fireWrite(org.apache.qpid.protonj2.engine.SASLEnvelope)">fireWrite</a></code> in interface <code><a href="../EngineHandlerContext.html" title="interface in org.apache.qpid.protonj2.engine">EngineHandlerContext</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>envelope</code> - The <a href="../SASLEnvelope.html" title="class in org.apache.qpid.protonj2.engine"><code>SASLEnvelope</code></a> that carries the SASL performative being written.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="fireWrite(org.apache.qpid.protonj2.engine.HeaderEnvelope)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>fireWrite</h4> |
| <pre class="methodSignature">public void fireWrite​(<a href="../HeaderEnvelope.html" title="class in org.apache.qpid.protonj2.engine">HeaderEnvelope</a> envelope)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../EngineHandlerContext.html#fireWrite(org.apache.qpid.protonj2.engine.HeaderEnvelope)">EngineHandlerContext</a></code></span></div> |
| <div class="block">Fires a write of HeaderFrame events into the next handler in the <a href="../EnginePipeline.html" title="interface in org.apache.qpid.protonj2.engine"><code>EnginePipeline</code></a> for further |
| processing.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../EngineHandlerContext.html#fireWrite(org.apache.qpid.protonj2.engine.HeaderEnvelope)">fireWrite</a></code> in interface <code><a href="../EngineHandlerContext.html" title="interface in org.apache.qpid.protonj2.engine">EngineHandlerContext</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>envelope</code> - The <a href="../HeaderEnvelope.html" title="class in org.apache.qpid.protonj2.engine"><code>HeaderEnvelope</code></a> that carries the AMQP Header being written.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="fireWrite(org.apache.qpid.protonj2.buffer.ProtonBuffer,java.lang.Runnable)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>fireWrite</h4> |
| <pre class="methodSignature">public void fireWrite​(<a href="../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a> buffer, |
| java.lang.Runnable ioComplete)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../EngineHandlerContext.html#fireWrite(org.apache.qpid.protonj2.buffer.ProtonBuffer,java.lang.Runnable)">EngineHandlerContext</a></code></span></div> |
| <div class="block">Fires a write of ProtonBuffer events into the next handler in the <a href="../EnginePipeline.html" title="interface in org.apache.qpid.protonj2.engine"><code>EnginePipeline</code></a> for further |
| processing.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../EngineHandlerContext.html#fireWrite(org.apache.qpid.protonj2.buffer.ProtonBuffer,java.lang.Runnable)">fireWrite</a></code> in interface <code><a href="../EngineHandlerContext.html" title="interface in org.apache.qpid.protonj2.engine">EngineHandlerContext</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>buffer</code> - The <a href="../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer"><code>ProtonBuffer</code></a> that carries the bytes being written.</dd> |
| <dd><code>ioComplete</code> - An optional <code>Runnable</code> callback that is signaled when the I/O completes successfully.</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </main> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/ProtonEngineHandlerContext.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 2021 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |