blob: 193e90d66332208a4e2bb4caaea59a3e58910a45 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Thu Sep 15 14:12:07 CDT 2022 -->
<title>AbstractExtension (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, class: AbstractExtension">
<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/AbstractExtension.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor-summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor-detail">Constr</a>&nbsp;|&nbsp;</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>&nbsp;<a href="package-summary.html">org.eclipse.jetty.websocket.core</a></div>
<h1 title="Class AbstractExtension" class="title">Class AbstractExtension</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.AbstractExtension</div>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/Closeable.html" title="class or interface in java.io" class="external-link">Closeable</a></code>, <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/AutoCloseable.html" title="class or interface in java.lang" class="external-link">AutoCloseable</a></code>, <code><a href="Extension.html" title="interface in org.eclipse.jetty.websocket.core">Extension</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>
<dl class="notes">
<dt>Direct Known Subclasses:</dt>
<dd><code><a href="internal/FragmentExtension.html" title="class in org.eclipse.jetty.websocket.core.internal">FragmentExtension</a></code>, <code><a href="internal/FrameCaptureExtension.html" title="class in org.eclipse.jetty.websocket.core.internal">FrameCaptureExtension</a></code>, <code><a href="internal/IdentityExtension.html" title="class in org.eclipse.jetty.websocket.core.internal">IdentityExtension</a></code>, <code><a href="internal/PerMessageDeflateExtension.html" title="class in org.eclipse.jetty.websocket.core.internal">PerMessageDeflateExtension</a></code>, <code><a href="internal/ValidationExtension.html" title="class in org.eclipse.jetty.websocket.core.internal">ValidationExtension</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>("Abstract Extension")
</span><span class="modifiers">public class </span><span class="element-name type-name-label">AbstractExtension</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="Extension.html" title="interface in org.eclipse.jetty.websocket.core">Extension</a></span></div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- ======== 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">AbstractExtension</a>()</code></div>
<div class="col-last even-row-color">&nbsp;</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><a href="../../io/ByteBufferPool.html" title="interface in org.eclipse.jetty.io">ByteBufferPool</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getBufferPool()" class="member-name-link">getBufferPool</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ExtensionConfig.html" title="class in org.eclipse.jetty.websocket.core">ExtensionConfig</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getConfig()" class="member-name-link">getConfig</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">The active configuration for this extension.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected <a href="Configuration.html" title="interface in org.eclipse.jetty.websocket.core">Configuration</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getConfiguration()" class="member-name-link">getConfiguration</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="CoreSession.html" title="interface in org.eclipse.jetty.websocket.core">CoreSession</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getCoreSession()" class="member-name-link">getCoreSession</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../../util/compression/DeflaterPool.html" title="class in org.eclipse.jetty.util.compression">DeflaterPool</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getDeflaterPool()" class="member-name-link">getDeflaterPool</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../../util/compression/InflaterPool.html" title="class in org.eclipse.jetty.util.compression">InflaterPool</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getInflaterPool()" class="member-name-link">getInflaterPool</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</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="#getName()" class="member-name-link">getName</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 <code>Sec-WebSocket-Extensions</code> name for this extension.</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">&nbsp;</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">&nbsp;</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="#init(org.eclipse.jetty.websocket.core.ExtensionConfig,org.eclipse.jetty.websocket.core.WebSocketComponents)" class="member-name-link">init</a><wbr>(<a href="ExtensionConfig.html" title="class in org.eclipse.jetty.websocket.core">ExtensionConfig</a>&nbsp;config,
<a href="WebSocketComponents.html" title="class in org.eclipse.jetty.websocket.core">WebSocketComponents</a>&nbsp;components)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</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="#isRsv1User()" class="member-name-link">isRsv1User</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Used to indicate that the extension makes use of the RSV1 bit of the base websocket framing.</div>
</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="#isRsv2User()" class="member-name-link">isRsv2User</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Used to indicate that the extension makes use of the RSV2 bit of the base websocket framing.</div>
</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="#isRsv3User()" class="member-name-link">isRsv3User</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Used to indicate that the extension makes use of the RSV3 bit of the base websocket framing.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#nextIncomingFrame(org.eclipse.jetty.websocket.core.Frame,org.eclipse.jetty.util.Callback)" class="member-name-link">nextIncomingFrame</a><wbr>(<a href="Frame.html" title="class in org.eclipse.jetty.websocket.core">Frame</a>&nbsp;frame,
<a href="../../util/Callback.html" title="interface in org.eclipse.jetty.util">Callback</a>&nbsp;callback)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#nextOutgoingFrame(org.eclipse.jetty.websocket.core.Frame,org.eclipse.jetty.util.Callback,boolean)" class="member-name-link">nextOutgoingFrame</a><wbr>(<a href="Frame.html" title="class in org.eclipse.jetty.websocket.core">Frame</a>&nbsp;frame,
<a href="../../util/Callback.html" title="interface in org.eclipse.jetty.util">Callback</a>&nbsp;callback,
boolean&nbsp;batch)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</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="#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>&nbsp;frame,
<a href="../../util/Callback.html" title="interface in org.eclipse.jetty.util">Callback</a>&nbsp;callback)</code></div>
<div class="col-last odd-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 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="#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>&nbsp;frame,
<a href="../../util/Callback.html" title="interface in org.eclipse.jetty.util">Callback</a>&nbsp;callback,
boolean&nbsp;batch)</code></div>
<div class="col-last even-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 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="#setCoreSession(org.eclipse.jetty.websocket.core.CoreSession)" class="member-name-link">setCoreSession</a><wbr>(<a href="CoreSession.html" title="interface in org.eclipse.jetty.websocket.core">CoreSession</a>&nbsp;coreSession)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</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="#setNextIncomingFrames(org.eclipse.jetty.websocket.core.IncomingFrames)" class="member-name-link">setNextIncomingFrames</a><wbr>(<a href="IncomingFrames.html" title="interface in org.eclipse.jetty.websocket.core">IncomingFrames</a>&nbsp;nextIncoming)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Set the next <a href="IncomingFrames.html" title="interface in org.eclipse.jetty.websocket.core"><code>IncomingFrames</code></a> to call in the chain.</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="#setNextOutgoingFrames(org.eclipse.jetty.websocket.core.OutgoingFrames)" class="member-name-link">setNextOutgoingFrames</a><wbr>(<a href="OutgoingFrames.html" title="interface in org.eclipse.jetty.websocket.core">OutgoingFrames</a>&nbsp;nextOutgoing)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Set the next <a href="OutgoingFrames.html" title="interface in org.eclipse.jetty.websocket.core"><code>OutgoingFrames</code></a> to call in the chain.</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="#toString()" class="member-name-link">toString</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class&nbsp;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>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-org.eclipse.jetty.websocket.core.Extension">Methods inherited from interface&nbsp;org.eclipse.jetty.websocket.core.<a href="Extension.html" title="interface in org.eclipse.jetty.websocket.core">Extension</a></h3>
<code><a href="Extension.html#close()">close</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="&lt;init&gt;()">
<h3>AbstractExtension</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">AbstractExtension</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="init(org.eclipse.jetty.websocket.core.ExtensionConfig,org.eclipse.jetty.websocket.core.WebSocketComponents)">
<h3>init</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">init</span><wbr><span class="parameters">(<a href="ExtensionConfig.html" title="class in org.eclipse.jetty.websocket.core">ExtensionConfig</a>&nbsp;config,
<a href="WebSocketComponents.html" title="class in org.eclipse.jetty.websocket.core">WebSocketComponents</a>&nbsp;components)</span></div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="Extension.html#init(org.eclipse.jetty.websocket.core.ExtensionConfig,org.eclipse.jetty.websocket.core.WebSocketComponents)">init</a></code>&nbsp;in interface&nbsp;<code><a href="Extension.html" title="interface in org.eclipse.jetty.websocket.core">Extension</a></code></dd>
</dl>
</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>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">onFrame</span><wbr><span class="parameters">(<a href="Frame.html" title="class in org.eclipse.jetty.websocket.core">Frame</a>&nbsp;frame,
<a href="../../util/Callback.html" title="interface in org.eclipse.jetty.util">Callback</a>&nbsp;callback)</span></div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<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>&nbsp;in interface&nbsp;<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="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>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">sendFrame</span><wbr><span class="parameters">(<a href="Frame.html" title="class in org.eclipse.jetty.websocket.core">Frame</a>&nbsp;frame,
<a href="../../util/Callback.html" title="interface in org.eclipse.jetty.util">Callback</a>&nbsp;callback,
boolean&nbsp;batch)</span></div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<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>&nbsp;in interface&nbsp;<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="getBufferPool()">
<h3>getBufferPool</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="../../io/ByteBufferPool.html" title="interface in org.eclipse.jetty.io">ByteBufferPool</a></span>&nbsp;<span class="element-name">getBufferPool</span>()</div>
</section>
</li>
<li>
<section class="detail" id="getConfig()">
<h3>getConfig</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="ExtensionConfig.html" title="class in org.eclipse.jetty.websocket.core">ExtensionConfig</a></span>&nbsp;<span class="element-name">getConfig</span>()</div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="Extension.html#getConfig()">Extension</a></code></span></div>
<div class="block">The active configuration for this extension.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="Extension.html#getConfig()">getConfig</a></code>&nbsp;in interface&nbsp;<code><a href="Extension.html" title="interface in org.eclipse.jetty.websocket.core">Extension</a></code></dd>
<dt>Returns:</dt>
<dd>the configuration for this extension. never null.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getDeflaterPool()">
<h3>getDeflaterPool</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="../../util/compression/DeflaterPool.html" title="class in org.eclipse.jetty.util.compression">DeflaterPool</a></span>&nbsp;<span class="element-name">getDeflaterPool</span>()</div>
</section>
</li>
<li>
<section class="detail" id="getInflaterPool()">
<h3>getInflaterPool</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="../../util/compression/InflaterPool.html" title="class in org.eclipse.jetty.util.compression">InflaterPool</a></span>&nbsp;<span class="element-name">getInflaterPool</span>()</div>
</section>
</li>
<li>
<section class="detail" id="getName()">
<h3>getName</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<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>&nbsp;<span class="element-name">getName</span>()</div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="Extension.html#getName()">Extension</a></code></span></div>
<div class="block">The <code>Sec-WebSocket-Extensions</code> name for this extension.
<p>
Also known as the <a href="https://tools.ietf.org/html/rfc6455#section-9.1"><code>extension-token</code> per Section 9.1. Negotiating Extensions</a>.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="Extension.html#getName()">getName</a></code>&nbsp;in interface&nbsp;<code><a href="Extension.html" title="interface in org.eclipse.jetty.websocket.core">Extension</a></code></dd>
<dt>Returns:</dt>
<dd>the name of the extension</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 Frame Handler",
<a href="../../util/annotation/ManagedAttribute.html#readonly()">readonly</a>=true)
</span><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="IncomingFrames.html" title="interface in org.eclipse.jetty.websocket.core">IncomingFrames</a></span>&nbsp;<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 Frame Handler",
<a href="../../util/annotation/ManagedAttribute.html#readonly()">readonly</a>=true)
</span><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="OutgoingFrames.html" title="interface in org.eclipse.jetty.websocket.core">OutgoingFrames</a></span>&nbsp;<span class="element-name">getNextOutgoing</span>()</div>
</section>
</li>
<li>
<section class="detail" id="isRsv1User()">
<h3>isRsv1User</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">isRsv1User</span>()</div>
<div class="block">Used to indicate that the extension makes use of the RSV1 bit of the base websocket framing.
<p>
This is used to adjust validation during parsing, as well as a checkpoint against 2 or more extensions all simultaneously claiming ownership of RSV1.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="Extension.html#isRsv1User()">isRsv1User</a></code>&nbsp;in interface&nbsp;<code><a href="Extension.html" title="interface in org.eclipse.jetty.websocket.core">Extension</a></code></dd>
<dt>Returns:</dt>
<dd>true if extension uses RSV1 for its own purposes.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="isRsv2User()">
<h3>isRsv2User</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">isRsv2User</span>()</div>
<div class="block">Used to indicate that the extension makes use of the RSV2 bit of the base websocket framing.
<p>
This is used to adjust validation during parsing, as well as a checkpoint against 2 or more extensions all simultaneously claiming ownership of RSV2.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="Extension.html#isRsv2User()">isRsv2User</a></code>&nbsp;in interface&nbsp;<code><a href="Extension.html" title="interface in org.eclipse.jetty.websocket.core">Extension</a></code></dd>
<dt>Returns:</dt>
<dd>true if extension uses RSV2 for its own purposes.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="isRsv3User()">
<h3>isRsv3User</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">isRsv3User</span>()</div>
<div class="block">Used to indicate that the extension makes use of the RSV3 bit of the base websocket framing.
<p>
This is used to adjust validation during parsing, as well as a checkpoint against 2 or more extensions all simultaneously claiming ownership of RSV3.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="Extension.html#isRsv3User()">isRsv3User</a></code>&nbsp;in interface&nbsp;<code><a href="Extension.html" title="interface in org.eclipse.jetty.websocket.core">Extension</a></code></dd>
<dt>Returns:</dt>
<dd>true if extension uses RSV3 for its own purposes.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="nextIncomingFrame(org.eclipse.jetty.websocket.core.Frame,org.eclipse.jetty.util.Callback)">
<h3>nextIncomingFrame</h3>
<div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">nextIncomingFrame</span><wbr><span class="parameters">(<a href="Frame.html" title="class in org.eclipse.jetty.websocket.core">Frame</a>&nbsp;frame,
<a href="../../util/Callback.html" title="interface in org.eclipse.jetty.util">Callback</a>&nbsp;callback)</span></div>
</section>
</li>
<li>
<section class="detail" id="nextOutgoingFrame(org.eclipse.jetty.websocket.core.Frame,org.eclipse.jetty.util.Callback,boolean)">
<h3>nextOutgoingFrame</h3>
<div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">nextOutgoingFrame</span><wbr><span class="parameters">(<a href="Frame.html" title="class in org.eclipse.jetty.websocket.core">Frame</a>&nbsp;frame,
<a href="../../util/Callback.html" title="interface in org.eclipse.jetty.util">Callback</a>&nbsp;callback,
boolean&nbsp;batch)</span></div>
</section>
</li>
<li>
<section class="detail" id="setNextIncomingFrames(org.eclipse.jetty.websocket.core.IncomingFrames)">
<h3>setNextIncomingFrames</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setNextIncomingFrames</span><wbr><span class="parameters">(<a href="IncomingFrames.html" title="interface in org.eclipse.jetty.websocket.core">IncomingFrames</a>&nbsp;nextIncoming)</span></div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="Extension.html#setNextIncomingFrames(org.eclipse.jetty.websocket.core.IncomingFrames)">Extension</a></code></span></div>
<div class="block">Set the next <a href="IncomingFrames.html" title="interface in org.eclipse.jetty.websocket.core"><code>IncomingFrames</code></a> to call in the chain.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="Extension.html#setNextIncomingFrames(org.eclipse.jetty.websocket.core.IncomingFrames)">setNextIncomingFrames</a></code>&nbsp;in interface&nbsp;<code><a href="Extension.html" title="interface in org.eclipse.jetty.websocket.core">Extension</a></code></dd>
<dt>Parameters:</dt>
<dd><code>nextIncoming</code> - the next incoming extension</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setNextOutgoingFrames(org.eclipse.jetty.websocket.core.OutgoingFrames)">
<h3>setNextOutgoingFrames</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setNextOutgoingFrames</span><wbr><span class="parameters">(<a href="OutgoingFrames.html" title="interface in org.eclipse.jetty.websocket.core">OutgoingFrames</a>&nbsp;nextOutgoing)</span></div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="Extension.html#setNextOutgoingFrames(org.eclipse.jetty.websocket.core.OutgoingFrames)">Extension</a></code></span></div>
<div class="block">Set the next <a href="OutgoingFrames.html" title="interface in org.eclipse.jetty.websocket.core"><code>OutgoingFrames</code></a> to call in the chain.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="Extension.html#setNextOutgoingFrames(org.eclipse.jetty.websocket.core.OutgoingFrames)">setNextOutgoingFrames</a></code>&nbsp;in interface&nbsp;<code><a href="Extension.html" title="interface in org.eclipse.jetty.websocket.core">Extension</a></code></dd>
<dt>Parameters:</dt>
<dd><code>nextOutgoing</code> - the next outgoing extension</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setCoreSession(org.eclipse.jetty.websocket.core.CoreSession)">
<h3>setCoreSession</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setCoreSession</span><wbr><span class="parameters">(<a href="CoreSession.html" title="interface in org.eclipse.jetty.websocket.core">CoreSession</a>&nbsp;coreSession)</span></div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="Extension.html#setCoreSession(org.eclipse.jetty.websocket.core.CoreSession)">setCoreSession</a></code>&nbsp;in interface&nbsp;<code><a href="Extension.html" title="interface in org.eclipse.jetty.websocket.core">Extension</a></code></dd>
<dt>Parameters:</dt>
<dd><code>coreSession</code> - the <a href="CoreSession.html" title="interface in org.eclipse.jetty.websocket.core"><code>CoreSession</code></a> for this Extension.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getCoreSession()">
<h3>getCoreSession</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="CoreSession.html" title="interface in org.eclipse.jetty.websocket.core">CoreSession</a></span>&nbsp;<span class="element-name">getCoreSession</span>()</div>
</section>
</li>
<li>
<section class="detail" id="getConfiguration()">
<h3>getConfiguration</h3>
<div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type"><a href="Configuration.html" title="interface in org.eclipse.jetty.websocket.core">Configuration</a></span>&nbsp;<span class="element-name">getConfiguration</span>()</div>
</section>
</li>
<li>
<section class="detail" id="toString()">
<h3>toString</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<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>&nbsp;<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>&nbsp;in class&nbsp;<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 &#169; 1995&#x2013;2022 <a href="https://webtide.com">Webtide</a>. All rights reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>