| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>Uses of Class org.apache.qpid.protonj2.engine.exceptions.EngineFailedException (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.exceptions, class: EngineFailedException"> |
| <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="../EngineFailedException.html" title="class in org.apache.qpid.protonj2.engine.exceptions">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 Class org.apache.qpid.protonj2.engine.exceptions.EngineFailedException" class="title">Uses of Class<br>org.apache.qpid.protonj2.engine.exceptions.EngineFailedException</h1> |
| </div> |
| <div class="caption"><span>Packages that use <a href="../EngineFailedException.html" title="class in org.apache.qpid.protonj2.engine.exceptions">EngineFailedException</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.exceptions">org.apache.qpid.protonj2.engine.exceptions</a></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><a href="#org.apache.qpid.protonj2.engine.impl">org.apache.qpid.protonj2.engine.impl</a></div> |
| <div class="col-last even-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="../EngineFailedException.html" title="class in org.apache.qpid.protonj2.engine.exceptions">EngineFailedException</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> with parameters of type <a href="../EngineFailedException.html" title="class in org.apache.qpid.protonj2.engine.exceptions">EngineFailedException</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>default void</code></div> |
| <div class="col-second even-row-color"><span class="type-name-label">EngineHandler.</span><code><a href="../../EngineHandler.html#engineFailed(org.apache.qpid.protonj2.engine.EngineHandlerContext,org.apache.qpid.protonj2.engine.exceptions.EngineFailedException)" class="member-name-link">engineFailed</a><wbr>(<a href="../../EngineHandlerContext.html" title="interface in org.apache.qpid.protonj2.engine">EngineHandlerContext</a> context, |
| <a href="../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">Called when the engine has transitioned to a failed state and cannot process any additional |
| input or output.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>void</code></div> |
| <div class="col-second odd-row-color"><span class="type-name-label">EngineHandlerContext.</span><code><a href="../../EngineHandlerContext.html#fireFailed(org.apache.qpid.protonj2.engine.exceptions.EngineFailedException)" class="member-name-link">fireFailed</a><wbr>(<a href="../EngineFailedException.html" title="class in org.apache.qpid.protonj2.engine.exceptions">EngineFailedException</a> failure)</code></div> |
| <div class="col-last odd-row-color"> |
| <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> |
| </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="../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> |
| <div class="caption"><span>Methods in <a href="../../package-summary.html">org.apache.qpid.protonj2.engine</a> that throw <a href="../EngineFailedException.html" title="class in org.apache.qpid.protonj2.engine.exceptions">EngineFailedException</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="../../Endpoint.html" title="type parameter in Endpoint">E</a></code></div> |
| <div class="col-second even-row-color"><span class="type-name-label">Endpoint.</span><code><a href="../../Endpoint.html#close()" class="member-name-link">close</a>()</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Close the end point locally and send the closing performative immediately if possible or |
| holds it until the Connection / Engine state allows it.</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="org.apache.qpid.protonj2.engine.exceptions"> |
| <h2>Uses of <a href="../EngineFailedException.html" title="class in org.apache.qpid.protonj2.engine.exceptions">EngineFailedException</a> in <a href="../package-summary.html">org.apache.qpid.protonj2.engine.exceptions</a></h2> |
| <div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.qpid.protonj2.engine.exceptions</a> that return <a href="../EngineFailedException.html" title="class in org.apache.qpid.protonj2.engine.exceptions">EngineFailedException</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>static <a href="../EngineFailedException.html" title="class in org.apache.qpid.protonj2.engine.exceptions">EngineFailedException</a></code></div> |
| <div class="col-second even-row-color"><span class="type-name-label">ProtonExceptionSupport.</span><code><a href="../ProtonExceptionSupport.html#createFailedException(java.lang.String,java.lang.Throwable)" class="member-name-link">createFailedException</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> message, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link">Throwable</a> cause)</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Creates a new instance of an EngineFailedException that either wraps the given cause |
| if it is not an instance of an <a href="../EngineFailedException.html" title="class in org.apache.qpid.protonj2.engine.exceptions"><code>EngineFailedException</code></a> or creates a new copy |
| of the given <a href="../EngineFailedException.html" title="class in org.apache.qpid.protonj2.engine.exceptions"><code>EngineFailedException</code></a> in order to produce a meaningful stack trace |
| for the caller of which of their calls failed due to the engine state being failed.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>static <a href="../EngineFailedException.html" title="class in org.apache.qpid.protonj2.engine.exceptions">EngineFailedException</a></code></div> |
| <div class="col-second odd-row-color"><span class="type-name-label">ProtonExceptionSupport.</span><code><a href="../ProtonExceptionSupport.html#createFailedException(java.lang.Throwable)" class="member-name-link">createFailedException</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link">Throwable</a> cause)</code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Checks the given cause to determine if it's already an ProtonException type and |
| if not creates a new ProtonException to wrap it.</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="org.apache.qpid.protonj2.engine.impl"> |
| <h2>Uses of <a href="../EngineFailedException.html" title="class in org.apache.qpid.protonj2.engine.exceptions">EngineFailedException</a> in <a href="../../impl/package-summary.html">org.apache.qpid.protonj2.engine.impl</a></h2> |
| <div class="caption"><span>Methods in <a href="../../impl/package-summary.html">org.apache.qpid.protonj2.engine.impl</a> with parameters of type <a href="../EngineFailedException.html" title="class in org.apache.qpid.protonj2.engine.exceptions">EngineFailedException</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>void</code></div> |
| <div class="col-second even-row-color"><span class="type-name-label">ProtonFrameDecodingHandler.</span><code><a href="../../impl/ProtonFrameDecodingHandler.html#engineFailed(org.apache.qpid.protonj2.engine.EngineHandlerContext,org.apache.qpid.protonj2.engine.exceptions.EngineFailedException)" class="member-name-link">engineFailed</a><wbr>(<a href="../../EngineHandlerContext.html" title="interface in org.apache.qpid.protonj2.engine">EngineHandlerContext</a> context, |
| <a href="../EngineFailedException.html" title="class in org.apache.qpid.protonj2.engine.exceptions">EngineFailedException</a> failure)</code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>void</code></div> |
| <div class="col-second odd-row-color"><span class="type-name-label">ProtonPerformativeHandler.</span><code><a href="../../impl/ProtonPerformativeHandler.html#engineFailed(org.apache.qpid.protonj2.engine.EngineHandlerContext,org.apache.qpid.protonj2.engine.exceptions.EngineFailedException)" class="member-name-link">engineFailed</a><wbr>(<a href="../../EngineHandlerContext.html" title="interface in org.apache.qpid.protonj2.engine">EngineHandlerContext</a> context, |
| <a href="../EngineFailedException.html" title="class in org.apache.qpid.protonj2.engine.exceptions">EngineFailedException</a> failure)</code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>void</code></div> |
| <div class="col-second even-row-color"><span class="type-name-label">ProtonEngineHandlerContext.</span><code><a href="../../impl/ProtonEngineHandlerContext.html#fireFailed(org.apache.qpid.protonj2.engine.exceptions.EngineFailedException)" class="member-name-link">fireFailed</a><wbr>(<a href="../EngineFailedException.html" title="class in org.apache.qpid.protonj2.engine.exceptions">EngineFailedException</a> failure)</code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code><a href="../../impl/ProtonEnginePipeline.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonEnginePipeline</a></code></div> |
| <div class="col-second odd-row-color"><span class="type-name-label">ProtonEnginePipeline.</span><code><a href="../../impl/ProtonEnginePipeline.html#fireFailed(org.apache.qpid.protonj2.engine.exceptions.EngineFailedException)" class="member-name-link">fireFailed</a><wbr>(<a href="../EngineFailedException.html" title="class in org.apache.qpid.protonj2.engine.exceptions">EngineFailedException</a> e)</code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code><a href="../../impl/ProtonEnginePipelineProxy.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonEnginePipelineProxy</a></code></div> |
| <div class="col-second even-row-color"><span class="type-name-label">ProtonEnginePipelineProxy.</span><code><a href="../../impl/ProtonEnginePipelineProxy.html#fireFailed(org.apache.qpid.protonj2.engine.exceptions.EngineFailedException)" class="member-name-link">fireFailed</a><wbr>(<a href="../EngineFailedException.html" title="class in org.apache.qpid.protonj2.engine.exceptions">EngineFailedException</a> e)</code></div> |
| <div class="col-last even-row-color"> </div> |
| </div> |
| <div class="caption"><span>Methods in <a href="../../impl/package-summary.html">org.apache.qpid.protonj2.engine.impl</a> that throw <a href="../EngineFailedException.html" title="class in org.apache.qpid.protonj2.engine.exceptions">EngineFailedException</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="../../impl/ProtonConnection.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonConnection</a></code></div> |
| <div class="col-second even-row-color"><span class="type-name-label">ProtonConnection.</span><code><a href="../../impl/ProtonConnection.html#close()" class="member-name-link">close</a>()</code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code><a href="../../impl/ProtonSession.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonSession</a></code></div> |
| <div class="col-second odd-row-color"><span class="type-name-label">ProtonSession.</span><code><a href="../../impl/ProtonSession.html#close()" class="member-name-link">close</a>()</code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code><a href="../../TransactionController.html" title="interface in org.apache.qpid.protonj2.engine">TransactionController</a></code></div> |
| <div class="col-second even-row-color"><span class="type-name-label">ProtonTransactionController.</span><code><a href="../../impl/ProtonTransactionController.html#close()" class="member-name-link">close</a>()</code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code><a href="../../TransactionManager.html" title="interface in org.apache.qpid.protonj2.engine">TransactionManager</a></code></div> |
| <div class="col-second odd-row-color"><span class="type-name-label">ProtonTransactionManager.</span><code><a href="../../impl/ProtonTransactionManager.html#close()" class="member-name-link">close</a>()</code></div> |
| <div class="col-last odd-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> |
