| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>Uses of Interface org.apache.qpid.protonj2.engine.EnginePipeline (Qpid ProtonJ2 Parent 1.0.0-M19 API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="use: package: org.apache.qpid.protonj2.engine, interface: EnginePipeline"> |
| <meta name="generator" content="javadoc/ClassUseWriter"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../script.js"></script> |
| </head> |
| <body class="class-use-page"> |
| <script type="text/javascript"></script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../../../index.html">Overview</a></li> |
| <li><a href="../package-summary.html">Package</a></li> |
| <li><a href="../EnginePipeline.html" title="interface in org.apache.qpid.protonj2.engine">Class</a></li> |
| <li class="nav-bar-cell1-rev">Use</li> |
| <li><a href="../package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../help-doc.html#use">Help</a></li> |
| </ul> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <div class="header"> |
| <h1 title="Uses of Interface org.apache.qpid.protonj2.engine.EnginePipeline" class="title">Uses of Interface<br>org.apache.qpid.protonj2.engine.EnginePipeline</h1> |
| </div> |
| <div class="caption"><span>Packages that use <a href="../EnginePipeline.html" title="interface in org.apache.qpid.protonj2.engine">EnginePipeline</a></span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Package</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><a href="#org.apache.qpid.protonj2.engine">org.apache.qpid.protonj2.engine</a></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><a href="#org.apache.qpid.protonj2.engine.impl">org.apache.qpid.protonj2.engine.impl</a></div> |
| <div class="col-last odd-row-color"> </div> |
| </div> |
| <section class="class-uses"> |
| <ul class="block-list"> |
| <li> |
| <section class="detail" id="org.apache.qpid.protonj2.engine"> |
| <h2>Uses of <a href="../EnginePipeline.html" title="interface in org.apache.qpid.protonj2.engine">EnginePipeline</a> in <a href="../package-summary.html">org.apache.qpid.protonj2.engine</a></h2> |
| <div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.qpid.protonj2.engine</a> that return <a href="../EnginePipeline.html" title="interface in org.apache.qpid.protonj2.engine">EnginePipeline</a></span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code><a href="../EnginePipeline.html" title="interface in org.apache.qpid.protonj2.engine">EnginePipeline</a></code></div> |
| <div class="col-second even-row-color"><span class="type-name-label">EnginePipeline.</span><code><a href="../EnginePipeline.html#addFirst(java.lang.String,org.apache.qpid.protonj2.engine.EngineHandler)" class="member-name-link">addFirst</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| <a href="../EngineHandler.html" title="interface in org.apache.qpid.protonj2.engine">EngineHandler</a> handler)</code></div> |
| <div class="col-last even-row-color"> |
| <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> |
| </div> |
| <div class="col-first odd-row-color"><code><a href="../EnginePipeline.html" title="interface in org.apache.qpid.protonj2.engine">EnginePipeline</a></code></div> |
| <div class="col-second odd-row-color"><span class="type-name-label">EnginePipeline.</span><code><a href="../EnginePipeline.html#addLast(java.lang.String,org.apache.qpid.protonj2.engine.EngineHandler)" class="member-name-link">addLast</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| <a href="../EngineHandler.html" title="interface in org.apache.qpid.protonj2.engine">EngineHandler</a> handler)</code></div> |
| <div class="col-last odd-row-color"> |
| <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> |
| </div> |
| <div class="col-first even-row-color"><code><a href="../EnginePipeline.html" title="interface in org.apache.qpid.protonj2.engine">EnginePipeline</a></code></div> |
| <div class="col-second even-row-color"><span class="type-name-label">EnginePipeline.</span><code><a href="../EnginePipeline.html#fireEngineStarting()" class="member-name-link">fireEngineStarting</a>()</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Fires an engine starting event to each handler in the pipeline.</div> |
| </div> |
| <div class="col-first odd-row-color"><code><a href="../EnginePipeline.html" title="interface in org.apache.qpid.protonj2.engine">EnginePipeline</a></code></div> |
| <div class="col-second odd-row-color"><span class="type-name-label">EnginePipeline.</span><code><a href="../EnginePipeline.html#fireEngineStateChanged()" class="member-name-link">fireEngineStateChanged</a>()</code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Fires an engine state changed event to each handler in the pipeline.</div> |
| </div> |
| <div class="col-first even-row-color"><code><a href="../EnginePipeline.html" title="interface in org.apache.qpid.protonj2.engine">EnginePipeline</a></code></div> |
| <div class="col-second even-row-color"><span class="type-name-label">EnginePipeline.</span><code><a href="../EnginePipeline.html#fireFailed(org.apache.qpid.protonj2.engine.exceptions.EngineFailedException)" class="member-name-link">fireFailed</a><wbr>(<a href="../exceptions/EngineFailedException.html" title="class in org.apache.qpid.protonj2.engine.exceptions">EngineFailedException</a> failure)</code></div> |
| <div class="col-last even-row-color"> |
| <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> |
| </div> |
| <div class="col-first odd-row-color"><code><a href="../EnginePipeline.html" title="interface in org.apache.qpid.protonj2.engine">EnginePipeline</a></code></div> |
| <div class="col-second odd-row-color"><span class="type-name-label">EnginePipeline.</span><code><a href="../EnginePipeline.html#fireRead(org.apache.qpid.protonj2.buffer.ProtonBuffer)" class="member-name-link">fireRead</a><wbr>(<a href="../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a> input)</code></div> |
| <div class="col-last odd-row-color"> |
| <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> |
| </div> |
| <div class="col-first even-row-color"><code><a href="../EnginePipeline.html" title="interface in org.apache.qpid.protonj2.engine">EnginePipeline</a></code></div> |
| <div class="col-second even-row-color"><span class="type-name-label">EnginePipeline.</span><code><a href="../EnginePipeline.html#fireRead(org.apache.qpid.protonj2.engine.HeaderEnvelope)" class="member-name-link">fireRead</a><wbr>(<a href="../HeaderEnvelope.html" title="class in org.apache.qpid.protonj2.engine">HeaderEnvelope</a> header)</code></div> |
| <div class="col-last even-row-color"> |
| <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> |
| </div> |
| <div class="col-first odd-row-color"><code><a href="../EnginePipeline.html" title="interface in org.apache.qpid.protonj2.engine">EnginePipeline</a></code></div> |
| <div class="col-second odd-row-color"><span class="type-name-label">EnginePipeline.</span><code><a href="../EnginePipeline.html#fireRead(org.apache.qpid.protonj2.engine.IncomingAMQPEnvelope)" class="member-name-link">fireRead</a><wbr>(<a href="../IncomingAMQPEnvelope.html" title="class in org.apache.qpid.protonj2.engine">IncomingAMQPEnvelope</a> envelope)</code></div> |
| <div class="col-last odd-row-color"> |
| <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> |
| </div> |
| <div class="col-first even-row-color"><code><a href="../EnginePipeline.html" title="interface in org.apache.qpid.protonj2.engine">EnginePipeline</a></code></div> |
| <div class="col-second even-row-color"><span class="type-name-label">EnginePipeline.</span><code><a href="../EnginePipeline.html#fireRead(org.apache.qpid.protonj2.engine.SASLEnvelope)" class="member-name-link">fireRead</a><wbr>(<a href="../SASLEnvelope.html" title="class in org.apache.qpid.protonj2.engine">SASLEnvelope</a> envelope)</code></div> |
| <div class="col-last even-row-color"> |
| <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> |
| </div> |
| <div class="col-first odd-row-color"><code><a href="../EnginePipeline.html" title="interface in org.apache.qpid.protonj2.engine">EnginePipeline</a></code></div> |
| <div class="col-second odd-row-color"><span class="type-name-label">EnginePipeline.</span><code><a href="../EnginePipeline.html#fireWrite(org.apache.qpid.protonj2.buffer.ProtonBuffer,java.lang.Runnable)" class="member-name-link">fireWrite</a><wbr>(<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" title="class or interface in java.lang" class="external-link">Runnable</a> ioComplete)</code></div> |
| <div class="col-last odd-row-color"> |
| <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> |
| </div> |
| <div class="col-first even-row-color"><code><a href="../EnginePipeline.html" title="interface in org.apache.qpid.protonj2.engine">EnginePipeline</a></code></div> |
| <div class="col-second even-row-color"><span class="type-name-label">EnginePipeline.</span><code><a href="../EnginePipeline.html#fireWrite(org.apache.qpid.protonj2.engine.HeaderEnvelope)" class="member-name-link">fireWrite</a><wbr>(<a href="../HeaderEnvelope.html" title="class in org.apache.qpid.protonj2.engine">HeaderEnvelope</a> envelope)</code></div> |
| <div class="col-last even-row-color"> |
| <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> |
| </div> |
| <div class="col-first odd-row-color"><code><a href="../EnginePipeline.html" title="interface in org.apache.qpid.protonj2.engine">EnginePipeline</a></code></div> |
| <div class="col-second odd-row-color"><span class="type-name-label">EnginePipeline.</span><code><a href="../EnginePipeline.html#fireWrite(org.apache.qpid.protonj2.engine.OutgoingAMQPEnvelope)" class="member-name-link">fireWrite</a><wbr>(<a href="../OutgoingAMQPEnvelope.html" title="class in org.apache.qpid.protonj2.engine">OutgoingAMQPEnvelope</a> envelope)</code></div> |
| <div class="col-last odd-row-color"> |
| <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> |
| </div> |
| <div class="col-first even-row-color"><code><a href="../EnginePipeline.html" title="interface in org.apache.qpid.protonj2.engine">EnginePipeline</a></code></div> |
| <div class="col-second even-row-color"><span class="type-name-label">EnginePipeline.</span><code><a href="../EnginePipeline.html#fireWrite(org.apache.qpid.protonj2.engine.SASLEnvelope)" class="member-name-link">fireWrite</a><wbr>(<a href="../SASLEnvelope.html" title="class in org.apache.qpid.protonj2.engine">SASLEnvelope</a> envelope)</code></div> |
| <div class="col-last even-row-color"> |
| <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> |
| </div> |
| <div class="col-first odd-row-color"><code><a href="../EnginePipeline.html" title="interface in org.apache.qpid.protonj2.engine">EnginePipeline</a></code></div> |
| <div class="col-second odd-row-color"><span class="type-name-label">Engine.</span><code><a href="../Engine.html#pipeline()" class="member-name-link">pipeline</a>()</code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Gets the EnginePipeline for this Engine.</div> |
| </div> |
| <div class="col-first even-row-color"><code><a href="../EnginePipeline.html" title="interface in org.apache.qpid.protonj2.engine">EnginePipeline</a></code></div> |
| <div class="col-second even-row-color"><span class="type-name-label">EnginePipeline.</span><code><a href="../EnginePipeline.html#remove(java.lang.String)" class="member-name-link">remove</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Removes the first handler that is found in the pipeline that matches the given name.</div> |
| </div> |
| <div class="col-first odd-row-color"><code><a href="../EnginePipeline.html" title="interface in org.apache.qpid.protonj2.engine">EnginePipeline</a></code></div> |
| <div class="col-second odd-row-color"><span class="type-name-label">EnginePipeline.</span><code><a href="../EnginePipeline.html#remove(org.apache.qpid.protonj2.engine.EngineHandler)" class="member-name-link">remove</a><wbr>(<a href="../EngineHandler.html" title="interface in org.apache.qpid.protonj2.engine">EngineHandler</a> handler)</code></div> |
| <div class="col-last odd-row-color"> |
| <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> |
| </div> |
| <div class="col-first even-row-color"><code><a href="../EnginePipeline.html" title="interface in org.apache.qpid.protonj2.engine">EnginePipeline</a></code></div> |
| <div class="col-second even-row-color"><span class="type-name-label">EnginePipeline.</span><code><a href="../EnginePipeline.html#removeFirst()" class="member-name-link">removeFirst</a>()</code></div> |
| <div class="col-last even-row-color"> |
| <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> |
| </div> |
| <div class="col-first odd-row-color"><code><a href="../EnginePipeline.html" title="interface in org.apache.qpid.protonj2.engine">EnginePipeline</a></code></div> |
| <div class="col-second odd-row-color"><span class="type-name-label">EnginePipeline.</span><code><a href="../EnginePipeline.html#removeLast()" class="member-name-link">removeLast</a>()</code></div> |
| <div class="col-last odd-row-color"> |
| <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> |
| </div> |
| </div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="org.apache.qpid.protonj2.engine.impl"> |
| <h2>Uses of <a href="../EnginePipeline.html" title="interface in org.apache.qpid.protonj2.engine">EnginePipeline</a> in <a href="../impl/package-summary.html">org.apache.qpid.protonj2.engine.impl</a></h2> |
| <div class="caption"><span>Classes in <a href="../impl/package-summary.html">org.apache.qpid.protonj2.engine.impl</a> that implement <a href="../EnginePipeline.html" title="interface in org.apache.qpid.protonj2.engine">EnginePipeline</a></span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Class</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>class </code></div> |
| <div class="col-second even-row-color"><code><a href="../impl/ProtonEnginePipeline.html" class="type-name-link" title="class in org.apache.qpid.protonj2.engine.impl">ProtonEnginePipeline</a></code></div> |
| <div class="col-last even-row-color"> |
| <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> |
| </div> |
| <div class="col-first odd-row-color"><code>class </code></div> |
| <div class="col-second odd-row-color"><code><a href="../impl/ProtonEnginePipelineProxy.html" class="type-name-link" title="class in org.apache.qpid.protonj2.engine.impl">ProtonEnginePipelineProxy</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Wrapper around the internal <a href="../impl/ProtonEnginePipeline.html" title="class in org.apache.qpid.protonj2.engine.impl"><code>ProtonEnginePipeline</code></a> used to present a guarded |
| pipeline to the outside world when the <a href="../Engine.html#pipeline()"><code>Engine.pipeline()</code></a> method is used |
| to gain access to the pipeline.</div> |
| </div> |
| </div> |
| <div class="caption"><span>Methods in <a href="../impl/package-summary.html">org.apache.qpid.protonj2.engine.impl</a> that return <a href="../EnginePipeline.html" title="interface in org.apache.qpid.protonj2.engine">EnginePipeline</a></span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code><a href="../EnginePipeline.html" title="interface in org.apache.qpid.protonj2.engine">EnginePipeline</a></code></div> |
| <div class="col-second even-row-color"><span class="type-name-label">ProtonEngine.</span><code><a href="../impl/ProtonEngine.html#pipeline()" class="member-name-link">pipeline</a>()</code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code><a href="../EnginePipeline.html" title="interface in org.apache.qpid.protonj2.engine">EnginePipeline</a></code></div> |
| <div class="col-second odd-row-color"><span class="type-name-label">ProtonEnginePipeline.</span><code><a href="../impl/ProtonEnginePipeline.html#remove(org.apache.qpid.protonj2.engine.EngineHandler)" class="member-name-link">remove</a><wbr>(<a href="../EngineHandler.html" title="interface in org.apache.qpid.protonj2.engine">EngineHandler</a> handler)</code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code><a href="../EnginePipeline.html" title="interface in org.apache.qpid.protonj2.engine">EnginePipeline</a></code></div> |
| <div class="col-second even-row-color"><span class="type-name-label">ProtonEnginePipelineProxy.</span><code><a href="../impl/ProtonEnginePipelineProxy.html#remove(org.apache.qpid.protonj2.engine.EngineHandler)" class="member-name-link">remove</a><wbr>(<a href="../EngineHandler.html" title="interface in org.apache.qpid.protonj2.engine">EngineHandler</a> handler)</code></div> |
| <div class="col-last even-row-color"> </div> |
| </div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
