Google Git
Sign in
eclipse / www.eclipse.org / jetty / 244b31480d88c4c2e783a862c86c320807c66eb3 / . / javadoc / 9.4.28.v20200408 / org / eclipse / jetty / websocket / common / extensions / AbstractExtension.html
blob: ae539a2fab5c719b6dac1be8af8d040494f71379 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.6) on Fri Apr 10 16:48:14 EDT 2020 -->
<title>AbstractExtension (Jetty :: Project 9.4.28.v20200408 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2020-04-10">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../../../jquery/jquery-3.3.1.js"></script>
<script type="text/javascript" src="../../../../../../jquery/jquery-migrate-3.0.1.js"></script>
<script type="text/javascript" src="../../../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="AbstractExtension (Jetty :: Project 9.4.28.v20200408 API)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":42,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../../../";
var useModuleDirectories = false;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">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">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<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>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.eclipse.jetty.websocket.common.extensions</a></div>
<h2 title="Class AbstractExtension" class="title">Class AbstractExtension</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../util/component/AbstractLifeCycle.html" title="class in org.eclipse.jetty.util.component">org.eclipse.jetty.util.component.AbstractLifeCycle</a></li>
<li>
<ul class="inheritance">
<li>org.eclipse.jetty.websocket.common.extensions.AbstractExtension</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="../../../util/component/LifeCycle.html" title="interface in org.eclipse.jetty.util.component">LifeCycle</a></code>, <code><a href="../../api/extensions/Extension.html" title="interface in org.eclipse.jetty.websocket.api.extensions">Extension</a></code>, <code><a href="../../api/extensions/IncomingFrames.html" title="interface in org.eclipse.jetty.websocket.api.extensions">IncomingFrames</a></code>, <code><a href="../../api/extensions/OutgoingFrames.html" title="interface in org.eclipse.jetty.websocket.api.extensions">OutgoingFrames</a></code></dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><code><a href="compress/CompressExtension.html" title="class in org.eclipse.jetty.websocket.common.extensions.compress">CompressExtension</a></code>, <code><a href="fragment/FragmentExtension.html" title="class in org.eclipse.jetty.websocket.common.extensions.fragment">FragmentExtension</a></code>, <code><a href="FrameCaptureExtension.html" title="class in org.eclipse.jetty.websocket.common.extensions">FrameCaptureExtension</a></code>, <code><a href="identity/IdentityExtension.html" title="class in org.eclipse.jetty.websocket.common.extensions.identity">IdentityExtension</a></code></dd>
</dl>
<hr>
<pre><a href="../../../util/annotation/ManagedObject.html" title="annotation in org.eclipse.jetty.util.annotation">@ManagedObject</a>("Abstract Extension")
public abstract class <span class="typeNameLabel">AbstractExtension</span>
extends <a href="../../../util/component/AbstractLifeCycle.html" title="class in org.eclipse.jetty.util.component">AbstractLifeCycle</a>
implements <a href="../../api/extensions/Extension.html" title="interface in org.eclipse.jetty.websocket.api.extensions">Extension</a></pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<ul class="blockList">
<li class="blockList"><a id="nested.classes.inherited.from.class.org.eclipse.jetty.util.component.AbstractLifeCycle">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from class&nbsp;org.eclipse.jetty.util.component.<a href="../../../util/component/AbstractLifeCycle.html" title="class in org.eclipse.jetty.util.component">AbstractLifeCycle</a></h3>
<code><a href="../../../util/component/AbstractLifeCycle.AbstractLifeCycleListener.html" title="class in org.eclipse.jetty.util.component">AbstractLifeCycle.AbstractLifeCycleListener</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="nested.classes.inherited.from.class.org.eclipse.jetty.util.component.LifeCycle">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface&nbsp;org.eclipse.jetty.util.component.<a href="../../../util/component/LifeCycle.html" title="interface in org.eclipse.jetty.util.component">LifeCycle</a></h3>
<code><a href="../../../util/component/LifeCycle.Listener.html" title="interface in org.eclipse.jetty.util.component">LifeCycle.Listener</a></code></li>
</ul>
</li>
</ul>
</section>
<!-- =========== FIELD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a id="fields.inherited.from.class.org.eclipse.jetty.util.component.AbstractLifeCycle">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.eclipse.jetty.util.component.<a href="../../../util/component/AbstractLifeCycle.html" title="class in org.eclipse.jetty.util.component">AbstractLifeCycle</a></h3>
<code><a href="../../../util/component/AbstractLifeCycle.html#FAILED">FAILED</a>, <a href="../../../util/component/AbstractLifeCycle.html#RUNNING">RUNNING</a>, <a href="../../../util/component/AbstractLifeCycle.html#STARTED">STARTED</a>, <a href="../../../util/component/AbstractLifeCycle.html#STARTING">STARTING</a>, <a href="../../../util/component/AbstractLifeCycle.html#STOPPED">STOPPED</a>, <a href="../../../util/component/AbstractLifeCycle.html#STOPPING">STOPPING</a></code></li>
</ul>
</li>
</ul>
</section>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">AbstractExtension</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../../../io/ByteBufferPool.html" title="interface in org.eclipse.jetty.io">ByteBufferPool</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getBufferPool()">getBufferPool</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../api/extensions/ExtensionConfig.html" title="class in org.eclipse.jetty.websocket.api.extensions">ExtensionConfig</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getConfig()">getConfig</a></span>()</code></th>
<td class="colLast">
<div class="block">The active configuration for this extension.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../LogicalConnection.html" title="interface in org.eclipse.jetty.websocket.common">LogicalConnection</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getConnection()">getConnection</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getName()">getName</a></span>()</code></th>
<td class="colLast">
<div class="block">The <code>Sec-WebSocket-Extensions</code> name for this extension.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../api/extensions/IncomingFrames.html" title="interface in org.eclipse.jetty.websocket.api.extensions">IncomingFrames</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getNextIncoming()">getNextIncoming</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../../api/extensions/OutgoingFrames.html" title="interface in org.eclipse.jetty.websocket.api.extensions">OutgoingFrames</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getNextOutgoing()">getNextOutgoing</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../../api/WebSocketPolicy.html" title="class in org.eclipse.jetty.websocket.api">WebSocketPolicy</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPolicy()">getPolicy</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#init(org.eclipse.jetty.websocket.api.WebSocketPolicy,org.eclipse.jetty.io.ByteBufferPool)">init</a></span>&#8203;(<a href="../../api/WebSocketPolicy.html" title="class in org.eclipse.jetty.websocket.api">WebSocketPolicy</a>&nbsp;policy,
<a href="../../../io/ByteBufferPool.html" title="interface in org.eclipse.jetty.io">ByteBufferPool</a>&nbsp;bufferPool)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#init(org.eclipse.jetty.websocket.common.scopes.WebSocketContainerScope)">init</a></span>&#8203;(<a href="../scopes/WebSocketContainerScope.html" title="interface in org.eclipse.jetty.websocket.common.scopes">WebSocketContainerScope</a>&nbsp;container)</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isRsv1User()">isRsv1User</a></span>()</code></th>
<td class="colLast">
<div class="block">Used to indicate that the extension makes use of the RSV1 bit of the base websocket framing.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isRsv2User()">isRsv2User</a></span>()</code></th>
<td class="colLast">
<div class="block">Used to indicate that the extension makes use of the RSV2 bit of the base websocket framing.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isRsv3User()">isRsv3User</a></span>()</code></th>
<td class="colLast">
<div class="block">Used to indicate that the extension makes use of the RSV3 bit of the base websocket framing.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#nextIncomingFrame(org.eclipse.jetty.websocket.api.extensions.Frame)">nextIncomingFrame</a></span>&#8203;(<a href="../../api/extensions/Frame.html" title="interface in org.eclipse.jetty.websocket.api.extensions">Frame</a>&nbsp;frame)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#nextOutgoingFrame(org.eclipse.jetty.websocket.api.extensions.Frame,org.eclipse.jetty.websocket.api.WriteCallback,org.eclipse.jetty.websocket.api.BatchMode)">nextOutgoingFrame</a></span>&#8203;(<a href="../../api/extensions/Frame.html" title="interface in org.eclipse.jetty.websocket.api.extensions">Frame</a>&nbsp;frame,
<a href="../../api/WriteCallback.html" title="interface in org.eclipse.jetty.websocket.api">WriteCallback</a>&nbsp;callback,
<a href="../../api/BatchMode.html" title="enum in org.eclipse.jetty.websocket.api">BatchMode</a>&nbsp;batchMode)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setBufferPool(org.eclipse.jetty.io.ByteBufferPool)">setBufferPool</a></span>&#8203;(<a href="../../../io/ByteBufferPool.html" title="interface in org.eclipse.jetty.io">ByteBufferPool</a>&nbsp;bufferPool)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setConfig(org.eclipse.jetty.websocket.api.extensions.ExtensionConfig)">setConfig</a></span>&#8203;(<a href="../../api/extensions/ExtensionConfig.html" title="class in org.eclipse.jetty.websocket.api.extensions">ExtensionConfig</a>&nbsp;config)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setConnection(org.eclipse.jetty.websocket.common.LogicalConnection)">setConnection</a></span>&#8203;(<a href="../LogicalConnection.html" title="interface in org.eclipse.jetty.websocket.common">LogicalConnection</a>&nbsp;connection)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setNextIncomingFrames(org.eclipse.jetty.websocket.api.extensions.IncomingFrames)">setNextIncomingFrames</a></span>&#8203;(<a href="../../api/extensions/IncomingFrames.html" title="interface in org.eclipse.jetty.websocket.api.extensions">IncomingFrames</a>&nbsp;nextIncoming)</code></th>
<td class="colLast">
<div class="block">Set the next <a href="../../api/extensions/IncomingFrames.html" title="interface in org.eclipse.jetty.websocket.api.extensions"><code>IncomingFrames</code></a> to call in the chain.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setNextOutgoingFrames(org.eclipse.jetty.websocket.api.extensions.OutgoingFrames)">setNextOutgoingFrames</a></span>&#8203;(<a href="../../api/extensions/OutgoingFrames.html" title="interface in org.eclipse.jetty.websocket.api.extensions">OutgoingFrames</a>&nbsp;nextOutgoing)</code></th>
<td class="colLast">
<div class="block">Set the next <a href="../../api/extensions/OutgoingFrames.html" title="interface in org.eclipse.jetty.websocket.api.extensions"><code>OutgoingFrames</code></a> to call in the chain.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setPolicy(org.eclipse.jetty.websocket.api.WebSocketPolicy)">setPolicy</a></span>&#8203;(<a href="../../api/WebSocketPolicy.html" title="class in org.eclipse.jetty.websocket.api">WebSocketPolicy</a>&nbsp;policy)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toString()">toString</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.eclipse.jetty.util.component.AbstractLifeCycle">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.eclipse.jetty.util.component.<a href="../../../util/component/AbstractLifeCycle.html" title="class in org.eclipse.jetty.util.component">AbstractLifeCycle</a></h3>
<code><a href="../../../util/component/AbstractLifeCycle.html#addLifeCycleListener(org.eclipse.jetty.util.component.LifeCycle.Listener)">addLifeCycleListener</a>, <a href="../../../util/component/AbstractLifeCycle.html#doStart()">doStart</a>, <a href="../../../util/component/AbstractLifeCycle.html#doStop()">doStop</a>, <a href="../../../util/component/AbstractLifeCycle.html#getState()">getState</a>, <a href="../../../util/component/AbstractLifeCycle.html#getState(org.eclipse.jetty.util.component.LifeCycle)">getState</a>, <a href="../../../util/component/AbstractLifeCycle.html#getStopTimeout()">getStopTimeout</a>, <a href="../../../util/component/AbstractLifeCycle.html#isFailed()">isFailed</a>, <a href="../../../util/component/AbstractLifeCycle.html#isRunning()">isRunning</a>, <a href="../../../util/component/AbstractLifeCycle.html#isStarted()">isStarted</a>, <a href="../../../util/component/AbstractLifeCycle.html#isStarting()">isStarting</a>, <a href="../../../util/component/AbstractLifeCycle.html#isStopped()">isStopped</a>, <a href="../../../util/component/AbstractLifeCycle.html#isStopping()">isStopping</a>, <a href="../../../util/component/AbstractLifeCycle.html#removeLifeCycleListener(org.eclipse.jetty.util.component.LifeCycle.Listener)">removeLifeCycleListener</a>, <a href="../../../util/component/AbstractLifeCycle.html#setStopTimeout(long)">setStopTimeout</a>, <a href="../../../util/component/AbstractLifeCycle.html#start()">start</a>, <a href="../../../util/component/AbstractLifeCycle.html#stop()">stop</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.eclipse.jetty.websocket.api.extensions.IncomingFrames">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.eclipse.jetty.websocket.api.extensions.<a href="../../api/extensions/IncomingFrames.html" title="interface in org.eclipse.jetty.websocket.api.extensions">IncomingFrames</a></h3>
<code><a href="../../api/extensions/IncomingFrames.html#incomingFrame(org.eclipse.jetty.websocket.api.extensions.Frame)">incomingFrame</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.eclipse.jetty.websocket.api.extensions.OutgoingFrames">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.eclipse.jetty.websocket.api.extensions.<a href="../../api/extensions/OutgoingFrames.html" title="interface in org.eclipse.jetty.websocket.api.extensions">OutgoingFrames</a></h3>
<code><a href="../../api/extensions/OutgoingFrames.html#outgoingFrame(org.eclipse.jetty.websocket.api.extensions.Frame,org.eclipse.jetty.websocket.api.WriteCallback,org.eclipse.jetty.websocket.api.BatchMode)">outgoingFrame</a></code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>AbstractExtension</h4>
<pre>public&nbsp;AbstractExtension()</pre>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="init(org.eclipse.jetty.websocket.common.scopes.WebSocketContainerScope)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>init</h4>
<pre class="methodSignature">@Deprecated
public&nbsp;void&nbsp;init&#8203;(<a href="../scopes/WebSocketContainerScope.html" title="interface in org.eclipse.jetty.websocket.common.scopes">WebSocketContainerScope</a>&nbsp;container)</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div>
</li>
</ul>
<a id="init(org.eclipse.jetty.websocket.api.WebSocketPolicy,org.eclipse.jetty.io.ByteBufferPool)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>init</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;init&#8203;(<a href="../../api/WebSocketPolicy.html" title="class in org.eclipse.jetty.websocket.api">WebSocketPolicy</a>&nbsp;policy,
<a href="../../../io/ByteBufferPool.html" title="interface in org.eclipse.jetty.io">ByteBufferPool</a>&nbsp;bufferPool)</pre>
</li>
</ul>
<a id="getBufferPool()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBufferPool</h4>
<pre class="methodSignature">public&nbsp;<a href="../../../io/ByteBufferPool.html" title="interface in org.eclipse.jetty.io">ByteBufferPool</a>&nbsp;getBufferPool()</pre>
</li>
</ul>
<a id="getConfig()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConfig</h4>
<pre class="methodSignature">public&nbsp;<a href="../../api/extensions/ExtensionConfig.html" title="class in org.eclipse.jetty.websocket.api.extensions">ExtensionConfig</a>&nbsp;getConfig()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../api/extensions/Extension.html#getConfig()">Extension</a></code></span></div>
<div class="block">The active configuration for this extension.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../api/extensions/Extension.html#getConfig()">getConfig</a></code>&nbsp;in interface&nbsp;<code><a href="../../api/extensions/Extension.html" title="interface in org.eclipse.jetty.websocket.api.extensions">Extension</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the configuration for this extension. never null.</dd>
</dl>
</li>
</ul>
<a id="getConnection()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConnection</h4>
<pre class="methodSignature">public&nbsp;<a href="../LogicalConnection.html" title="interface in org.eclipse.jetty.websocket.common">LogicalConnection</a>&nbsp;getConnection()</pre>
</li>
</ul>
<a id="getName()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getName</h4>
<pre class="methodSignature">public&nbsp;java.lang.String&nbsp;getName()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../api/extensions/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>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../api/extensions/Extension.html#getName()">getName</a></code>&nbsp;in interface&nbsp;<code><a href="../../api/extensions/Extension.html" title="interface in org.eclipse.jetty.websocket.api.extensions">Extension</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the name of the extension</dd>
</dl>
</li>
</ul>
<a id="getNextIncoming()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNextIncoming</h4>
<pre class="methodSignature"><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)
public&nbsp;<a href="../../api/extensions/IncomingFrames.html" title="interface in org.eclipse.jetty.websocket.api.extensions">IncomingFrames</a>&nbsp;getNextIncoming()</pre>
</li>
</ul>
<a id="getNextOutgoing()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNextOutgoing</h4>
<pre class="methodSignature"><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)
public&nbsp;<a href="../../api/extensions/OutgoingFrames.html" title="interface in org.eclipse.jetty.websocket.api.extensions">OutgoingFrames</a>&nbsp;getNextOutgoing()</pre>
</li>
</ul>
<a id="getPolicy()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPolicy</h4>
<pre class="methodSignature">public&nbsp;<a href="../../api/WebSocketPolicy.html" title="class in org.eclipse.jetty.websocket.api">WebSocketPolicy</a>&nbsp;getPolicy()</pre>
</li>
</ul>
<a id="isRsv1User()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isRsv1User</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isRsv1User()</pre>
<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>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../api/extensions/Extension.html#isRsv1User()">isRsv1User</a></code>&nbsp;in interface&nbsp;<code><a href="../../api/extensions/Extension.html" title="interface in org.eclipse.jetty.websocket.api.extensions">Extension</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if extension uses RSV1 for its own purposes.</dd>
</dl>
</li>
</ul>
<a id="isRsv2User()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isRsv2User</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isRsv2User()</pre>
<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>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../api/extensions/Extension.html#isRsv2User()">isRsv2User</a></code>&nbsp;in interface&nbsp;<code><a href="../../api/extensions/Extension.html" title="interface in org.eclipse.jetty.websocket.api.extensions">Extension</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if extension uses RSV2 for its own purposes.</dd>
</dl>
</li>
</ul>
<a id="isRsv3User()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isRsv3User</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isRsv3User()</pre>
<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>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../api/extensions/Extension.html#isRsv3User()">isRsv3User</a></code>&nbsp;in interface&nbsp;<code><a href="../../api/extensions/Extension.html" title="interface in org.eclipse.jetty.websocket.api.extensions">Extension</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if extension uses RSV3 for its own purposes.</dd>
</dl>
</li>
</ul>
<a id="nextIncomingFrame(org.eclipse.jetty.websocket.api.extensions.Frame)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>nextIncomingFrame</h4>
<pre class="methodSignature">protected&nbsp;void&nbsp;nextIncomingFrame&#8203;(<a href="../../api/extensions/Frame.html" title="interface in org.eclipse.jetty.websocket.api.extensions">Frame</a>&nbsp;frame)</pre>
</li>
</ul>
<a id="nextOutgoingFrame(org.eclipse.jetty.websocket.api.extensions.Frame,org.eclipse.jetty.websocket.api.WriteCallback,org.eclipse.jetty.websocket.api.BatchMode)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>nextOutgoingFrame</h4>
<pre class="methodSignature">protected&nbsp;void&nbsp;nextOutgoingFrame&#8203;(<a href="../../api/extensions/Frame.html" title="interface in org.eclipse.jetty.websocket.api.extensions">Frame</a>&nbsp;frame,
<a href="../../api/WriteCallback.html" title="interface in org.eclipse.jetty.websocket.api">WriteCallback</a>&nbsp;callback,
<a href="../../api/BatchMode.html" title="enum in org.eclipse.jetty.websocket.api">BatchMode</a>&nbsp;batchMode)</pre>
</li>
</ul>
<a id="setBufferPool(org.eclipse.jetty.io.ByteBufferPool)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setBufferPool</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setBufferPool&#8203;(<a href="../../../io/ByteBufferPool.html" title="interface in org.eclipse.jetty.io">ByteBufferPool</a>&nbsp;bufferPool)</pre>
</li>
</ul>
<a id="setConfig(org.eclipse.jetty.websocket.api.extensions.ExtensionConfig)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setConfig</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setConfig&#8203;(<a href="../../api/extensions/ExtensionConfig.html" title="class in org.eclipse.jetty.websocket.api.extensions">ExtensionConfig</a>&nbsp;config)</pre>
</li>
</ul>
<a id="setConnection(org.eclipse.jetty.websocket.common.LogicalConnection)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setConnection</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setConnection&#8203;(<a href="../LogicalConnection.html" title="interface in org.eclipse.jetty.websocket.common">LogicalConnection</a>&nbsp;connection)</pre>
</li>
</ul>
<a id="setNextIncomingFrames(org.eclipse.jetty.websocket.api.extensions.IncomingFrames)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setNextIncomingFrames</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setNextIncomingFrames&#8203;(<a href="../../api/extensions/IncomingFrames.html" title="interface in org.eclipse.jetty.websocket.api.extensions">IncomingFrames</a>&nbsp;nextIncoming)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../api/extensions/Extension.html#setNextIncomingFrames(org.eclipse.jetty.websocket.api.extensions.IncomingFrames)">Extension</a></code></span></div>
<div class="block">Set the next <a href="../../api/extensions/IncomingFrames.html" title="interface in org.eclipse.jetty.websocket.api.extensions"><code>IncomingFrames</code></a> to call in the chain.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../api/extensions/Extension.html#setNextIncomingFrames(org.eclipse.jetty.websocket.api.extensions.IncomingFrames)">setNextIncomingFrames</a></code>&nbsp;in interface&nbsp;<code><a href="../../api/extensions/Extension.html" title="interface in org.eclipse.jetty.websocket.api.extensions">Extension</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>nextIncoming</code> - the next incoming extension</dd>
</dl>
</li>
</ul>
<a id="setNextOutgoingFrames(org.eclipse.jetty.websocket.api.extensions.OutgoingFrames)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setNextOutgoingFrames</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setNextOutgoingFrames&#8203;(<a href="../../api/extensions/OutgoingFrames.html" title="interface in org.eclipse.jetty.websocket.api.extensions">OutgoingFrames</a>&nbsp;nextOutgoing)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../api/extensions/Extension.html#setNextOutgoingFrames(org.eclipse.jetty.websocket.api.extensions.OutgoingFrames)">Extension</a></code></span></div>
<div class="block">Set the next <a href="../../api/extensions/OutgoingFrames.html" title="interface in org.eclipse.jetty.websocket.api.extensions"><code>OutgoingFrames</code></a> to call in the chain.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../api/extensions/Extension.html#setNextOutgoingFrames(org.eclipse.jetty.websocket.api.extensions.OutgoingFrames)">setNextOutgoingFrames</a></code>&nbsp;in interface&nbsp;<code><a href="../../api/extensions/Extension.html" title="interface in org.eclipse.jetty.websocket.api.extensions">Extension</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>nextOutgoing</code> - the next outgoing extension</dd>
</dl>
</li>
</ul>
<a id="setPolicy(org.eclipse.jetty.websocket.api.WebSocketPolicy)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPolicy</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setPolicy&#8203;(<a href="../../api/WebSocketPolicy.html" title="class in org.eclipse.jetty.websocket.api">WebSocketPolicy</a>&nbsp;policy)</pre>
</li>
</ul>
<a id="toString()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre class="methodSignature">public&nbsp;java.lang.String&nbsp;toString()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../util/component/AbstractLifeCycle.html#toString()">toString</a></code>&nbsp;in class&nbsp;<code><a href="../../../util/component/AbstractLifeCycle.html" title="class in org.eclipse.jetty.util.component">AbstractLifeCycle</a></code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">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">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<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>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 1995&#x2013;2020 <a href="https://webtide.com">Webtide</a>. All rights reserved.</small></p>
</footer>
</body>
</html>