blob: 5142f5f4c966fe4ef078fd71aa76c4bffc8c9272 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.13) on Tue Feb 08 12:41:33 CST 2022 -->
<title>FragmentExtension.FragmentingDemandingFlusher (Eclipse Jetty API Doc - v11.0.8)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-02-08">
<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="FragmentExtension.FragmentingDemandingFlusher (Eclipse Jetty API Doc - v11.0.8)";
}
}
catch(err) {
}
//-->
var data = {"i0":10};
var tabs = {65535:["t0","All 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 = true;
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/FragmentExtension.FragmentingDemandingFlusher.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.core.internal</a></div>
<h2 title="Class FragmentExtension.FragmentingDemandingFlusher" class="title">Class FragmentExtension.FragmentingDemandingFlusher</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../util/IteratingCallback.html" title="class in org.eclipse.jetty.util">org.eclipse.jetty.util.IteratingCallback</a></li>
<li>
<ul class="inheritance">
<li><a href="DemandingFlusher.html" title="class in org.eclipse.jetty.websocket.core.internal">org.eclipse.jetty.websocket.core.internal.DemandingFlusher</a></li>
<li>
<ul class="inheritance">
<li>org.eclipse.jetty.websocket.core.internal.FragmentExtension.FragmentingDemandingFlusher</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/Callback.html" title="interface in org.eclipse.jetty.util">Callback</a></code>, <code><a href="../../../util/thread/Invocable.html" title="interface in org.eclipse.jetty.util.thread">Invocable</a></code>, <code><a href="DemandChain.html" title="interface in org.eclipse.jetty.websocket.core.internal">DemandChain</a></code></dd>
</dl>
<dl>
<dt>Enclosing class:</dt>
<dd><a href="FragmentExtension.html" title="class in org.eclipse.jetty.websocket.core.internal">FragmentExtension</a></dd>
</dl>
<hr>
<pre>public class <span class="typeNameLabel">FragmentExtension.FragmentingDemandingFlusher</span>
extends <a href="DemandingFlusher.html" title="class in org.eclipse.jetty.websocket.core.internal">DemandingFlusher</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.IteratingCallback">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from class&nbsp;org.eclipse.jetty.util.<a href="../../../util/IteratingCallback.html" title="class in org.eclipse.jetty.util">IteratingCallback</a></h3>
<code><a href="../../../util/IteratingCallback.Action.html" title="enum in org.eclipse.jetty.util">IteratingCallback.Action</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="nested.classes.inherited.from.class.org.eclipse.jetty.util.Callback">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface&nbsp;org.eclipse.jetty.util.<a href="../../../util/Callback.html" title="interface in org.eclipse.jetty.util">Callback</a></h3>
<code><a href="../../../util/Callback.Completable.html" title="class in org.eclipse.jetty.util">Callback.Completable</a>, <a href="../../../util/Callback.Completing.html" title="class in org.eclipse.jetty.util">Callback.Completing</a>, <a href="../../../util/Callback.Nested.html" title="class in org.eclipse.jetty.util">Callback.Nested</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="nested.classes.inherited.from.class.org.eclipse.jetty.util.thread.Invocable">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface&nbsp;org.eclipse.jetty.util.thread.<a href="../../../util/thread/Invocable.html" title="interface in org.eclipse.jetty.util.thread">Invocable</a></h3>
<code><a href="../../../util/thread/Invocable.InvocationType.html" title="enum in org.eclipse.jetty.util.thread">Invocable.InvocationType</a>, <a href="../../../util/thread/Invocable.ReadyTask.html" title="class in org.eclipse.jetty.util.thread">Invocable.ReadyTask</a>, <a href="../../../util/thread/Invocable.Task.html" title="interface in org.eclipse.jetty.util.thread">Invocable.Task</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.Callback">
<!-- -->
</a>
<h3>Fields inherited from interface&nbsp;org.eclipse.jetty.util.<a href="../../../util/Callback.html" title="interface in org.eclipse.jetty.util">Callback</a></h3>
<code><a href="../../../util/Callback.html#NOOP">NOOP</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="fields.inherited.from.class.org.eclipse.jetty.util.thread.Invocable">
<!-- -->
</a>
<h3>Fields inherited from interface&nbsp;org.eclipse.jetty.util.thread.<a href="../../../util/thread/Invocable.html" title="interface in org.eclipse.jetty.util.thread">Invocable</a></h3>
<code><a href="../../../util/thread/Invocable.html#__nonBlocking">__nonBlocking</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()">FragmentingDemandingFlusher</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></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 boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#handle(org.eclipse.jetty.websocket.core.Frame,org.eclipse.jetty.util.Callback,boolean)">handle</a></span>&#8203;(<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;first)</code></th>
<td class="colLast">
<div class="block">Called when there is demand for a single frame to be produced.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.eclipse.jetty.websocket.core.internal.DemandingFlusher">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.eclipse.jetty.websocket.core.internal.<a href="DemandingFlusher.html" title="class in org.eclipse.jetty.websocket.core.internal">DemandingFlusher</a></h3>
<code><a href="DemandingFlusher.html#demand(long)">demand</a>, <a href="DemandingFlusher.html#emitFrame(org.eclipse.jetty.websocket.core.Frame,org.eclipse.jetty.util.Callback)">emitFrame</a>, <a href="DemandingFlusher.html#failFlusher(java.lang.Throwable)">failFlusher</a>, <a href="DemandingFlusher.html#onCompleteFailure(java.lang.Throwable)">onCompleteFailure</a>, <a href="DemandingFlusher.html#onFrame(org.eclipse.jetty.websocket.core.Frame,org.eclipse.jetty.util.Callback)">onFrame</a>, <a href="DemandingFlusher.html#process()">process</a>, <a href="DemandingFlusher.html#setNextDemand(java.util.function.LongConsumer)">setNextDemand</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.eclipse.jetty.util.IteratingCallback">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.eclipse.jetty.util.<a href="../../../util/IteratingCallback.html" title="class in org.eclipse.jetty.util">IteratingCallback</a></h3>
<code><a href="../../../util/IteratingCallback.html#close()">close</a>, <a href="../../../util/IteratingCallback.html#failed(java.lang.Throwable)">failed</a>, <a href="../../../util/IteratingCallback.html#isClosed()">isClosed</a>, <a href="../../../util/IteratingCallback.html#isFailed()">isFailed</a>, <a href="../../../util/IteratingCallback.html#isSucceeded()">isSucceeded</a>, <a href="../../../util/IteratingCallback.html#iterate()">iterate</a>, <a href="../../../util/IteratingCallback.html#onCompleteSuccess()">onCompleteSuccess</a>, <a href="../../../util/IteratingCallback.html#reset()">reset</a>, <a href="../../../util/IteratingCallback.html#succeeded()">succeeded</a>, <a href="../../../util/IteratingCallback.html#toString()">toString</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.util.Callback">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.eclipse.jetty.util.<a href="../../../util/Callback.html" title="interface in org.eclipse.jetty.util">Callback</a></h3>
<code><a href="../../../util/Callback.html#completeWith(java.util.concurrent.CompletableFuture)">completeWith</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.eclipse.jetty.util.thread.Invocable">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.eclipse.jetty.util.thread.<a href="../../../util/thread/Invocable.html" title="interface in org.eclipse.jetty.util.thread">Invocable</a></h3>
<code><a href="../../../util/thread/Invocable.html#getInvocationType()">getInvocationType</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>FragmentingDemandingFlusher</h4>
<pre>public&nbsp;FragmentingDemandingFlusher()</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="handle(org.eclipse.jetty.websocket.core.Frame,org.eclipse.jetty.util.Callback,boolean)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>handle</h4>
<pre class="methodSignature">protected&nbsp;boolean&nbsp;handle&#8203;(<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;first)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="DemandingFlusher.html#handle(org.eclipse.jetty.websocket.core.Frame,org.eclipse.jetty.util.Callback,boolean)">DemandingFlusher</a></code></span></div>
<div class="block"><p>Called when there is demand for a single frame to be produced. During this method a single call can be made
to <a href="DemandingFlusher.html#emitFrame(org.eclipse.jetty.websocket.core.Frame,org.eclipse.jetty.util.Callback)"><code>DemandingFlusher.emitFrame(Frame, Callback)</code></a> which will forward this frame towards the application. Returning true
from this method signals that you are done processing the current Frame, and the next invocation of this
method will have the next frame.</p>
<p>Note that the callback supplied here is specially wrapped so that you can call
it multiple times and it will not be completed more than once. This simplifies the
handling of failure cases.</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="DemandingFlusher.html#handle(org.eclipse.jetty.websocket.core.Frame,org.eclipse.jetty.util.Callback,boolean)">handle</a></code>&nbsp;in class&nbsp;<code><a href="DemandingFlusher.html" title="class in org.eclipse.jetty.websocket.core.internal">DemandingFlusher</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>frame</code> - the original frame.</dd>
<dd><code>callback</code> - to succeed to release the frame payload.</dd>
<dd><code>first</code> - if this is the first time this method has been called for this frame.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>false to continue processing this frame, true to complete processing and get a new frame.</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/FragmentExtension.FragmentingDemandingFlusher.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;2022 <a href="https://webtide.com">Webtide</a>. All rights reserved.</small></p>
</footer>
</body>
</html>