blob: 5b16cf934cc54a70fe866c9eeee5fb3f669d62dd [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>Uses of Interface org.apache.qpid.protonj2.engine.EngineHandler (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: EngineHandler">
<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="../EngineHandler.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.EngineHandler" class="title">Uses of Interface<br>org.apache.qpid.protonj2.engine.EngineHandler</h1>
</div>
<div class="caption"><span>Packages that use <a href="../EngineHandler.html" title="interface in org.apache.qpid.protonj2.engine">EngineHandler</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">&nbsp;</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">&nbsp;</div>
<div class="col-first even-row-color"><a href="#org.apache.qpid.protonj2.engine.impl.sasl">org.apache.qpid.protonj2.engine.impl.sasl</a></div>
<div class="col-last even-row-color">&nbsp;</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="../EngineHandler.html" title="interface in org.apache.qpid.protonj2.engine">EngineHandler</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="../EngineHandler.html" title="interface in org.apache.qpid.protonj2.engine">EngineHandler</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="../EngineHandler.html" title="interface in org.apache.qpid.protonj2.engine">EngineHandler</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">EnginePipeline.</span><code><a href="../EnginePipeline.html#find(java.lang.String)" class="member-name-link">find</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>&nbsp;name)</code></div>
<div class="col-last even-row-color">
<div class="block">Finds and returns 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="../EngineHandler.html" title="interface in org.apache.qpid.protonj2.engine">EngineHandler</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">EnginePipeline.</span><code><a href="../EnginePipeline.html#first()" class="member-name-link">first</a>()</code></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><code><a href="../EngineHandler.html" title="interface in org.apache.qpid.protonj2.engine">EngineHandler</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">EngineHandlerContext.</span><code><a href="../EngineHandlerContext.html#handler()" class="member-name-link">handler</a>()</code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code><a href="../EngineHandler.html" title="interface in org.apache.qpid.protonj2.engine">EngineHandler</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">EnginePipeline.</span><code><a href="../EnginePipeline.html#last()" class="member-name-link">last</a>()</code></div>
<div class="col-last odd-row-color">&nbsp;</div>
</div>
<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.qpid.protonj2.engine</a> with parameters of type <a href="../EngineHandler.html" title="interface in org.apache.qpid.protonj2.engine">EngineHandler</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>&nbsp;name,
<a href="../EngineHandler.html" title="interface in org.apache.qpid.protonj2.engine">EngineHandler</a>&nbsp;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>&nbsp;name,
<a href="../EngineHandler.html" title="interface in org.apache.qpid.protonj2.engine">EngineHandler</a>&nbsp;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#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>&nbsp;handler)</code></div>
<div class="col-last even-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>
</section>
</li>
<li>
<section class="detail" id="org.apache.qpid.protonj2.engine.impl">
<h2>Uses of <a href="../EngineHandler.html" title="interface in org.apache.qpid.protonj2.engine">EngineHandler</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="../EngineHandler.html" title="interface in org.apache.qpid.protonj2.engine">EngineHandler</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&nbsp;</code></div>
<div class="col-second even-row-color"><code><a href="../impl/ProtonFrameDecodingHandler.html" class="type-name-link" title="class in org.apache.qpid.protonj2.engine.impl">ProtonFrameDecodingHandler</a></code></div>
<div class="col-last even-row-color">
<div class="block">Handler used to parse incoming frame data input into the engine</div>
</div>
<div class="col-first odd-row-color"><code>class&nbsp;</code></div>
<div class="col-second odd-row-color"><code><a href="../impl/ProtonFrameEncodingHandler.html" class="type-name-link" title="class in org.apache.qpid.protonj2.engine.impl">ProtonFrameEncodingHandler</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Handler that encodes performatives into properly formed frames for IO</div>
</div>
<div class="col-first even-row-color"><code>class&nbsp;</code></div>
<div class="col-second even-row-color"><code><a href="../impl/ProtonFrameLoggingHandler.html" class="type-name-link" title="class in org.apache.qpid.protonj2.engine.impl">ProtonFrameLoggingHandler</a></code></div>
<div class="col-last even-row-color">
<div class="block">Handler that will log incoming and outgoing Frames</div>
</div>
<div class="col-first odd-row-color"><code>class&nbsp;</code></div>
<div class="col-second odd-row-color"><code><a href="../impl/ProtonPerformativeHandler.html" class="type-name-link" title="class in org.apache.qpid.protonj2.engine.impl">ProtonPerformativeHandler</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Transport Handler that forwards the incoming Performatives to the associated Connection
as well as any error encountered during the Transport processing.</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="../EngineHandler.html" title="interface in org.apache.qpid.protonj2.engine">EngineHandler</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="../EngineHandler.html" title="interface in org.apache.qpid.protonj2.engine">EngineHandler</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">ProtonEnginePipeline.</span><code><a href="../impl/ProtonEnginePipeline.html#find(java.lang.String)" class="member-name-link">find</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>&nbsp;name)</code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code><a href="../EngineHandler.html" title="interface in org.apache.qpid.protonj2.engine">EngineHandler</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">ProtonEnginePipelineProxy.</span><code><a href="../impl/ProtonEnginePipelineProxy.html#find(java.lang.String)" class="member-name-link">find</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>&nbsp;name)</code></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><code><a href="../EngineHandler.html" title="interface in org.apache.qpid.protonj2.engine">EngineHandler</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">ProtonEnginePipeline.</span><code><a href="../impl/ProtonEnginePipeline.html#first()" class="member-name-link">first</a>()</code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code><a href="../EngineHandler.html" title="interface in org.apache.qpid.protonj2.engine">EngineHandler</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">ProtonEnginePipelineProxy.</span><code><a href="../impl/ProtonEnginePipelineProxy.html#first()" class="member-name-link">first</a>()</code></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><code><a href="../EngineHandler.html" title="interface in org.apache.qpid.protonj2.engine">EngineHandler</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">ProtonEngineHandlerContext.</span><code><a href="../impl/ProtonEngineHandlerContext.html#handler()" class="member-name-link">handler</a>()</code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code><a href="../EngineHandler.html" title="interface in org.apache.qpid.protonj2.engine">EngineHandler</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">ProtonEnginePipeline.</span><code><a href="../impl/ProtonEnginePipeline.html#last()" class="member-name-link">last</a>()</code></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><code><a href="../EngineHandler.html" title="interface in org.apache.qpid.protonj2.engine">EngineHandler</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">ProtonEnginePipelineProxy.</span><code><a href="../impl/ProtonEnginePipelineProxy.html#last()" class="member-name-link">last</a>()</code></div>
<div class="col-last even-row-color">&nbsp;</div>
</div>
<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="../EngineHandler.html" title="interface in org.apache.qpid.protonj2.engine">EngineHandler</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/ProtonEnginePipeline.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonEnginePipeline</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">ProtonEnginePipeline.</span><code><a href="../impl/ProtonEnginePipeline.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>&nbsp;name,
<a href="../EngineHandler.html" title="interface in org.apache.qpid.protonj2.engine">EngineHandler</a>&nbsp;handler)</code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-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 odd-row-color"><span class="type-name-label">ProtonEnginePipelineProxy.</span><code><a href="../impl/ProtonEnginePipelineProxy.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>&nbsp;name,
<a href="../EngineHandler.html" title="interface in org.apache.qpid.protonj2.engine">EngineHandler</a>&nbsp;handler)</code></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-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 even-row-color"><span class="type-name-label">ProtonEnginePipeline.</span><code><a href="../impl/ProtonEnginePipeline.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>&nbsp;name,
<a href="../EngineHandler.html" title="interface in org.apache.qpid.protonj2.engine">EngineHandler</a>&nbsp;handler)</code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-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 odd-row-color"><span class="type-name-label">ProtonEnginePipelineProxy.</span><code><a href="../impl/ProtonEnginePipelineProxy.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>&nbsp;name,
<a href="../EngineHandler.html" title="interface in org.apache.qpid.protonj2.engine">EngineHandler</a>&nbsp;handler)</code></div>
<div class="col-last odd-row-color">&nbsp;</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">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>&nbsp;handler)</code></div>
<div class="col-last even-row-color">&nbsp;</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">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>&nbsp;handler)</code></div>
<div class="col-last odd-row-color">&nbsp;</div>
</div>
<div class="caption"><span>Constructors in <a href="../impl/package-summary.html">org.apache.qpid.protonj2.engine.impl</a> with parameters of type <a href="../EngineHandler.html" title="interface in org.apache.qpid.protonj2.engine">EngineHandler</a></span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier</div>
<div class="table-header col-second">Constructor</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>&nbsp;</code></div>
<div class="col-second even-row-color"><code><a href="../impl/ProtonEngineHandlerContext.html#%3Cinit%3E(java.lang.String,org.apache.qpid.protonj2.engine.Engine,org.apache.qpid.protonj2.engine.EngineHandler)" class="member-name-link">ProtonEngineHandlerContext</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>&nbsp;name,
<a href="../Engine.html" title="interface in org.apache.qpid.protonj2.engine">Engine</a>&nbsp;engine,
<a href="../EngineHandler.html" title="interface in org.apache.qpid.protonj2.engine">EngineHandler</a>&nbsp;handler)</code></div>
<div class="col-last even-row-color">
<div class="block">Creates a new <a href="../impl/ProtonEngineHandlerContext.html" title="class in org.apache.qpid.protonj2.engine.impl"><code>ProtonEngineHandlerContext</code></a> with the given options.</div>
</div>
</div>
</section>
</li>
<li>
<section class="detail" id="org.apache.qpid.protonj2.engine.impl.sasl">
<h2>Uses of <a href="../EngineHandler.html" title="interface in org.apache.qpid.protonj2.engine">EngineHandler</a> in <a href="../impl/sasl/package-summary.html">org.apache.qpid.protonj2.engine.impl.sasl</a></h2>
<div class="caption"><span>Classes in <a href="../impl/sasl/package-summary.html">org.apache.qpid.protonj2.engine.impl.sasl</a> that implement <a href="../EngineHandler.html" title="interface in org.apache.qpid.protonj2.engine">EngineHandler</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>final class&nbsp;</code></div>
<div class="col-second even-row-color"><code><a href="../impl/sasl/ProtonSaslHandler.html" class="type-name-link" title="class in org.apache.qpid.protonj2.engine.impl.sasl">ProtonSaslHandler</a></code></div>
<div class="col-last even-row-color">
<div class="block">Base class used for common portions of the SASL processing pipeline.</div>
</div>
</div>
</section>
</li>
</ul>
</section>
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &#169; 2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>