| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>ProtonEnginePipeline (Qpid ProtonJ2 Parent 1.0.0-M9 API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="ProtonEnginePipeline (Qpid ProtonJ2 Parent 1.0.0-M9 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,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":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"; |
| </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/ProtonEnginePipeline.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="../../../../../../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> |
| <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>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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 ProtonEnginePipeline" class="title">Class ProtonEnginePipeline</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.qpid.protonj2.engine.impl.ProtonEnginePipeline</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="../EnginePipeline.html" title="interface in org.apache.qpid.protonj2.engine">EnginePipeline</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public class <span class="typeNameLabel">ProtonEnginePipeline</span> |
| extends <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> |
| implements <a href="../EnginePipeline.html" title="interface in org.apache.qpid.protonj2.engine">EnginePipeline</a></pre> |
| <div class="block">Pipeline of <a href="../EngineHandler.html" title="interface in org.apache.qpid.protonj2.engine"><code>EngineHandler</code></a> instances used to process IO</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== 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="ProtonEnginePipeline.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonEnginePipeline</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addFirst(java.lang.String,org.apache.qpid.protonj2.engine.EngineHandler)">addFirst</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> name, |
| <a href="../EngineHandler.html" title="interface in org.apache.qpid.protonj2.engine">EngineHandler</a> handler)</code></th> |
| <td class="colLast"> |
| <div class="block">Adds the given handler to the front of the pipeline with the given name stored for |
| later lookup or remove operations.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="ProtonEnginePipeline.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonEnginePipeline</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addLast(java.lang.String,org.apache.qpid.protonj2.engine.EngineHandler)">addLast</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> name, |
| <a href="../EngineHandler.html" title="interface in org.apache.qpid.protonj2.engine">EngineHandler</a> handler)</code></th> |
| <td class="colLast"> |
| <div class="block">Adds the given handler to the end of the pipeline with the given name stored for |
| later lookup or remove operations.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="ProtonEngine.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonEngine</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="i3" class="rowColor"> |
| <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="#find(java.lang.String)">find</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> name)</code></th> |
| <td class="colLast"> |
| <div class="block">Finds and returns first handler that is found in the pipeline that matches the given name.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="ProtonEnginePipeline.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonEnginePipeline</a></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 an engine starting event to each handler in the pipeline.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="ProtonEnginePipeline.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonEnginePipeline</a></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 an engine state changed event to each handler in the pipeline.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="ProtonEnginePipeline.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonEnginePipeline</a></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> e)</code></th> |
| <td class="colLast"> |
| <div class="block">Fires an engine failed event into each <a href="../EngineHandler.html" title="interface in org.apache.qpid.protonj2.engine"><code>EngineHandler</code></a> in the pipeline indicating |
| that the engine is now failed and should not accept or produce new work.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="ProtonEnginePipeline.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonEnginePipeline</a></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> input)</code></th> |
| <td class="colLast"> |
| <div class="block">Fires a read event consisting of the given <a href="../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer"><code>ProtonBuffer</code></a> into the pipeline starting |
| from the last <a href="../EngineHandler.html" title="interface in org.apache.qpid.protonj2.engine"><code>EngineHandler</code></a> in the pipeline and moving through each until the incoming |
| work is fully processed.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="ProtonEnginePipeline.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonEnginePipeline</a></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 event consisting of the given <a href="../HeaderEnvelope.html" title="class in org.apache.qpid.protonj2.engine"><code>HeaderEnvelope</code></a> into the pipeline starting |
| from the last <a href="../EngineHandler.html" title="interface in org.apache.qpid.protonj2.engine"><code>EngineHandler</code></a> in the pipeline and moving through each until the incoming |
| work is fully processed.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="ProtonEnginePipeline.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonEnginePipeline</a></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 event consisting of the given <a href="../IncomingAMQPEnvelope.html" title="class in org.apache.qpid.protonj2.engine"><code>IncomingAMQPEnvelope</code></a> into the pipeline starting |
| from the last <a href="../EngineHandler.html" title="interface in org.apache.qpid.protonj2.engine"><code>EngineHandler</code></a> in the pipeline and moving through each until the incoming |
| work is fully processed.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><a href="ProtonEnginePipeline.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonEnginePipeline</a></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 event consisting of the given <a href="../SASLEnvelope.html" title="class in org.apache.qpid.protonj2.engine"><code>SASLEnvelope</code></a> into the pipeline starting |
| from the last <a href="../EngineHandler.html" title="interface in org.apache.qpid.protonj2.engine"><code>EngineHandler</code></a> in the pipeline and moving through each until the incoming |
| work is fully processed.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code><a href="ProtonEnginePipeline.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonEnginePipeline</a></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, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Runnable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Runnable</a> ioComplete)</code></th> |
| <td class="colLast"> |
| <div class="block">Fires a write event consisting of the given <a href="../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer"><code>ProtonBuffer</code></a> into the pipeline starting |
| from the first <a href="../EngineHandler.html" title="interface in org.apache.qpid.protonj2.engine"><code>EngineHandler</code></a> in the pipeline and moving through each until the outgoing |
| work is fully processed.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code><a href="ProtonEnginePipeline.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonEnginePipeline</a></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 event consisting of the given <a href="../HeaderEnvelope.html" title="class in org.apache.qpid.protonj2.engine"><code>HeaderEnvelope</code></a> into the pipeline starting |
| from the first <a href="../EngineHandler.html" title="interface in org.apache.qpid.protonj2.engine"><code>EngineHandler</code></a> in the pipeline and moving through each until the outgoing |
| work is fully processed.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code><a href="ProtonEnginePipeline.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonEnginePipeline</a></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 event consisting of the given <a href="../OutgoingAMQPEnvelope.html" title="class in org.apache.qpid.protonj2.engine"><code>OutgoingAMQPEnvelope</code></a> into the pipeline starting |
| from the first <a href="../EngineHandler.html" title="interface in org.apache.qpid.protonj2.engine"><code>EngineHandler</code></a> in the pipeline and moving through each until the outgoing |
| work is fully processed.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code><a href="ProtonEnginePipeline.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonEnginePipeline</a></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 event consisting of the given <a href="../SASLEnvelope.html" title="class in org.apache.qpid.protonj2.engine"><code>SASLEnvelope</code></a> into the pipeline starting |
| from the first <a href="../EngineHandler.html" title="interface in org.apache.qpid.protonj2.engine"><code>EngineHandler</code></a> in the pipeline and moving through each until the outgoing |
| work is fully processed.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <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="#first()">first</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code><a href="../EngineHandlerContext.html" title="interface in org.apache.qpid.protonj2.engine">EngineHandlerContext</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#firstContext()">firstContext</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <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="#last()">last</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code><a href="../EngineHandlerContext.html" title="interface in org.apache.qpid.protonj2.engine">EngineHandlerContext</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#lastContext()">lastContext</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code><a href="ProtonEnginePipeline.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonEnginePipeline</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#remove(java.lang.String)">remove</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> name)</code></th> |
| <td class="colLast"> |
| <div class="block">Removes the first handler that is found in the pipeline that matches the given name.</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code><a href="../EnginePipeline.html" title="interface in org.apache.qpid.protonj2.engine">EnginePipeline</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#remove(org.apache.qpid.protonj2.engine.EngineHandler)">remove</a></span>​(<a href="../EngineHandler.html" title="interface in org.apache.qpid.protonj2.engine">EngineHandler</a> handler)</code></th> |
| <td class="colLast"> |
| <div class="block">Removes the given <a href="../EngineHandler.html" title="interface in org.apache.qpid.protonj2.engine"><code>EngineHandler</code></a> from the pipeline if present.</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code><a href="ProtonEnginePipeline.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonEnginePipeline</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeFirst()">removeFirst</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Removes the first <a href="../EngineHandler.html" title="interface in org.apache.qpid.protonj2.engine"><code>EngineHandler</code></a> in the pipeline.</div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code><a href="ProtonEnginePipeline.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonEnginePipeline</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeLast()">removeLast</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Removes the last <a href="../EngineHandler.html" title="interface in org.apache.qpid.protonj2.engine"><code>EngineHandler</code></a> in the pipeline.</div> |
| </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.<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang" class="externalLink">toString</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="engine()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>engine</h4> |
| <pre class="methodSignature">public <a href="ProtonEngine.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonEngine</a> engine()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../EnginePipeline.html#engine()">engine</a></code> in interface <code><a href="../EnginePipeline.html" title="interface in org.apache.qpid.protonj2.engine">EnginePipeline</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> that this pipeline is linked to.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="addFirst(java.lang.String,org.apache.qpid.protonj2.engine.EngineHandler)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addFirst</h4> |
| <pre class="methodSignature">public <a href="ProtonEnginePipeline.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonEnginePipeline</a> addFirst​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> name, |
| <a href="../EngineHandler.html" title="interface in org.apache.qpid.protonj2.engine">EngineHandler</a> handler)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../EnginePipeline.html#addFirst(java.lang.String,org.apache.qpid.protonj2.engine.EngineHandler)">EnginePipeline</a></code></span></div> |
| <div class="block">Adds the given handler to the front of the pipeline with the given name stored for |
| later lookup or remove operations. It is not mandatory that each handler have unique |
| names although if handlers do share a name the <a href="../EnginePipeline.html#remove(java.lang.String)"><code>EnginePipeline.remove(String)</code></a> |
| method will only remove them one at a time starting from the first in the pipeline.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../EnginePipeline.html#addFirst(java.lang.String,org.apache.qpid.protonj2.engine.EngineHandler)">addFirst</a></code> in interface <code><a href="../EnginePipeline.html" title="interface in org.apache.qpid.protonj2.engine">EnginePipeline</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - The name to assign to the handler</dd> |
| <dd><code>handler</code> - The <a href="../EngineHandler.html" title="interface in org.apache.qpid.protonj2.engine"><code>EngineHandler</code></a> to add into the pipeline.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this <a href="../EnginePipeline.html" title="interface in org.apache.qpid.protonj2.engine"><code>EnginePipeline</code></a>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="addLast(java.lang.String,org.apache.qpid.protonj2.engine.EngineHandler)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addLast</h4> |
| <pre class="methodSignature">public <a href="ProtonEnginePipeline.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonEnginePipeline</a> addLast​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> name, |
| <a href="../EngineHandler.html" title="interface in org.apache.qpid.protonj2.engine">EngineHandler</a> handler)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../EnginePipeline.html#addLast(java.lang.String,org.apache.qpid.protonj2.engine.EngineHandler)">EnginePipeline</a></code></span></div> |
| <div class="block">Adds the given handler to the end of the pipeline with the given name stored for |
| later lookup or remove operations. It is not mandatory that each handler have unique |
| names although if handlers do share a name the <a href="../EnginePipeline.html#remove(java.lang.String)"><code>EnginePipeline.remove(String)</code></a> |
| method will only remove them one at a time starting from the first in the pipeline.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../EnginePipeline.html#addLast(java.lang.String,org.apache.qpid.protonj2.engine.EngineHandler)">addLast</a></code> in interface <code><a href="../EnginePipeline.html" title="interface in org.apache.qpid.protonj2.engine">EnginePipeline</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - The name to assign to the handler</dd> |
| <dd><code>handler</code> - The <a href="../EngineHandler.html" title="interface in org.apache.qpid.protonj2.engine"><code>EngineHandler</code></a> to add into the pipeline.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this <a href="../EnginePipeline.html" title="interface in org.apache.qpid.protonj2.engine"><code>EnginePipeline</code></a>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="removeFirst()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeFirst</h4> |
| <pre class="methodSignature">public <a href="ProtonEnginePipeline.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonEnginePipeline</a> removeFirst()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../EnginePipeline.html#removeFirst()">EnginePipeline</a></code></span></div> |
| <div class="block">Removes the first <a href="../EngineHandler.html" title="interface in org.apache.qpid.protonj2.engine"><code>EngineHandler</code></a> in the pipeline.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../EnginePipeline.html#removeFirst()">removeFirst</a></code> in interface <code><a href="../EnginePipeline.html" title="interface in org.apache.qpid.protonj2.engine">EnginePipeline</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this <a href="../EnginePipeline.html" title="interface in org.apache.qpid.protonj2.engine"><code>EnginePipeline</code></a>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="removeLast()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeLast</h4> |
| <pre class="methodSignature">public <a href="ProtonEnginePipeline.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonEnginePipeline</a> removeLast()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../EnginePipeline.html#removeLast()">EnginePipeline</a></code></span></div> |
| <div class="block">Removes the last <a href="../EngineHandler.html" title="interface in org.apache.qpid.protonj2.engine"><code>EngineHandler</code></a> in the pipeline.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../EnginePipeline.html#removeLast()">removeLast</a></code> in interface <code><a href="../EnginePipeline.html" title="interface in org.apache.qpid.protonj2.engine">EnginePipeline</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this <a href="../EnginePipeline.html" title="interface in org.apache.qpid.protonj2.engine"><code>EnginePipeline</code></a>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="remove(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>remove</h4> |
| <pre class="methodSignature">public <a href="ProtonEnginePipeline.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonEnginePipeline</a> remove​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> name)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../EnginePipeline.html#remove(java.lang.String)">EnginePipeline</a></code></span></div> |
| <div class="block">Removes the first handler that is found in the pipeline that matches the given name.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../EnginePipeline.html#remove(java.lang.String)">remove</a></code> in interface <code><a href="../EnginePipeline.html" title="interface in org.apache.qpid.protonj2.engine">EnginePipeline</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - The name to search for in the pipeline moving from first to last.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this <a href="../EnginePipeline.html" title="interface in org.apache.qpid.protonj2.engine"><code>EnginePipeline</code></a>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="remove(org.apache.qpid.protonj2.engine.EngineHandler)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>remove</h4> |
| <pre class="methodSignature">public <a href="../EnginePipeline.html" title="interface in org.apache.qpid.protonj2.engine">EnginePipeline</a> remove​(<a href="../EngineHandler.html" title="interface in org.apache.qpid.protonj2.engine">EngineHandler</a> handler)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../EnginePipeline.html#remove(org.apache.qpid.protonj2.engine.EngineHandler)">EnginePipeline</a></code></span></div> |
| <div class="block">Removes the given <a href="../EngineHandler.html" title="interface in org.apache.qpid.protonj2.engine"><code>EngineHandler</code></a> from the pipeline if present.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../EnginePipeline.html#remove(org.apache.qpid.protonj2.engine.EngineHandler)">remove</a></code> in interface <code><a href="../EnginePipeline.html" title="interface in org.apache.qpid.protonj2.engine">EnginePipeline</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>handler</code> - The handler instance to remove if contained in the pipeline.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this <a href="../EnginePipeline.html" title="interface in org.apache.qpid.protonj2.engine"><code>EnginePipeline</code></a>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="find(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>find</h4> |
| <pre class="methodSignature">public <a href="../EngineHandler.html" title="interface in org.apache.qpid.protonj2.engine">EngineHandler</a> find​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> name)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../EnginePipeline.html#find(java.lang.String)">EnginePipeline</a></code></span></div> |
| <div class="block">Finds and returns first handler that is found in the pipeline that matches the given name.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../EnginePipeline.html#find(java.lang.String)">find</a></code> in interface <code><a href="../EnginePipeline.html" title="interface in org.apache.qpid.protonj2.engine">EnginePipeline</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - The name to search for in the pipeline moving from first to last.</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 matches the given name or null if none in the pipeline.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="first()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>first</h4> |
| <pre class="methodSignature">public <a href="../EngineHandler.html" title="interface in org.apache.qpid.protonj2.engine">EngineHandler</a> first()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../EnginePipeline.html#first()">first</a></code> in interface <code><a href="../EnginePipeline.html" title="interface in org.apache.qpid.protonj2.engine">EnginePipeline</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the first <a href="../EngineHandler.html" title="interface in org.apache.qpid.protonj2.engine"><code>EngineHandler</code></a> in the pipeline or null if empty.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="last()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>last</h4> |
| <pre class="methodSignature">public <a href="../EngineHandler.html" title="interface in org.apache.qpid.protonj2.engine">EngineHandler</a> last()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../EnginePipeline.html#last()">last</a></code> in interface <code><a href="../EnginePipeline.html" title="interface in org.apache.qpid.protonj2.engine">EnginePipeline</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the last <a href="../EngineHandler.html" title="interface in org.apache.qpid.protonj2.engine"><code>EngineHandler</code></a> in the pipeline or null if empty.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="firstContext()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>firstContext</h4> |
| <pre class="methodSignature">public <a href="../EngineHandlerContext.html" title="interface in org.apache.qpid.protonj2.engine">EngineHandlerContext</a> firstContext()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../EnginePipeline.html#firstContext()">firstContext</a></code> in interface <code><a href="../EnginePipeline.html" title="interface in org.apache.qpid.protonj2.engine">EnginePipeline</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the first <a href="../EngineHandlerContext.html" title="interface in org.apache.qpid.protonj2.engine"><code>EngineHandlerContext</code></a> in the pipeline or null if empty.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="lastContext()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>lastContext</h4> |
| <pre class="methodSignature">public <a href="../EngineHandlerContext.html" title="interface in org.apache.qpid.protonj2.engine">EngineHandlerContext</a> lastContext()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../EnginePipeline.html#lastContext()">lastContext</a></code> in interface <code><a href="../EnginePipeline.html" title="interface in org.apache.qpid.protonj2.engine">EnginePipeline</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the last <a href="../EngineHandlerContext.html" title="interface in org.apache.qpid.protonj2.engine"><code>EngineHandlerContext</code></a> in the pipeline or null if empty.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="fireEngineStarting()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>fireEngineStarting</h4> |
| <pre class="methodSignature">public <a href="ProtonEnginePipeline.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonEnginePipeline</a> fireEngineStarting()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../EnginePipeline.html#fireEngineStarting()">EnginePipeline</a></code></span></div> |
| <div class="block">Fires an engine starting event to each handler in the pipeline. Should be used |
| by the engine implementation to signal its handlers that they should initialize.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../EnginePipeline.html#fireEngineStarting()">fireEngineStarting</a></code> in interface <code><a href="../EnginePipeline.html" title="interface in org.apache.qpid.protonj2.engine">EnginePipeline</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this <a href="../EnginePipeline.html" title="interface in org.apache.qpid.protonj2.engine"><code>EnginePipeline</code></a>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="fireEngineStateChanged()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>fireEngineStateChanged</h4> |
| <pre class="methodSignature">public <a href="ProtonEnginePipeline.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonEnginePipeline</a> fireEngineStateChanged()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../EnginePipeline.html#fireEngineStateChanged()">EnginePipeline</a></code></span></div> |
| <div class="block">Fires an engine state changed event to each handler in the pipeline. Should be used |
| by the engine implementation to signal its handlers that they should respond to the new |
| engine state, e.g. the engine failed or was shutdown.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../EnginePipeline.html#fireEngineStateChanged()">fireEngineStateChanged</a></code> in interface <code><a href="../EnginePipeline.html" title="interface in org.apache.qpid.protonj2.engine">EnginePipeline</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this <a href="../EnginePipeline.html" title="interface in org.apache.qpid.protonj2.engine"><code>EnginePipeline</code></a>.</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 <a href="ProtonEnginePipeline.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonEnginePipeline</a> fireFailed​(<a href="../exceptions/EngineFailedException.html" title="class in org.apache.qpid.protonj2.engine.exceptions">EngineFailedException</a> e)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../EnginePipeline.html#fireFailed(org.apache.qpid.protonj2.engine.exceptions.EngineFailedException)">EnginePipeline</a></code></span></div> |
| <div class="block">Fires an engine failed event into each <a href="../EngineHandler.html" title="interface in org.apache.qpid.protonj2.engine"><code>EngineHandler</code></a> in the pipeline indicating |
| that the engine is now failed and should not accept or produce new work.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../EnginePipeline.html#fireFailed(org.apache.qpid.protonj2.engine.exceptions.EngineFailedException)">fireFailed</a></code> in interface <code><a href="../EnginePipeline.html" title="interface in org.apache.qpid.protonj2.engine">EnginePipeline</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>e</code> - The cause of the engine failure.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this <a href="../EnginePipeline.html" title="interface in org.apache.qpid.protonj2.engine"><code>EnginePipeline</code></a>.</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 <a href="ProtonEnginePipeline.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonEnginePipeline</a> fireRead​(<a href="../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a> input)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../EnginePipeline.html#fireRead(org.apache.qpid.protonj2.buffer.ProtonBuffer)">EnginePipeline</a></code></span></div> |
| <div class="block">Fires a read event consisting of the given <a href="../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer"><code>ProtonBuffer</code></a> into the pipeline starting |
| from the last <a href="../EngineHandler.html" title="interface in org.apache.qpid.protonj2.engine"><code>EngineHandler</code></a> in the pipeline and moving through each until the incoming |
| work is fully processed. If the read events reaches the head of the pipeline and is not handled |
| by any handler an error is thrown and the engine should enter the failed state.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../EnginePipeline.html#fireRead(org.apache.qpid.protonj2.buffer.ProtonBuffer)">fireRead</a></code> in interface <code><a href="../EnginePipeline.html" title="interface in org.apache.qpid.protonj2.engine">EnginePipeline</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>input</code> - The <a href="../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer"><code>ProtonBuffer</code></a> to inject into the engine pipeline.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this <a href="../EnginePipeline.html" title="interface in org.apache.qpid.protonj2.engine"><code>EnginePipeline</code></a>.</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 <a href="ProtonEnginePipeline.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonEnginePipeline</a> 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="../EnginePipeline.html#fireRead(org.apache.qpid.protonj2.engine.HeaderEnvelope)">EnginePipeline</a></code></span></div> |
| <div class="block">Fires a read event consisting of the given <a href="../HeaderEnvelope.html" title="class in org.apache.qpid.protonj2.engine"><code>HeaderEnvelope</code></a> into the pipeline starting |
| from the last <a href="../EngineHandler.html" title="interface in org.apache.qpid.protonj2.engine"><code>EngineHandler</code></a> in the pipeline and moving through each until the incoming |
| work is fully processed. If the read events reaches the head of the pipeline and is not handled |
| by any handler an error is thrown and the engine should enter the failed state.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../EnginePipeline.html#fireRead(org.apache.qpid.protonj2.engine.HeaderEnvelope)">fireRead</a></code> in interface <code><a href="../EnginePipeline.html" title="interface in org.apache.qpid.protonj2.engine">EnginePipeline</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> to inject into the engine pipeline.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this <a href="../EnginePipeline.html" title="interface in org.apache.qpid.protonj2.engine"><code>EnginePipeline</code></a>.</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 <a href="ProtonEnginePipeline.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonEnginePipeline</a> 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="../EnginePipeline.html#fireRead(org.apache.qpid.protonj2.engine.SASLEnvelope)">EnginePipeline</a></code></span></div> |
| <div class="block">Fires a read event consisting of the given <a href="../SASLEnvelope.html" title="class in org.apache.qpid.protonj2.engine"><code>SASLEnvelope</code></a> into the pipeline starting |
| from the last <a href="../EngineHandler.html" title="interface in org.apache.qpid.protonj2.engine"><code>EngineHandler</code></a> in the pipeline and moving through each until the incoming |
| work is fully processed. If the read events reaches the head of the pipeline and is not handled |
| by any handler an error is thrown and the engine should enter the failed state.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../EnginePipeline.html#fireRead(org.apache.qpid.protonj2.engine.SASLEnvelope)">fireRead</a></code> in interface <code><a href="../EnginePipeline.html" title="interface in org.apache.qpid.protonj2.engine">EnginePipeline</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> to inject into the engine pipeline.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this <a href="../EnginePipeline.html" title="interface in org.apache.qpid.protonj2.engine"><code>EnginePipeline</code></a>.</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 <a href="ProtonEnginePipeline.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonEnginePipeline</a> 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="../EnginePipeline.html#fireRead(org.apache.qpid.protonj2.engine.IncomingAMQPEnvelope)">EnginePipeline</a></code></span></div> |
| <div class="block">Fires a read event consisting of the given <a href="../IncomingAMQPEnvelope.html" title="class in org.apache.qpid.protonj2.engine"><code>IncomingAMQPEnvelope</code></a> into the pipeline starting |
| from the last <a href="../EngineHandler.html" title="interface in org.apache.qpid.protonj2.engine"><code>EngineHandler</code></a> in the pipeline and moving through each until the incoming |
| work is fully processed. If the read events reaches the head of the pipeline and is not handled |
| by any handler an error is thrown and the engine should enter the failed state.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../EnginePipeline.html#fireRead(org.apache.qpid.protonj2.engine.IncomingAMQPEnvelope)">fireRead</a></code> in interface <code><a href="../EnginePipeline.html" title="interface in org.apache.qpid.protonj2.engine">EnginePipeline</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> to inject into the engine pipeline.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this <a href="../EnginePipeline.html" title="interface in org.apache.qpid.protonj2.engine"><code>EnginePipeline</code></a>.</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 <a href="ProtonEnginePipeline.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonEnginePipeline</a> 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="../EnginePipeline.html#fireWrite(org.apache.qpid.protonj2.engine.HeaderEnvelope)">EnginePipeline</a></code></span></div> |
| <div class="block">Fires a write event consisting of the given <a href="../HeaderEnvelope.html" title="class in org.apache.qpid.protonj2.engine"><code>HeaderEnvelope</code></a> into the pipeline starting |
| from the first <a href="../EngineHandler.html" title="interface in org.apache.qpid.protonj2.engine"><code>EngineHandler</code></a> in the pipeline and moving through each until the outgoing |
| work is fully processed. If the write events reaches the tail of the pipeline and is not handled |
| by any handler an error is thrown and the engine should enter the failed state. |
| |
| It is expected that after the fire write method returns the given <a href="../HeaderEnvelope.html" title="class in org.apache.qpid.protonj2.engine"><code>HeaderEnvelope</code></a> will have been |
| written or if held for later the object must be copied.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../EnginePipeline.html#fireWrite(org.apache.qpid.protonj2.engine.HeaderEnvelope)">fireWrite</a></code> in interface <code><a href="../EnginePipeline.html" title="interface in org.apache.qpid.protonj2.engine">EnginePipeline</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> to inject into the engine pipeline.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this <a href="../EnginePipeline.html" title="interface in org.apache.qpid.protonj2.engine"><code>EnginePipeline</code></a>.</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 <a href="ProtonEnginePipeline.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonEnginePipeline</a> 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="../EnginePipeline.html#fireWrite(org.apache.qpid.protonj2.engine.OutgoingAMQPEnvelope)">EnginePipeline</a></code></span></div> |
| <div class="block">Fires a write event consisting of the given <a href="../OutgoingAMQPEnvelope.html" title="class in org.apache.qpid.protonj2.engine"><code>OutgoingAMQPEnvelope</code></a> into the pipeline starting |
| from the first <a href="../EngineHandler.html" title="interface in org.apache.qpid.protonj2.engine"><code>EngineHandler</code></a> in the pipeline and moving through each until the outgoing |
| work is fully processed. If the write events reaches the tail of the pipeline and is not handled |
| by any handler an error is thrown and the engine should enter the failed state. |
| |
| It is expected that after the fire write method returns the given <a href="../OutgoingAMQPEnvelope.html" title="class in org.apache.qpid.protonj2.engine"><code>OutgoingAMQPEnvelope</code></a> will have |
| been written or if held for later the object must be copied. |
| |
| When the payload given exceeds the maximum allowed frame size when encoded into an outbound frame the |
| encoding handler should either throw an error in the case that the performative being written cannot truncate |
| its payload or should invoke the payload to large handler of the envelope before re-encoding the outbound |
| performative and truncating the payload.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../EnginePipeline.html#fireWrite(org.apache.qpid.protonj2.engine.OutgoingAMQPEnvelope)">fireWrite</a></code> in interface <code><a href="../EnginePipeline.html" title="interface in org.apache.qpid.protonj2.engine">EnginePipeline</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> to inject into the engine pipeline.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this <a href="../EnginePipeline.html" title="interface in org.apache.qpid.protonj2.engine"><code>EnginePipeline</code></a>.</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 <a href="ProtonEnginePipeline.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonEnginePipeline</a> 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="../EnginePipeline.html#fireWrite(org.apache.qpid.protonj2.engine.SASLEnvelope)">EnginePipeline</a></code></span></div> |
| <div class="block">Fires a write event consisting of the given <a href="../SASLEnvelope.html" title="class in org.apache.qpid.protonj2.engine"><code>SASLEnvelope</code></a> into the pipeline starting |
| from the first <a href="../EngineHandler.html" title="interface in org.apache.qpid.protonj2.engine"><code>EngineHandler</code></a> in the pipeline and moving through each until the outgoing |
| work is fully processed. If the write events reaches the tail of the pipeline and is not handled |
| by any handler an error is thrown and the engine should enter the failed state. |
| |
| It is expected that after the fire write method returns the given <a href="../SASLEnvelope.html" title="class in org.apache.qpid.protonj2.engine"><code>SASLEnvelope</code></a> will have been |
| written or if held for later the object must be copied.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../EnginePipeline.html#fireWrite(org.apache.qpid.protonj2.engine.SASLEnvelope)">fireWrite</a></code> in interface <code><a href="../EnginePipeline.html" title="interface in org.apache.qpid.protonj2.engine">EnginePipeline</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> to inject into the engine pipeline.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this <a href="../EnginePipeline.html" title="interface in org.apache.qpid.protonj2.engine"><code>EnginePipeline</code></a>.</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 <a href="ProtonEnginePipeline.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonEnginePipeline</a> fireWrite​(<a href="../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a> buffer, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Runnable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Runnable</a> ioComplete)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../EnginePipeline.html#fireWrite(org.apache.qpid.protonj2.buffer.ProtonBuffer,java.lang.Runnable)">EnginePipeline</a></code></span></div> |
| <div class="block">Fires a write event consisting of the given <a href="../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer"><code>ProtonBuffer</code></a> into the pipeline starting |
| from the first <a href="../EngineHandler.html" title="interface in org.apache.qpid.protonj2.engine"><code>EngineHandler</code></a> in the pipeline and moving through each until the outgoing |
| work is fully processed. If the write events reaches the tail of the pipeline and is not handled |
| by any handler an error is thrown and the engine should enter the failed state.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../EnginePipeline.html#fireWrite(org.apache.qpid.protonj2.buffer.ProtonBuffer,java.lang.Runnable)">fireWrite</a></code> in interface <code><a href="../EnginePipeline.html" title="interface in org.apache.qpid.protonj2.engine">EnginePipeline</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> to inject into the engine pipeline.</dd> |
| <dd><code>ioComplete</code> - An optional callback that should be signaled when the underlying transport complete the I/O write</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this <a href="../EnginePipeline.html" title="interface in org.apache.qpid.protonj2.engine"><code>EnginePipeline</code></a>.</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/ProtonEnginePipeline.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="../../../../../../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>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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 © 2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |
