Google Git
Sign in
eclipse / www.eclipse.org / jetty / caa63cef1178e162a958a0ce982848d67ac0e16a / . / javadoc / jetty-9 / org / eclipse / jetty / websocket / common / extensions / compress / CompressExtension.html
blob: 5e2767f469c5c2d4f8ea7a9aeac89f94c96b21b7 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.10) on Fri Feb 26 09:50:23 CST 2021 -->
<title>CompressExtension (Jetty :: Project 9.4.38.v20210224 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2021-02-26">
<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.5.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="CompressExtension (Jetty :: Project 9.4.38.v20210224 API)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":9,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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/CompressExtension.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><a href="#field.detail">Field</a>&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.compress</a></div>
<h2 title="Class CompressExtension" class="title">Class CompressExtension</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><a href="../AbstractExtension.html" title="class in org.eclipse.jetty.websocket.common.extensions">org.eclipse.jetty.websocket.common.extensions.AbstractExtension</a></li>
<li>
<ul class="inheritance">
<li>org.eclipse.jetty.websocket.common.extensions.compress.CompressExtension</li>
</ul>
</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="DeflateFrameExtension.html" title="class in org.eclipse.jetty.websocket.common.extensions.compress">DeflateFrameExtension</a></code>, <code><a href="PerMessageDeflateExtension.html" title="class in org.eclipse.jetty.websocket.common.extensions.compress">PerMessageDeflateExtension</a></code></dd>
</dl>
<hr>
<pre>public abstract class <span class="typeNameLabel">CompressExtension</span>
extends <a href="../AbstractExtension.html" title="class in org.eclipse.jetty.websocket.common.extensions">AbstractExtension</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>
<table class="memberSummary">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Field</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected java.util.concurrent.atomic.AtomicInteger</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#decompressCount">decompressCount</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#INFLATE_BUFFER_SIZE">INFLATE_BUFFER_SIZE</a></span></code></th>
<td class="colLast">
<div class="block">Inflater / Decompressed Buffer Size</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#INPUT_MAX_BUFFER_SIZE">INPUT_MAX_BUFFER_SIZE</a></span></code></th>
<td class="colLast">
<div class="block">Deflater / Inflater: Maximum Input Buffer Size</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#RSV_USE_ALWAYS">RSV_USE_ALWAYS</a></span></code></th>
<td class="colLast">
<div class="block">Always set RSV flag, on all frame types</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#RSV_USE_ONLY_FIRST">RSV_USE_ONLY_FIRST</a></span></code></th>
<td class="colLast">
<div class="block">Only set RSV flag on first frame in multi-frame messages.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected static byte[]</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#TAIL_BYTES">TAIL_BYTES</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected static java.nio.ByteBuffer</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#TAIL_BYTES_BUF">TAIL_BYTES_BUF</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#TAIL_DROP_ALWAYS">TAIL_DROP_ALWAYS</a></span></code></th>
<td class="colLast">
<div class="block">Always drop tail bytes 0000FFFF, from all frame types</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#TAIL_DROP_FIN_ONLY">TAIL_DROP_FIN_ONLY</a></span></code></th>
<td class="colLast">
<div class="block">Only drop tail bytes 0000FFFF, from fin==true frames</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#TAIL_DROP_NEVER">TAIL_DROP_NEVER</a></span></code></th>
<td class="colLast">
<div class="block">Never drop tail bytes 0000FFFF, from any frame type</div>
</td>
</tr>
</table>
<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">Modifier</th>
<th class="colSecond" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected </code></td>
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">CompressExtension</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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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></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>protected void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#decompress(org.eclipse.jetty.websocket.common.extensions.compress.ByteAccumulator,java.nio.ByteBuffer)">decompress</a></span>&#8203;(<a href="ByteAccumulator.html" title="class in org.eclipse.jetty.websocket.common.extensions.compress">ByteAccumulator</a>&nbsp;accumulator,
java.nio.ByteBuffer&nbsp;buf)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#doStop()">doStop</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#endsWithTail(java.nio.ByteBuffer)">endsWithTail</a></span>&#8203;(java.nio.ByteBuffer&nbsp;buf)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#forwardIncoming(org.eclipse.jetty.websocket.api.extensions.Frame,org.eclipse.jetty.websocket.common.extensions.compress.ByteAccumulator)">forwardIncoming</a></span>&#8203;(<a href="../../../api/extensions/Frame.html" title="interface in org.eclipse.jetty.websocket.api.extensions">Frame</a>&nbsp;frame,
<a href="ByteAccumulator.html" title="class in org.eclipse.jetty.websocket.common.extensions.compress">ByteAccumulator</a>&nbsp;accumulator)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>java.util.zip.Deflater</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDeflater()">getDeflater</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>java.util.zip.Inflater</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getInflater()">getInflater</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<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">Indicates use of RSV1 flag for indicating deflation is in use.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>protected <a href="ByteAccumulator.html" title="class in org.eclipse.jetty.websocket.common.extensions.compress">ByteAccumulator</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#newByteAccumulator()">newByteAccumulator</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#notifyCallbackFailure(org.eclipse.jetty.websocket.api.WriteCallback,java.lang.Throwable)">notifyCallbackFailure</a></span>&#8203;(<a href="../../../api/WriteCallback.html" title="interface in org.eclipse.jetty.websocket.api">WriteCallback</a>&nbsp;callback,
java.lang.Throwable&nbsp;failure)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#notifyCallbackSuccess(org.eclipse.jetty.websocket.api.WriteCallback)">notifyCallbackSuccess</a></span>&#8203;(<a href="../../../api/WriteCallback.html" title="interface in org.eclipse.jetty.websocket.api">WriteCallback</a>&nbsp;callback)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#outgoingFrame(org.eclipse.jetty.websocket.api.extensions.Frame,org.eclipse.jetty.websocket.api.WriteCallback,org.eclipse.jetty.websocket.api.BatchMode)">outgoingFrame</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">
<div class="block">A frame, and optional callback, intended for the network layer.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setDeflaterPool(org.eclipse.jetty.util.compression.DeflaterPool)">setDeflaterPool</a></span>&#8203;(<a href="../../../../util/compression/DeflaterPool.html" title="class in org.eclipse.jetty.util.compression">DeflaterPool</a>&nbsp;deflaterPool)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setInflaterPool(org.eclipse.jetty.util.compression.InflaterPool)">setInflaterPool</a></span>&#8203;(<a href="../../../../util/compression/InflaterPool.html" title="class in org.eclipse.jetty.util.compression">InflaterPool</a>&nbsp;inflaterPool)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i13" class="rowColor">
<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.websocket.common.extensions.AbstractExtension">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.eclipse.jetty.websocket.common.extensions.<a href="../AbstractExtension.html" title="class in org.eclipse.jetty.websocket.common.extensions">AbstractExtension</a></h3>
<code><a href="../AbstractExtension.html#getBufferPool()">getBufferPool</a>, <a href="../AbstractExtension.html#getConfig()">getConfig</a>, <a href="../AbstractExtension.html#getConnection()">getConnection</a>, <a href="../AbstractExtension.html#getName()">getName</a>, <a href="../AbstractExtension.html#getNextIncoming()">getNextIncoming</a>, <a href="../AbstractExtension.html#getNextOutgoing()">getNextOutgoing</a>, <a href="../AbstractExtension.html#getPolicy()">getPolicy</a>, <a href="../AbstractExtension.html#init(org.eclipse.jetty.websocket.api.WebSocketPolicy,org.eclipse.jetty.io.ByteBufferPool)">init</a>, <a href="../AbstractExtension.html#init(org.eclipse.jetty.websocket.common.scopes.WebSocketContainerScope)">init</a>, <a href="../AbstractExtension.html#isRsv2User()">isRsv2User</a>, <a href="../AbstractExtension.html#isRsv3User()">isRsv3User</a>, <a href="../AbstractExtension.html#nextIncomingFrame(org.eclipse.jetty.websocket.api.extensions.Frame)">nextIncomingFrame</a>, <a href="../AbstractExtension.html#nextOutgoingFrame(org.eclipse.jetty.websocket.api.extensions.Frame,org.eclipse.jetty.websocket.api.WriteCallback,org.eclipse.jetty.websocket.api.BatchMode)">nextOutgoingFrame</a>, <a href="../AbstractExtension.html#setBufferPool(org.eclipse.jetty.io.ByteBufferPool)">setBufferPool</a>, <a href="../AbstractExtension.html#setConfig(org.eclipse.jetty.websocket.api.extensions.ExtensionConfig)">setConfig</a>, <a href="../AbstractExtension.html#setConnection(org.eclipse.jetty.websocket.common.LogicalConnection)">setConnection</a>, <a href="../AbstractExtension.html#setNextIncomingFrames(org.eclipse.jetty.websocket.api.extensions.IncomingFrames)">setNextIncomingFrames</a>, <a href="../AbstractExtension.html#setNextOutgoingFrames(org.eclipse.jetty.websocket.api.extensions.OutgoingFrames)">setNextOutgoingFrames</a>, <a href="../AbstractExtension.html#setPolicy(org.eclipse.jetty.websocket.api.WebSocketPolicy)">setPolicy</a></code></li>
</ul>
<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#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>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a id="TAIL_BYTES">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TAIL_BYTES</h4>
<pre>protected static final&nbsp;byte[] TAIL_BYTES</pre>
</li>
</ul>
<a id="TAIL_BYTES_BUF">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TAIL_BYTES_BUF</h4>
<pre>protected static final&nbsp;java.nio.ByteBuffer TAIL_BYTES_BUF</pre>
</li>
</ul>
<a id="TAIL_DROP_NEVER">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TAIL_DROP_NEVER</h4>
<pre>protected static final&nbsp;int TAIL_DROP_NEVER</pre>
<div class="block">Never drop tail bytes 0000FFFF, from any frame type</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../../constant-values.html#org.eclipse.jetty.websocket.common.extensions.compress.CompressExtension.TAIL_DROP_NEVER">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="TAIL_DROP_ALWAYS">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TAIL_DROP_ALWAYS</h4>
<pre>protected static final&nbsp;int TAIL_DROP_ALWAYS</pre>
<div class="block">Always drop tail bytes 0000FFFF, from all frame types</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../../constant-values.html#org.eclipse.jetty.websocket.common.extensions.compress.CompressExtension.TAIL_DROP_ALWAYS">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="TAIL_DROP_FIN_ONLY">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TAIL_DROP_FIN_ONLY</h4>
<pre>protected static final&nbsp;int TAIL_DROP_FIN_ONLY</pre>
<div class="block">Only drop tail bytes 0000FFFF, from fin==true frames</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../../constant-values.html#org.eclipse.jetty.websocket.common.extensions.compress.CompressExtension.TAIL_DROP_FIN_ONLY">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="RSV_USE_ALWAYS">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>RSV_USE_ALWAYS</h4>
<pre>protected static final&nbsp;int RSV_USE_ALWAYS</pre>
<div class="block">Always set RSV flag, on all frame types</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../../constant-values.html#org.eclipse.jetty.websocket.common.extensions.compress.CompressExtension.RSV_USE_ALWAYS">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="RSV_USE_ONLY_FIRST">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>RSV_USE_ONLY_FIRST</h4>
<pre>protected static final&nbsp;int RSV_USE_ONLY_FIRST</pre>
<div class="block">Only set RSV flag on first frame in multi-frame messages.
<p>
Note: this automatically means no-continuation frames have the RSV bit set</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../../constant-values.html#org.eclipse.jetty.websocket.common.extensions.compress.CompressExtension.RSV_USE_ONLY_FIRST">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="INFLATE_BUFFER_SIZE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>INFLATE_BUFFER_SIZE</h4>
<pre>protected static final&nbsp;int INFLATE_BUFFER_SIZE</pre>
<div class="block">Inflater / Decompressed Buffer Size</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../../constant-values.html#org.eclipse.jetty.websocket.common.extensions.compress.CompressExtension.INFLATE_BUFFER_SIZE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="INPUT_MAX_BUFFER_SIZE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>INPUT_MAX_BUFFER_SIZE</h4>
<pre>protected static final&nbsp;int INPUT_MAX_BUFFER_SIZE</pre>
<div class="block">Deflater / Inflater: Maximum Input Buffer Size</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../../constant-values.html#org.eclipse.jetty.websocket.common.extensions.compress.CompressExtension.INPUT_MAX_BUFFER_SIZE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="decompressCount">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>decompressCount</h4>
<pre>protected&nbsp;java.util.concurrent.atomic.AtomicInteger decompressCount</pre>
</li>
</ul>
</li>
</ul>
</section>
<!-- ========= 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>CompressExtension</h4>
<pre>protected&nbsp;CompressExtension()</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="setInflaterPool(org.eclipse.jetty.util.compression.InflaterPool)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setInflaterPool</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setInflaterPool&#8203;(<a href="../../../../util/compression/InflaterPool.html" title="class in org.eclipse.jetty.util.compression">InflaterPool</a>&nbsp;inflaterPool)</pre>
</li>
</ul>
<a id="setDeflaterPool(org.eclipse.jetty.util.compression.DeflaterPool)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDeflaterPool</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setDeflaterPool&#8203;(<a href="../../../../util/compression/DeflaterPool.html" title="class in org.eclipse.jetty.util.compression">DeflaterPool</a>&nbsp;deflaterPool)</pre>
</li>
</ul>
<a id="getDeflater()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDeflater</h4>
<pre class="methodSignature">public&nbsp;java.util.zip.Deflater&nbsp;getDeflater()</pre>
</li>
</ul>
<a id="getInflater()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInflater</h4>
<pre class="methodSignature">public&nbsp;java.util.zip.Inflater&nbsp;getInflater()</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">Indicates use of RSV1 flag for indicating deflation is in use.</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="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../AbstractExtension.html#isRsv1User()">isRsv1User</a></code>&nbsp;in class&nbsp;<code><a href="../AbstractExtension.html" title="class in org.eclipse.jetty.websocket.common.extensions">AbstractExtension</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="forwardIncoming(org.eclipse.jetty.websocket.api.extensions.Frame,org.eclipse.jetty.websocket.common.extensions.compress.ByteAccumulator)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>forwardIncoming</h4>
<pre class="methodSignature">protected&nbsp;void&nbsp;forwardIncoming&#8203;(<a href="../../../api/extensions/Frame.html" title="interface in org.eclipse.jetty.websocket.api.extensions">Frame</a>&nbsp;frame,
<a href="ByteAccumulator.html" title="class in org.eclipse.jetty.websocket.common.extensions.compress">ByteAccumulator</a>&nbsp;accumulator)</pre>
</li>
</ul>
<a id="newByteAccumulator()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>newByteAccumulator</h4>
<pre class="methodSignature">protected&nbsp;<a href="ByteAccumulator.html" title="class in org.eclipse.jetty.websocket.common.extensions.compress">ByteAccumulator</a>&nbsp;newByteAccumulator()</pre>
</li>
</ul>
<a id="decompress(org.eclipse.jetty.websocket.common.extensions.compress.ByteAccumulator,java.nio.ByteBuffer)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>decompress</h4>
<pre class="methodSignature">protected&nbsp;void&nbsp;decompress&#8203;(<a href="ByteAccumulator.html" title="class in org.eclipse.jetty.websocket.common.extensions.compress">ByteAccumulator</a>&nbsp;accumulator,
java.nio.ByteBuffer&nbsp;buf)
throws java.util.zip.DataFormatException</pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.util.zip.DataFormatException</code></dd>
</dl>
</li>
</ul>
<a id="outgoingFrame(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>outgoingFrame</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;outgoingFrame&#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>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<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)">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>
<dt><span class="paramLabel">Parameters:</span></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>batchMode</code> - the batch mode requested by the sender.</dd>
</dl>
</li>
</ul>
<a id="notifyCallbackSuccess(org.eclipse.jetty.websocket.api.WriteCallback)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>notifyCallbackSuccess</h4>
<pre class="methodSignature">protected&nbsp;void&nbsp;notifyCallbackSuccess&#8203;(<a href="../../../api/WriteCallback.html" title="interface in org.eclipse.jetty.websocket.api">WriteCallback</a>&nbsp;callback)</pre>
</li>
</ul>
<a id="notifyCallbackFailure(org.eclipse.jetty.websocket.api.WriteCallback,java.lang.Throwable)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>notifyCallbackFailure</h4>
<pre class="methodSignature">protected&nbsp;void&nbsp;notifyCallbackFailure&#8203;(<a href="../../../api/WriteCallback.html" title="interface in org.eclipse.jetty.websocket.api">WriteCallback</a>&nbsp;callback,
java.lang.Throwable&nbsp;failure)</pre>
</li>
</ul>
<a id="endsWithTail(java.nio.ByteBuffer)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>endsWithTail</h4>
<pre class="methodSignature">public static&nbsp;boolean&nbsp;endsWithTail&#8203;(java.nio.ByteBuffer&nbsp;buf)</pre>
</li>
</ul>
<a id="doStop()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>doStop</h4>
<pre class="methodSignature">protected&nbsp;void&nbsp;doStop()
throws java.lang.Exception</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../util/component/AbstractLifeCycle.html#doStop()">doStop</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>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code></dd>
</dl>
</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="../AbstractExtension.html#toString()">toString</a></code>&nbsp;in class&nbsp;<code><a href="../AbstractExtension.html" title="class in org.eclipse.jetty.websocket.common.extensions">AbstractExtension</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/CompressExtension.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><a href="#field.detail">Field</a>&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;2021 <a href="https://webtide.com">Webtide</a>. All rights reserved.</small></p>
</footer>
</body>
</html>