| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>ProtonFrameDecodingHandler (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="declaration: package: org.apache.qpid.protonj2.engine.impl, class: ProtonFrameDecodingHandler"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../script.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| </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 class="nav-bar-cell1-rev">Class</li> |
| <li><a href="class-use/ProtonFrameDecodingHandler.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../help-doc.html#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field-summary">Field</a> | </li> |
| <li><a href="#constructor-summary">Constr</a> | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li><a href="#field-detail">Field</a> | </li> |
| <li><a href="#constructor-detail">Constr</a> | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.qpid.protonj2.engine.impl</a></div> |
| <h1 title="Class ProtonFrameDecodingHandler" class="title">Class ProtonFrameDecodingHandler</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> |
| <div class="inheritance">org.apache.qpid.protonj2.engine.impl.ProtonFrameDecodingHandler</div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="../EngineHandler.html" title="interface in org.apache.qpid.protonj2.engine">EngineHandler</a></code>, <code><a href="../../types/security/SaslPerformative.SaslPerformativeHandler.html" title="interface in org.apache.qpid.protonj2.types.security">SaslPerformative.SaslPerformativeHandler</a><<a href="../EngineHandlerContext.html" title="interface in org.apache.qpid.protonj2.engine">EngineHandlerContext</a>></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">ProtonFrameDecodingHandler</span> |
| <span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> |
| implements <a href="../EngineHandler.html" title="interface in org.apache.qpid.protonj2.engine">EngineHandler</a>, <a href="../../types/security/SaslPerformative.SaslPerformativeHandler.html" title="interface in org.apache.qpid.protonj2.types.security">SaslPerformative.SaslPerformativeHandler</a><<a href="../EngineHandlerContext.html" title="interface in org.apache.qpid.protonj2.engine">EngineHandlerContext</a>></span></div> |
| <div class="block">Handler used to parse incoming frame data input into the engine</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="caption"><span>Fields</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">Field</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>static final byte</code></div> |
| <div class="col-second even-row-color"><code><a href="#AMQP_FRAME_TYPE" class="member-name-link">AMQP_FRAME_TYPE</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Frame type indicator for AMQP protocol frames.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>static final int</code></div> |
| <div class="col-second odd-row-color"><code><a href="#FRAME_SIZE_BYTES" class="member-name-link">FRAME_SIZE_BYTES</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">The specified encoding size for the frame size value of each encoded frame.</div> |
| </div> |
| <div class="col-first even-row-color"><code>static final byte</code></div> |
| <div class="col-second even-row-color"><code><a href="#SASL_FRAME_TYPE" class="member-name-link">SASL_FRAME_TYPE</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Frame type indicator for SASL protocol frames.</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor-summary"> |
| <h2>Constructor Summary</h2> |
| <div class="caption"><span>Constructors</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">ProtonFrameDecodingHandler</a>()</code></div> |
| <div class="col-last even-row-color"> </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <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 method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#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="../exceptions/EngineFailedException.html" title="class in org.apache.qpid.protonj2.engine.exceptions">EngineFailedException</a> failure)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <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 method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#handleOutcome(org.apache.qpid.protonj2.types.security.SaslOutcome,org.apache.qpid.protonj2.engine.EngineHandlerContext)" class="member-name-link">handleOutcome</a><wbr>(<a href="../../types/security/SaslOutcome.html" title="class in org.apache.qpid.protonj2.types.security">SaslOutcome</a> saslOutcome, |
| <a href="../EngineHandlerContext.html" title="interface in org.apache.qpid.protonj2.engine">EngineHandlerContext</a> context)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#handlerAdded(org.apache.qpid.protonj2.engine.EngineHandlerContext)" class="member-name-link">handlerAdded</a><wbr>(<a href="../EngineHandlerContext.html" title="interface in org.apache.qpid.protonj2.engine">EngineHandlerContext</a> context)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Called when the handler is successfully added to the <a href="../EnginePipeline.html" title="interface in org.apache.qpid.protonj2.engine"><code>EnginePipeline</code></a> and |
| will later be initialized before use.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#handleRead(org.apache.qpid.protonj2.engine.EngineHandlerContext,org.apache.qpid.protonj2.buffer.ProtonBuffer)" class="member-name-link">handleRead</a><wbr>(<a href="../EngineHandlerContext.html" title="interface in org.apache.qpid.protonj2.engine">EngineHandlerContext</a> context, |
| <a href="../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a> buffer)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Handle the read of new incoming bytes from a remote sender.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#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> context, |
| <a href="../SASLEnvelope.html" title="class in org.apache.qpid.protonj2.engine">SASLEnvelope</a> envelope)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <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 method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#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> context, |
| <a href="../SASLEnvelope.html" title="class in org.apache.qpid.protonj2.engine">SASLEnvelope</a> envelope)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <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> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.qpid.protonj2.engine.EngineHandler">Methods inherited from interface org.apache.qpid.protonj2.engine.<a href="../EngineHandler.html" title="interface in org.apache.qpid.protonj2.engine">EngineHandler</a></h3> |
| <code><a href="../EngineHandler.html#engineStarting(org.apache.qpid.protonj2.engine.EngineHandlerContext)">engineStarting</a>, <a href="../EngineHandler.html#handleEngineStateChanged(org.apache.qpid.protonj2.engine.EngineHandlerContext)">handleEngineStateChanged</a>, <a href="../EngineHandler.html#handleRead(org.apache.qpid.protonj2.engine.EngineHandlerContext,org.apache.qpid.protonj2.engine.HeaderEnvelope)">handleRead</a>, <a href="../EngineHandler.html#handleRead(org.apache.qpid.protonj2.engine.EngineHandlerContext,org.apache.qpid.protonj2.engine.IncomingAMQPEnvelope)">handleRead</a>, <a href="../EngineHandler.html#handlerRemoved(org.apache.qpid.protonj2.engine.EngineHandlerContext)">handlerRemoved</a>, <a href="../EngineHandler.html#handleWrite(org.apache.qpid.protonj2.engine.EngineHandlerContext,org.apache.qpid.protonj2.buffer.ProtonBuffer,java.lang.Runnable)">handleWrite</a>, <a href="../EngineHandler.html#handleWrite(org.apache.qpid.protonj2.engine.EngineHandlerContext,org.apache.qpid.protonj2.engine.HeaderEnvelope)">handleWrite</a>, <a href="../EngineHandler.html#handleWrite(org.apache.qpid.protonj2.engine.EngineHandlerContext,org.apache.qpid.protonj2.engine.OutgoingAMQPEnvelope)">handleWrite</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.qpid.protonj2.types.security.SaslPerformative.SaslPerformativeHandler">Methods inherited from interface org.apache.qpid.protonj2.types.security.<a href="../../types/security/SaslPerformative.SaslPerformativeHandler.html" title="interface in org.apache.qpid.protonj2.types.security">SaslPerformative.SaslPerformativeHandler</a></h3> |
| <code><a href="../../types/security/SaslPerformative.SaslPerformativeHandler.html#handleChallenge(org.apache.qpid.protonj2.types.security.SaslChallenge,E)">handleChallenge</a>, <a href="../../types/security/SaslPerformative.SaslPerformativeHandler.html#handleInit(org.apache.qpid.protonj2.types.security.SaslInit,E)">handleInit</a>, <a href="../../types/security/SaslPerformative.SaslPerformativeHandler.html#handleMechanisms(org.apache.qpid.protonj2.types.security.SaslMechanisms,E)">handleMechanisms</a>, <a href="../../types/security/SaslPerformative.SaslPerformativeHandler.html#handleResponse(org.apache.qpid.protonj2.types.security.SaslResponse,E)">handleResponse</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <li> |
| <section class="field-details" id="field-detail"> |
| <h2>Field Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="AMQP_FRAME_TYPE"> |
| <h3>AMQP_FRAME_TYPE</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">byte</span> <span class="element-name">AMQP_FRAME_TYPE</span></div> |
| <div class="block">Frame type indicator for AMQP protocol frames.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../../constant-values.html#org.apache.qpid.protonj2.engine.impl.ProtonFrameDecodingHandler.AMQP_FRAME_TYPE">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="SASL_FRAME_TYPE"> |
| <h3>SASL_FRAME_TYPE</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">byte</span> <span class="element-name">SASL_FRAME_TYPE</span></div> |
| <div class="block">Frame type indicator for SASL protocol frames.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../../constant-values.html#org.apache.qpid.protonj2.engine.impl.ProtonFrameDecodingHandler.SASL_FRAME_TYPE">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="FRAME_SIZE_BYTES"> |
| <h3>FRAME_SIZE_BYTES</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">int</span> <span class="element-name">FRAME_SIZE_BYTES</span></div> |
| <div class="block">The specified encoding size for the frame size value of each encoded frame.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../../constant-values.html#org.apache.qpid.protonj2.engine.impl.ProtonFrameDecodingHandler.FRAME_SIZE_BYTES">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>()"> |
| <h3>ProtonFrameDecodingHandler</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">ProtonFrameDecodingHandler</span>()</div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="handlerAdded(org.apache.qpid.protonj2.engine.EngineHandlerContext)"> |
| <h3>handlerAdded</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">handlerAdded</span><wbr><span class="parameters">(<a href="../EngineHandlerContext.html" title="interface in org.apache.qpid.protonj2.engine">EngineHandlerContext</a> context)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../EngineHandler.html#handlerAdded(org.apache.qpid.protonj2.engine.EngineHandlerContext)">EngineHandler</a></code></span></div> |
| <div class="block">Called when the handler is successfully added to the <a href="../EnginePipeline.html" title="interface in org.apache.qpid.protonj2.engine"><code>EnginePipeline</code></a> and |
| will later be initialized before use.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../EngineHandler.html#handlerAdded(org.apache.qpid.protonj2.engine.EngineHandlerContext)">handlerAdded</a></code> in interface <code><a href="../EngineHandler.html" title="interface in org.apache.qpid.protonj2.engine">EngineHandler</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>context</code> - The context that is assigned to this handler.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="engineFailed(org.apache.qpid.protonj2.engine.EngineHandlerContext,org.apache.qpid.protonj2.engine.exceptions.EngineFailedException)"> |
| <h3>engineFailed</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">engineFailed</span><wbr><span class="parameters">(<a href="../EngineHandlerContext.html" title="interface in org.apache.qpid.protonj2.engine">EngineHandlerContext</a> context, |
| <a href="../exceptions/EngineFailedException.html" title="class in org.apache.qpid.protonj2.engine.exceptions">EngineFailedException</a> failure)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../EngineHandler.html#engineFailed(org.apache.qpid.protonj2.engine.EngineHandlerContext,org.apache.qpid.protonj2.engine.exceptions.EngineFailedException)">EngineHandler</a></code></span></div> |
| <div class="block">Called when the engine has transitioned to a failed state and cannot process any additional |
| input or output. The handler can free and resources used for normal operations at this point |
| as the engine is now considered shutdown.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../EngineHandler.html#engineFailed(org.apache.qpid.protonj2.engine.EngineHandlerContext,org.apache.qpid.protonj2.engine.exceptions.EngineFailedException)">engineFailed</a></code> in interface <code><a href="../EngineHandler.html" title="interface in org.apache.qpid.protonj2.engine">EngineHandler</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>context</code> - The context for this handler which can be used to forward the event to the next handler</dd> |
| <dd><code>failure</code> - The failure that triggered the engine to cease operations.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="handleRead(org.apache.qpid.protonj2.engine.EngineHandlerContext,org.apache.qpid.protonj2.buffer.ProtonBuffer)"> |
| <h3>handleRead</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">handleRead</span><wbr><span class="parameters">(<a href="../EngineHandlerContext.html" title="interface in org.apache.qpid.protonj2.engine">EngineHandlerContext</a> context, |
| <a href="../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a> buffer)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../EngineHandler.html#handleRead(org.apache.qpid.protonj2.engine.EngineHandlerContext,org.apache.qpid.protonj2.buffer.ProtonBuffer)">EngineHandler</a></code></span></div> |
| <div class="block">Handle the read of new incoming bytes from a remote sender. The handler should generally |
| decode these bytes into an AMQP Performative or SASL Performative based on the current state |
| of the connection and the handler in question.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../EngineHandler.html#handleRead(org.apache.qpid.protonj2.engine.EngineHandlerContext,org.apache.qpid.protonj2.buffer.ProtonBuffer)">handleRead</a></code> in interface <code><a href="../EngineHandler.html" title="interface in org.apache.qpid.protonj2.engine">EngineHandler</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>context</code> - The context for this handler which can be used to forward the event to the next handler</dd> |
| <dd><code>buffer</code> - The buffer containing the bytes that the engine handler should decode.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="handleRead(org.apache.qpid.protonj2.engine.EngineHandlerContext,org.apache.qpid.protonj2.engine.SASLEnvelope)"> |
| <h3>handleRead</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">handleRead</span><wbr><span class="parameters">(<a href="../EngineHandlerContext.html" title="interface in org.apache.qpid.protonj2.engine">EngineHandlerContext</a> context, |
| <a href="../SASLEnvelope.html" title="class in org.apache.qpid.protonj2.engine">SASLEnvelope</a> envelope)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../EngineHandler.html#handleRead(org.apache.qpid.protonj2.engine.EngineHandlerContext,org.apache.qpid.protonj2.engine.SASLEnvelope)">EngineHandler</a></code></span></div> |
| <div class="block">Handle the receipt of an incoming SASL performative based on the current state of this handler.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../EngineHandler.html#handleRead(org.apache.qpid.protonj2.engine.EngineHandlerContext,org.apache.qpid.protonj2.engine.SASLEnvelope)">handleRead</a></code> in interface <code><a href="../EngineHandler.html" title="interface in org.apache.qpid.protonj2.engine">EngineHandler</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>context</code> - The context for this handler which can be used to forward the event to the next handler</dd> |
| <dd><code>envelope</code> - The SASL envelope that wraps the received <a href="../../types/security/SaslPerformative.html" title="interface in org.apache.qpid.protonj2.types.security"><code>SaslPerformative</code></a>.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="handleWrite(org.apache.qpid.protonj2.engine.EngineHandlerContext,org.apache.qpid.protonj2.engine.SASLEnvelope)"> |
| <h3>handleWrite</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">handleWrite</span><wbr><span class="parameters">(<a href="../EngineHandlerContext.html" title="interface in org.apache.qpid.protonj2.engine">EngineHandlerContext</a> context, |
| <a href="../SASLEnvelope.html" title="class in org.apache.qpid.protonj2.engine">SASLEnvelope</a> envelope)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../EngineHandler.html#handleWrite(org.apache.qpid.protonj2.engine.EngineHandlerContext,org.apache.qpid.protonj2.engine.SASLEnvelope)">EngineHandler</a></code></span></div> |
| <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> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../EngineHandler.html#handleWrite(org.apache.qpid.protonj2.engine.EngineHandlerContext,org.apache.qpid.protonj2.engine.SASLEnvelope)">handleWrite</a></code> in interface <code><a href="../EngineHandler.html" title="interface in org.apache.qpid.protonj2.engine">EngineHandler</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>context</code> - The <a href="../EngineHandlerContext.html" title="interface in org.apache.qpid.protonj2.engine"><code>EngineHandlerContext</code></a> associated with this <a href="../EngineHandler.html" title="interface in org.apache.qpid.protonj2.engine"><code>EngineHandler</code></a> instance.</dd> |
| <dd><code>envelope</code> - The <a href="../SASLEnvelope.html" title="class in org.apache.qpid.protonj2.engine"><code>SASLEnvelope</code></a> instance to write.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="handleOutcome(org.apache.qpid.protonj2.types.security.SaslOutcome,org.apache.qpid.protonj2.engine.EngineHandlerContext)"> |
| <h3>handleOutcome</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">handleOutcome</span><wbr><span class="parameters">(<a href="../../types/security/SaslOutcome.html" title="class in org.apache.qpid.protonj2.types.security">SaslOutcome</a> saslOutcome, |
| <a href="../EngineHandlerContext.html" title="interface in org.apache.qpid.protonj2.engine">EngineHandlerContext</a> context)</span></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../../types/security/SaslPerformative.SaslPerformativeHandler.html#handleOutcome(org.apache.qpid.protonj2.types.security.SaslOutcome,E)">handleOutcome</a></code> in interface <code><a href="../../types/security/SaslPerformative.SaslPerformativeHandler.html" title="interface in org.apache.qpid.protonj2.types.security">SaslPerformative.SaslPerformativeHandler</a><<a href="../EngineHandlerContext.html" title="interface in org.apache.qpid.protonj2.engine">EngineHandlerContext</a>></code></dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |