blob: abd992345c3051fd2627733c6f5dadf1e27c0fad [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>Uses of Class org.apache.qpid.protonj2.engine.SASLEnvelope (Qpid ProtonJ2 Parent 1.0.0-M18 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, class: SASLEnvelope">
<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="../SASLEnvelope.html" title="class 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 Class org.apache.qpid.protonj2.engine.SASLEnvelope" class="title">Uses of Class<br>org.apache.qpid.protonj2.engine.SASLEnvelope</h1>
</div>
<div class="caption"><span>Packages that use <a href="../SASLEnvelope.html" title="class in org.apache.qpid.protonj2.engine">SASLEnvelope</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="../SASLEnvelope.html" title="class in org.apache.qpid.protonj2.engine">SASLEnvelope</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="../SASLEnvelope.html" title="class in org.apache.qpid.protonj2.engine">SASLEnvelope</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">EngineHandlerContext.</span><code><a href="../EngineHandlerContext.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>&nbsp;envelope)</code></div>
<div class="col-last even-row-color">
<div class="block">Fires a read of SASL events into the previous handler in the <a href="../EnginePipeline.html" title="interface in org.apache.qpid.protonj2.engine"><code>EnginePipeline</code></a> for further
processing.</div>
</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.SASLEnvelope)" class="member-name-link">fireRead</a><wbr>(<a href="../SASLEnvelope.html" title="class in org.apache.qpid.protonj2.engine">SASLEnvelope</a>&nbsp;envelope)</code></div>
<div class="col-last odd-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 even-row-color"><code>void</code></div>
<div class="col-second even-row-color"><span class="type-name-label">EngineHandlerContext.</span><code><a href="../EngineHandlerContext.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>&nbsp;envelope)</code></div>
<div class="col-last even-row-color">
<div class="block">Fires a write of <a href="../SASLEnvelope.html" title="class in org.apache.qpid.protonj2.engine"><code>SASLEnvelope</code></a> events into the next handler in the <a href="../EnginePipeline.html" title="interface in org.apache.qpid.protonj2.engine"><code>EnginePipeline</code></a> for further
processing.</div>
</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.SASLEnvelope)" class="member-name-link">fireWrite</a><wbr>(<a href="../SASLEnvelope.html" title="class in org.apache.qpid.protonj2.engine">SASLEnvelope</a>&nbsp;envelope)</code></div>
<div class="col-last odd-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 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#handleRead(org.apache.qpid.protonj2.engine.EngineHandlerContext,org.apache.qpid.protonj2.engine.SASLEnvelope)" class="member-name-link">handleRead</a><wbr>(<a href="../EngineHandlerContext.html" title="interface in org.apache.qpid.protonj2.engine">EngineHandlerContext</a>&nbsp;context,
<a href="../SASLEnvelope.html" title="class in org.apache.qpid.protonj2.engine">SASLEnvelope</a>&nbsp;envelope)</code></div>
<div class="col-last even-row-color">
<div class="block">Handle the receipt of an incoming SASL performative based on the current state of this handler.</div>
</div>
<div class="col-first odd-row-color"><code>default void</code></div>
<div class="col-second odd-row-color"><span class="type-name-label">EngineHandler.</span><code><a href="../EngineHandler.html#handleWrite(org.apache.qpid.protonj2.engine.EngineHandlerContext,org.apache.qpid.protonj2.engine.SASLEnvelope)" class="member-name-link">handleWrite</a><wbr>(<a href="../EngineHandlerContext.html" title="interface in org.apache.qpid.protonj2.engine">EngineHandlerContext</a>&nbsp;context,
<a href="../SASLEnvelope.html" title="class in org.apache.qpid.protonj2.engine">SASLEnvelope</a>&nbsp;envelope)</code></div>
<div class="col-last odd-row-color">
<div class="block">Handles write of SaslPerformative either by directly writing it to the output target or by
converting it to bytes and firing a write using the <a href="../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer"><code>ProtonBuffer</code></a> based API
in <a href="../EngineHandlerContext.html#fireWrite(org.apache.qpid.protonj2.buffer.ProtonBuffer,java.lang.Runnable)"><code>EngineHandlerContext.fireWrite(ProtonBuffer, Runnable)</code></a></div>
</div>
</div>
</section>
</li>
<li>
<section class="detail" id="org.apache.qpid.protonj2.engine.impl">
<h2>Uses of <a href="../SASLEnvelope.html" title="class in org.apache.qpid.protonj2.engine">SASLEnvelope</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="../SASLEnvelope.html" title="class in org.apache.qpid.protonj2.engine">SASLEnvelope</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">ProtonEngineHandlerContext.</span><code><a href="../impl/ProtonEngineHandlerContext.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>&nbsp;envelope)</code></div>
<div class="col-last even-row-color">&nbsp;</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#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>&nbsp;envelope)</code></div>
<div class="col-last odd-row-color">&nbsp;</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#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>&nbsp;envelope)</code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code>void</code></div>
<div class="col-second odd-row-color"><span class="type-name-label">ProtonEngineHandlerContext.</span><code><a href="../impl/ProtonEngineHandlerContext.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>&nbsp;envelope)</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#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>&nbsp;envelope)</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#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>&nbsp;envelope)</code></div>
<div class="col-last odd-row-color">&nbsp;</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#handleRead(org.apache.qpid.protonj2.engine.EngineHandlerContext,org.apache.qpid.protonj2.engine.SASLEnvelope)" class="member-name-link">handleRead</a><wbr>(<a href="../EngineHandlerContext.html" title="interface in org.apache.qpid.protonj2.engine">EngineHandlerContext</a>&nbsp;context,
<a href="../SASLEnvelope.html" title="class in org.apache.qpid.protonj2.engine">SASLEnvelope</a>&nbsp;envelope)</code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code>void</code></div>
<div class="col-second odd-row-color"><span class="type-name-label">ProtonFrameLoggingHandler.</span><code><a href="../impl/ProtonFrameLoggingHandler.html#handleRead(org.apache.qpid.protonj2.engine.EngineHandlerContext,org.apache.qpid.protonj2.engine.SASLEnvelope)" class="member-name-link">handleRead</a><wbr>(<a href="../EngineHandlerContext.html" title="interface in org.apache.qpid.protonj2.engine">EngineHandlerContext</a>&nbsp;context,
<a href="../SASLEnvelope.html" title="class in org.apache.qpid.protonj2.engine">SASLEnvelope</a>&nbsp;envelope)</code></div>
<div class="col-last odd-row-color">&nbsp;</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#handleWrite(org.apache.qpid.protonj2.engine.EngineHandlerContext,org.apache.qpid.protonj2.engine.SASLEnvelope)" class="member-name-link">handleWrite</a><wbr>(<a href="../EngineHandlerContext.html" title="interface in org.apache.qpid.protonj2.engine">EngineHandlerContext</a>&nbsp;context,
<a href="../SASLEnvelope.html" title="class in org.apache.qpid.protonj2.engine">SASLEnvelope</a>&nbsp;envelope)</code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code>void</code></div>
<div class="col-second odd-row-color"><span class="type-name-label">ProtonFrameEncodingHandler.</span><code><a href="../impl/ProtonFrameEncodingHandler.html#handleWrite(org.apache.qpid.protonj2.engine.EngineHandlerContext,org.apache.qpid.protonj2.engine.SASLEnvelope)" class="member-name-link">handleWrite</a><wbr>(<a href="../EngineHandlerContext.html" title="interface in org.apache.qpid.protonj2.engine">EngineHandlerContext</a>&nbsp;context,
<a href="../SASLEnvelope.html" title="class in org.apache.qpid.protonj2.engine">SASLEnvelope</a>&nbsp;envelope)</code></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><code>void</code></div>
<div class="col-second even-row-color"><span class="type-name-label">ProtonFrameLoggingHandler.</span><code><a href="../impl/ProtonFrameLoggingHandler.html#handleWrite(org.apache.qpid.protonj2.engine.EngineHandlerContext,org.apache.qpid.protonj2.engine.SASLEnvelope)" class="member-name-link">handleWrite</a><wbr>(<a href="../EngineHandlerContext.html" title="interface in org.apache.qpid.protonj2.engine">EngineHandlerContext</a>&nbsp;context,
<a href="../SASLEnvelope.html" title="class in org.apache.qpid.protonj2.engine">SASLEnvelope</a>&nbsp;envelope)</code></div>
<div class="col-last even-row-color">&nbsp;</div>
</div>
</section>
</li>
<li>
<section class="detail" id="org.apache.qpid.protonj2.engine.impl.sasl">
<h2>Uses of <a href="../SASLEnvelope.html" title="class in org.apache.qpid.protonj2.engine">SASLEnvelope</a> in <a href="../impl/sasl/package-summary.html">org.apache.qpid.protonj2.engine.impl.sasl</a></h2>
<div class="caption"><span>Methods in <a href="../impl/sasl/package-summary.html">org.apache.qpid.protonj2.engine.impl.sasl</a> with parameters of type <a href="../SASLEnvelope.html" title="class in org.apache.qpid.protonj2.engine">SASLEnvelope</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">ProtonSaslHandler.</span><code><a href="../impl/sasl/ProtonSaslHandler.html#handleRead(org.apache.qpid.protonj2.engine.EngineHandlerContext,org.apache.qpid.protonj2.engine.SASLEnvelope)" class="member-name-link">handleRead</a><wbr>(<a href="../EngineHandlerContext.html" title="interface in org.apache.qpid.protonj2.engine">EngineHandlerContext</a>&nbsp;context,
<a href="../SASLEnvelope.html" title="class in org.apache.qpid.protonj2.engine">SASLEnvelope</a>&nbsp;frame)</code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code>void</code></div>
<div class="col-second odd-row-color"><span class="type-name-label">ProtonSaslHandler.</span><code><a href="../impl/sasl/ProtonSaslHandler.html#handleWrite(org.apache.qpid.protonj2.engine.EngineHandlerContext,org.apache.qpid.protonj2.engine.SASLEnvelope)" class="member-name-link">handleWrite</a><wbr>(<a href="../EngineHandlerContext.html" title="interface in org.apache.qpid.protonj2.engine">EngineHandlerContext</a>&nbsp;context,
<a href="../SASLEnvelope.html" title="class in org.apache.qpid.protonj2.engine">SASLEnvelope</a>&nbsp;frame)</code></div>
<div class="col-last odd-row-color">&nbsp;</div>
</div>
</section>
</li>
</ul>
</section>
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &#169; 2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>