| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) on Thu Sep 15 14:12:07 CDT 2022 --> |
| <title>ExtensionStack (Eclipse Jetty API Doc - v10.0.12)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2022-09-15"> |
| <meta name="description" content="declaration: package: org.eclipse.jetty.websocket.core.internal, class: ExtensionStack"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../script-dir/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../../script-dir/jquery-3.5.1.min.js"></script> |
| <script type="text/javascript" src="../../../../../../script-dir/jquery-ui.min.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"; |
| var pathtoroot = "../../../../../../"; |
| loadScripts(document, 'script');</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/ExtensionStack.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../index-all.html">Index</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><a href="#nested-class-summary">Nested</a> | </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>Field | </li> |
| <li><a href="#constructor-detail">Constr</a> | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search-input">SEARCH:</label> |
| <input type="text" id="search-input" value="search" disabled="disabled"> |
| <input type="reset" id="reset-button" value="reset" disabled="disabled"> |
| </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.eclipse.jetty.websocket.core.internal</a></div> |
| <h1 title="Class ExtensionStack" class="title">Class ExtensionStack</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.eclipse.jetty.websocket.core.internal.ExtensionStack</div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="../../../util/component/Dumpable.html" title="interface in org.eclipse.jetty.util.component">Dumpable</a></code>, <code><a href="../IncomingFrames.html" title="interface in org.eclipse.jetty.websocket.core">IncomingFrames</a></code>, <code><a href="../OutgoingFrames.html" title="interface in org.eclipse.jetty.websocket.core">OutgoingFrames</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="annotations"><a href="../../../util/annotation/ManagedObject.html" title="annotation in org.eclipse.jetty.util.annotation">@ManagedObject</a>("Extension Stack") |
| </span><span class="modifiers">public class </span><span class="element-name type-name-label">ExtensionStack</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="../IncomingFrames.html" title="interface in org.eclipse.jetty.websocket.core">IncomingFrames</a>, <a href="../OutgoingFrames.html" title="interface in org.eclipse.jetty.websocket.core">OutgoingFrames</a>, <a href="../../../util/component/Dumpable.html" title="interface in org.eclipse.jetty.util.component">Dumpable</a></span></div> |
| <div class="block">Represents the stack of Extensions.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <li> |
| <section class="nested-class-summary" id="nested-class-summary"> |
| <h2>Nested Class Summary</h2> |
| <div class="inherited-list"> |
| <h2 id="nested-classes-inherited-from-class-org.eclipse.jetty.util.component.Dumpable">Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.<a href="../../../util/component/Dumpable.html" title="interface in org.eclipse.jetty.util.component">Dumpable</a></h2> |
| <code><a href="../../../util/component/Dumpable.DumpableContainer.html" title="interface in org.eclipse.jetty.util.component">Dumpable.DumpableContainer</a></code></div> |
| </section> |
| </li> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-org.eclipse.jetty.util.component.Dumpable">Fields inherited from interface org.eclipse.jetty.util.component.<a href="../../../util/component/Dumpable.html" title="interface in org.eclipse.jetty.util.component">Dumpable</a></h3> |
| <code><a href="../../../util/component/Dumpable.html#KEY">KEY</a></code></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(org.eclipse.jetty.websocket.core.WebSocketComponents,org.eclipse.jetty.websocket.core.Behavior)" class="member-name-link">ExtensionStack</a><wbr>(<a href="../WebSocketComponents.html" title="class in org.eclipse.jetty.websocket.core">WebSocketComponents</a> components, |
| <a href="../Behavior.html" title="enum in org.eclipse.jetty.websocket.core">Behavior</a> behavior)</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="#close()" class="member-name-link">close</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </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="#demand(long)" class="member-name-link">demand</a><wbr>(long n)</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><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></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#dump()" class="member-name-link">dump</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </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="#dump(java.lang.Appendable,java.lang.String)" class="member-name-link">dump</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Appendable.html" title="class or interface in java.lang" class="external-link">Appendable</a> out, |
| <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> indent)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Dump this object (and children) into an Appendable using the provided indent after any new lines.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><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></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#dumpSelf()" class="member-name-link">dumpSelf</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">The description of this/self found in the dump.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="../Extension.html" title="interface in org.eclipse.jetty.websocket.core">Extension</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getExtensions()" class="member-name-link">getExtensions</a>()</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><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="../ExtensionConfig.html" title="class in org.eclipse.jetty.websocket.core">ExtensionConfig</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getNegotiatedExtensions()" class="member-name-link">getNegotiatedExtensions</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Get the list of negotiated extensions, each entry being a full "name; params" extension configuration</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../IncomingFrames.html" title="interface in org.eclipse.jetty.websocket.core">IncomingFrames</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getNextIncoming()" class="member-name-link">getNextIncoming</a>()</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><a href="../OutgoingFrames.html" title="interface in org.eclipse.jetty.websocket.core">OutgoingFrames</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getNextOutgoing()" class="member-name-link">getNextOutgoing</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../Extension.html" title="interface in org.eclipse.jetty.websocket.core">Extension</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRsv1User()" class="member-name-link">getRsv1User</a>()</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><a href="../Extension.html" title="interface in org.eclipse.jetty.websocket.core">Extension</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRsv2User()" class="member-name-link">getRsv2User</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../Extension.html" title="interface in org.eclipse.jetty.websocket.core">Extension</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRsv3User()" class="member-name-link">getRsv3User</a>()</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>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#hasNegotiatedExtensions()" class="member-name-link">hasNegotiatedExtensions</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </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="#initialize(org.eclipse.jetty.websocket.core.IncomingFrames,org.eclipse.jetty.websocket.core.OutgoingFrames,org.eclipse.jetty.websocket.core.internal.WebSocketCoreSession)" class="member-name-link">initialize</a><wbr>(<a href="../IncomingFrames.html" title="interface in org.eclipse.jetty.websocket.core">IncomingFrames</a> incoming, |
| <a href="../OutgoingFrames.html" title="interface in org.eclipse.jetty.websocket.core">OutgoingFrames</a> outgoing, |
| <a href="WebSocketCoreSession.html" title="class in org.eclipse.jetty.websocket.core.internal">WebSocketCoreSession</a> coreSession)</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>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isRsv1Used()" class="member-name-link">isRsv1Used</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isRsv2Used()" class="member-name-link">isRsv2Used</a>()</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>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isRsv3Used()" class="member-name-link">isRsv3Used</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </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="#negotiate(java.util.List,java.util.List)" class="member-name-link">negotiate</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="../ExtensionConfig.html" title="class in org.eclipse.jetty.websocket.core">ExtensionConfig</a>> offeredConfigs, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="../ExtensionConfig.html" title="class in org.eclipse.jetty.websocket.core">ExtensionConfig</a>> negotiatedConfigs)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Perform the extension negotiation.</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="#onFrame(org.eclipse.jetty.websocket.core.Frame,org.eclipse.jetty.util.Callback)" class="member-name-link">onFrame</a><wbr>(<a href="../Frame.html" title="class in org.eclipse.jetty.websocket.core">Frame</a> frame, |
| <a href="../../../util/Callback.html" title="interface in org.eclipse.jetty.util">Callback</a> callback)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Process the incoming frame.</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="#sendFrame(org.eclipse.jetty.websocket.core.Frame,org.eclipse.jetty.util.Callback,boolean)" class="member-name-link">sendFrame</a><wbr>(<a href="../Frame.html" title="class in org.eclipse.jetty.websocket.core">Frame</a> frame, |
| <a href="../../../util/Callback.html" title="interface in org.eclipse.jetty.util">Callback</a> callback, |
| boolean batch)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">A frame, and optional callback, intended for the network layer.</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="#setLastDemand(java.util.function.LongConsumer)" class="member-name-link">setLastDemand</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/function/LongConsumer.html" title="class or interface in java.util.function" class="external-link">LongConsumer</a> lastDemand)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><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></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString()" class="member-name-link">toString</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </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#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> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>(org.eclipse.jetty.websocket.core.WebSocketComponents,org.eclipse.jetty.websocket.core.Behavior)"> |
| <h3>ExtensionStack</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">ExtensionStack</span><wbr><span class="parameters">(<a href="../WebSocketComponents.html" title="class in org.eclipse.jetty.websocket.core">WebSocketComponents</a> components, |
| <a href="../Behavior.html" title="enum in org.eclipse.jetty.websocket.core">Behavior</a> behavior)</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="close()"> |
| <h3>close</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">close</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getExtensions()"> |
| <h3>getExtensions</h3> |
| <div class="member-signature"><span class="annotations"><a href="../../../util/annotation/ManagedAttribute.html" title="annotation in org.eclipse.jetty.util.annotation">@ManagedAttribute</a>(<a href="../../../util/annotation/ManagedAttribute.html#name()">name</a>="Extension List", |
| <a href="../../../util/annotation/ManagedAttribute.html#readonly()">readonly</a>=true) |
| </span><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="../Extension.html" title="interface in org.eclipse.jetty.websocket.core">Extension</a>></span> <span class="element-name">getExtensions</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getNegotiatedExtensions()"> |
| <h3>getNegotiatedExtensions</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="../ExtensionConfig.html" title="class in org.eclipse.jetty.websocket.core">ExtensionConfig</a>></span> <span class="element-name">getNegotiatedExtensions</span>()</div> |
| <div class="block">Get the list of negotiated extensions, each entry being a full "name; params" extension configuration</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>list of negotiated extensions</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getNextIncoming()"> |
| <h3>getNextIncoming</h3> |
| <div class="member-signature"><span class="annotations"><a href="../../../util/annotation/ManagedAttribute.html" title="annotation in org.eclipse.jetty.util.annotation">@ManagedAttribute</a>(<a href="../../../util/annotation/ManagedAttribute.html#name()">name</a>="Next Incoming Frames Handler", |
| <a href="../../../util/annotation/ManagedAttribute.html#readonly()">readonly</a>=true) |
| </span><span class="modifiers">public</span> <span class="return-type"><a href="../IncomingFrames.html" title="interface in org.eclipse.jetty.websocket.core">IncomingFrames</a></span> <span class="element-name">getNextIncoming</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getNextOutgoing()"> |
| <h3>getNextOutgoing</h3> |
| <div class="member-signature"><span class="annotations"><a href="../../../util/annotation/ManagedAttribute.html" title="annotation in org.eclipse.jetty.util.annotation">@ManagedAttribute</a>(<a href="../../../util/annotation/ManagedAttribute.html#name()">name</a>="Next Outgoing Frames Handler", |
| <a href="../../../util/annotation/ManagedAttribute.html#readonly()">readonly</a>=true) |
| </span><span class="modifiers">public</span> <span class="return-type"><a href="../OutgoingFrames.html" title="interface in org.eclipse.jetty.websocket.core">OutgoingFrames</a></span> <span class="element-name">getNextOutgoing</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="hasNegotiatedExtensions()"> |
| <h3>hasNegotiatedExtensions</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">hasNegotiatedExtensions</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="onFrame(org.eclipse.jetty.websocket.core.Frame,org.eclipse.jetty.util.Callback)"> |
| <h3>onFrame</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">onFrame</span><wbr><span class="parameters">(<a href="../Frame.html" title="class in org.eclipse.jetty.websocket.core">Frame</a> frame, |
| <a href="../../../util/Callback.html" title="interface in org.eclipse.jetty.util">Callback</a> callback)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../IncomingFrames.html#onFrame(org.eclipse.jetty.websocket.core.Frame,org.eclipse.jetty.util.Callback)">IncomingFrames</a></code></span></div> |
| <div class="block"><p>Process the incoming frame.</p> |
| |
| <p>Note: if you need to hang onto any information from the frame, be sure |
| to copy it, as the information contained in the Frame will be released |
| and/or reused by the implementation.</p> |
| |
| <p>Failure of the callback will propagate the failure back to the <a href="../CoreSession.html" title="interface in org.eclipse.jetty.websocket.core"><code>CoreSession</code></a> |
| to fail the connection and attempt to send a close <a href="../Frame.html" title="class in org.eclipse.jetty.websocket.core"><code>Frame</code></a> if one has not been sent.</p></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../IncomingFrames.html#onFrame(org.eclipse.jetty.websocket.core.Frame,org.eclipse.jetty.util.Callback)">onFrame</a></code> in interface <code><a href="../IncomingFrames.html" title="interface in org.eclipse.jetty.websocket.core">IncomingFrames</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>frame</code> - the frame to process.</dd> |
| <dd><code>callback</code> - the read completion.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="negotiate(java.util.List,java.util.List)"> |
| <h3>negotiate</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">negotiate</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="../ExtensionConfig.html" title="class in org.eclipse.jetty.websocket.core">ExtensionConfig</a>> offeredConfigs, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="../ExtensionConfig.html" title="class in org.eclipse.jetty.websocket.core">ExtensionConfig</a>> negotiatedConfigs)</span></div> |
| <div class="block">Perform the extension negotiation. |
| <p> |
| For the list of negotiated extensions, use <a href="#getNegotiatedExtensions()"><code>getNegotiatedExtensions()</code></a></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>offeredConfigs</code> - the configurations being requested by the client</dd> |
| <dd><code>negotiatedConfigs</code> - the configurations accepted by the server</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="sendFrame(org.eclipse.jetty.websocket.core.Frame,org.eclipse.jetty.util.Callback,boolean)"> |
| <h3>sendFrame</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">sendFrame</span><wbr><span class="parameters">(<a href="../Frame.html" title="class in org.eclipse.jetty.websocket.core">Frame</a> frame, |
| <a href="../../../util/Callback.html" title="interface in org.eclipse.jetty.util">Callback</a> callback, |
| boolean batch)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../OutgoingFrames.html#sendFrame(org.eclipse.jetty.websocket.core.Frame,org.eclipse.jetty.util.Callback,boolean)">OutgoingFrames</a></code></span></div> |
| <div class="block">A frame, and optional callback, intended for the network layer. |
| <p> |
| Note: the frame can undergo many transformations in the various |
| layers and extensions present in the implementation. |
| <p> |
| If you are implementing a mutation, you are obliged to handle |
| the incoming WriteCallback appropriately.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../OutgoingFrames.html#sendFrame(org.eclipse.jetty.websocket.core.Frame,org.eclipse.jetty.util.Callback,boolean)">sendFrame</a></code> in interface <code><a href="../OutgoingFrames.html" title="interface in org.eclipse.jetty.websocket.core">OutgoingFrames</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>frame</code> - the frame to eventually write to the network layer.</dd> |
| <dd><code>callback</code> - the callback to notify when the frame is written.</dd> |
| <dd><code>batch</code> - the batch mode requested by the sender.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="initialize(org.eclipse.jetty.websocket.core.IncomingFrames,org.eclipse.jetty.websocket.core.OutgoingFrames,org.eclipse.jetty.websocket.core.internal.WebSocketCoreSession)"> |
| <h3>initialize</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">initialize</span><wbr><span class="parameters">(<a href="../IncomingFrames.html" title="interface in org.eclipse.jetty.websocket.core">IncomingFrames</a> incoming, |
| <a href="../OutgoingFrames.html" title="interface in org.eclipse.jetty.websocket.core">OutgoingFrames</a> outgoing, |
| <a href="WebSocketCoreSession.html" title="class in org.eclipse.jetty.websocket.core.internal">WebSocketCoreSession</a> coreSession)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="demand(long)"> |
| <h3>demand</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">demand</span><wbr><span class="parameters">(long n)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setLastDemand(java.util.function.LongConsumer)"> |
| <h3>setLastDemand</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setLastDemand</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/function/LongConsumer.html" title="class or interface in java.util.function" class="external-link">LongConsumer</a> lastDemand)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getRsv1User()"> |
| <h3>getRsv1User</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../Extension.html" title="interface in org.eclipse.jetty.websocket.core">Extension</a></span> <span class="element-name">getRsv1User</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getRsv2User()"> |
| <h3>getRsv2User</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../Extension.html" title="interface in org.eclipse.jetty.websocket.core">Extension</a></span> <span class="element-name">getRsv2User</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getRsv3User()"> |
| <h3>getRsv3User</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../Extension.html" title="interface in org.eclipse.jetty.websocket.core">Extension</a></span> <span class="element-name">getRsv3User</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isRsv1Used()"> |
| <h3>isRsv1Used</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isRsv1Used</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isRsv2Used()"> |
| <h3>isRsv2Used</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isRsv2Used</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isRsv3Used()"> |
| <h3>isRsv3Used</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isRsv3Used</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="dump()"> |
| <h3>dump</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><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></span> <span class="element-name">dump</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../../../util/component/Dumpable.html#dump()">dump</a></code> in interface <code><a href="../../../util/component/Dumpable.html" title="interface in org.eclipse.jetty.util.component">Dumpable</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="dump(java.lang.Appendable,java.lang.String)"> |
| <h3>dump</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">dump</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Appendable.html" title="class or interface in java.lang" class="external-link">Appendable</a> out, |
| <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> indent)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../../../util/component/Dumpable.html#dump(java.lang.Appendable,java.lang.String)">Dumpable</a></code></span></div> |
| <div class="block">Dump this object (and children) into an Appendable using the provided indent after any new lines. |
| The indent should not be applied to the first object dumped.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../../../util/component/Dumpable.html#dump(java.lang.Appendable,java.lang.String)">dump</a></code> in interface <code><a href="../../../util/component/Dumpable.html" title="interface in org.eclipse.jetty.util.component">Dumpable</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>out</code> - The appendable to dump to</dd> |
| <dd><code>indent</code> - The indent to apply after any new lines.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - if unable to write to Appendable</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="dumpSelf()"> |
| <h3>dumpSelf</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><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></span> <span class="element-name">dumpSelf</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../../../util/component/Dumpable.html#dumpSelf()">Dumpable</a></code></span></div> |
| <div class="block">The description of this/self found in the dump. |
| Allows for alternative representation of Object other then .toString() |
| where the long form output of toString() is represented in a cleaner way |
| within the dump infrastructure.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../../../util/component/Dumpable.html#dumpSelf()">dumpSelf</a></code> in interface <code><a href="../../../util/component/Dumpable.html" title="interface in org.eclipse.jetty.util.component">Dumpable</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>the representation of self</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="toString()"> |
| <h3>toString</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><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></span> <span class="element-name">toString</span>()</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><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></code> in class <code><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></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 © 1995–2022 <a href="https://webtide.com">Webtide</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
