Google Git
Sign in
eclipse / www.eclipse.org / jetty / 92c63d6826b92f76ab4f8177d8922836e0a8cc8b / . / javadoc / jetty-10 / org / eclipse / jetty / http2 / api / Stream.Listener.html
blob: 766c98a513c4bb63dbbc9c23db22207e07e451c5 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.13) on Tue Feb 08 12:40:05 CST 2022 -->
<title>Stream.Listener (Eclipse Jetty API Doc - v10.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="Stream.Listener (Eclipse Jetty API Doc - v10.0.8)";
}
}
catch(err) {
}
//-->
var data = {"i0":18,"i1":18,"i2":18,"i3":18,"i4":18,"i5":6,"i6":6,"i7":18,"i8":6,"i9":18,"i10":18};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default 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/Stream.Listener.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>Field&nbsp;|&nbsp;</li>
<li>Constr&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>Constr&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.http2.api</a></div>
<h2 title="Interface Stream.Listener" class="title">Interface Stream.Listener</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="../server/HTTP2ServerConnectionFactory.HTTPServerSessionListener.html" title="class in org.eclipse.jetty.http2.server">HTTP2ServerConnectionFactory.HTTPServerSessionListener</a></code>, <code><a href="Stream.Listener.Adapter.html" title="class in org.eclipse.jetty.http2.api">Stream.Listener.Adapter</a></code></dd>
</dl>
<dl>
<dt>Enclosing interface:</dt>
<dd><a href="Stream.html" title="interface in org.eclipse.jetty.http2.api">Stream</a></dd>
</dl>
<hr>
<pre>public static interface <span class="typeNameLabel">Stream.Listener</span></pre>
<div class="block"><p>A <a href="Stream.Listener.html" title="interface in org.eclipse.jetty.http2.api"><code>Stream.Listener</code></a> is the passive counterpart of a <a href="Stream.html" title="interface in org.eclipse.jetty.http2.api"><code>Stream</code></a> and receives
events happening on an HTTP/2 stream.</p>
<p>HTTP/2 data is flow controlled - this means that only a finite number of data events
are delivered, until the flow control window is exhausted.</p>
<p>Applications control the delivery of data events by requesting them via
<a href="Stream.html#demand(long)"><code>Stream.demand(long)</code></a>; the first event is always delivered, while subsequent
events must be explicitly demanded.</p>
<p>Applications control the HTTP/2 flow control by completing the callback associated
with data events - this allows the implementation to recycle the data buffer and
eventually to enlarge the flow control window so that the sender can send more data.</p></div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="Stream.html" title="interface in org.eclipse.jetty.http2.api"><code>Stream</code></a></dd>
</dl>
</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>
<table class="memberSummary">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="Stream.Listener.Adapter.html" title="class in org.eclipse.jetty.http2.api">Stream.Listener.Adapter</a></span></code></th>
<td class="colLast">
<div class="block">Empty implementation of <a href="Stream.Listener.html" title="interface in org.eclipse.jetty.http2.api"><code>Stream.Listener</code></a></div>
</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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default 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>default void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onBeforeData(org.eclipse.jetty.http2.api.Stream)">onBeforeData</a></span>&#8203;(<a href="Stream.html" title="interface in org.eclipse.jetty.http2.api">Stream</a>&nbsp;stream)</code></th>
<td class="colLast">
<div class="block">Callback method invoked before notifying the first DATA frame.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>default void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onClosed(org.eclipse.jetty.http2.api.Stream)">onClosed</a></span>&#8203;(<a href="Stream.html" title="interface in org.eclipse.jetty.http2.api">Stream</a>&nbsp;stream)</code></th>
<td class="colLast">
<div class="block">Callback method invoked after the stream has been closed.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>default void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onData(org.eclipse.jetty.http2.api.Stream,org.eclipse.jetty.http2.frames.DataFrame,org.eclipse.jetty.util.Callback)">onData</a></span>&#8203;(<a href="Stream.html" title="interface in org.eclipse.jetty.http2.api">Stream</a>&nbsp;stream,
<a href="../frames/DataFrame.html" title="class in org.eclipse.jetty.http2.frames">DataFrame</a>&nbsp;frame,
<a href="../../util/Callback.html" title="interface in org.eclipse.jetty.util">Callback</a>&nbsp;callback)</code></th>
<td class="colLast">
<div class="block">Callback method invoked when a DATA frame has been received.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>default void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onDataDemanded(org.eclipse.jetty.http2.api.Stream,org.eclipse.jetty.http2.frames.DataFrame,org.eclipse.jetty.util.Callback)">onDataDemanded</a></span>&#8203;(<a href="Stream.html" title="interface in org.eclipse.jetty.http2.api">Stream</a>&nbsp;stream,
<a href="../frames/DataFrame.html" title="class in org.eclipse.jetty.http2.frames">DataFrame</a>&nbsp;frame,
<a href="../../util/Callback.html" title="interface in org.eclipse.jetty.util">Callback</a>&nbsp;callback)</code></th>
<td class="colLast">
<div class="block">Callback method invoked when a DATA frame has been demanded.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>default void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onFailure(org.eclipse.jetty.http2.api.Stream,int,java.lang.String,java.lang.Throwable,org.eclipse.jetty.util.Callback)">onFailure</a></span>&#8203;(<a href="Stream.html" title="interface in org.eclipse.jetty.http2.api">Stream</a>&nbsp;stream,
int&nbsp;error,
java.lang.String&nbsp;reason,
java.lang.Throwable&nbsp;failure,
<a href="../../util/Callback.html" title="interface in org.eclipse.jetty.util">Callback</a>&nbsp;callback)</code></th>
<td class="colLast">
<div class="block">Callback method invoked when the stream failed.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onHeaders(org.eclipse.jetty.http2.api.Stream,org.eclipse.jetty.http2.frames.HeadersFrame)">onHeaders</a></span>&#8203;(<a href="Stream.html" title="interface in org.eclipse.jetty.http2.api">Stream</a>&nbsp;stream,
<a href="../frames/HeadersFrame.html" title="class in org.eclipse.jetty.http2.frames">HeadersFrame</a>&nbsp;frame)</code></th>
<td class="colLast">
<div class="block">Callback method invoked when a HEADERS frame representing the HTTP response has been received.</div>
</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="#onIdleTimeout(org.eclipse.jetty.http2.api.Stream,java.lang.Throwable)">onIdleTimeout</a></span>&#8203;(<a href="Stream.html" title="interface in org.eclipse.jetty.http2.api">Stream</a>&nbsp;stream,
java.lang.Throwable&nbsp;x)</code></th>
<td class="colLast">
<div class="block">Callback method invoked when the stream exceeds its idle timeout.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>default void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onNewStream(org.eclipse.jetty.http2.api.Stream)">onNewStream</a></span>&#8203;(<a href="Stream.html" title="interface in org.eclipse.jetty.http2.api">Stream</a>&nbsp;stream)</code></th>
<td class="colLast">
<div class="block">Callback method invoked when a stream is created locally by
<a href="Session.html#newStream(org.eclipse.jetty.http2.frames.HeadersFrame,org.eclipse.jetty.util.Promise,org.eclipse.jetty.http2.api.Stream.Listener)"><code>Session.newStream(HeadersFrame, Promise, Listener)</code></a>.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="Stream.Listener.html" title="interface in org.eclipse.jetty.http2.api">Stream.Listener</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onPush(org.eclipse.jetty.http2.api.Stream,org.eclipse.jetty.http2.frames.PushPromiseFrame)">onPush</a></span>&#8203;(<a href="Stream.html" title="interface in org.eclipse.jetty.http2.api">Stream</a>&nbsp;stream,
<a href="../frames/PushPromiseFrame.html" title="class in org.eclipse.jetty.http2.frames">PushPromiseFrame</a>&nbsp;frame)</code></th>
<td class="colLast">
<div class="block">Callback method invoked when a PUSH_PROMISE frame has been received.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>default void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onReset(org.eclipse.jetty.http2.api.Stream,org.eclipse.jetty.http2.frames.ResetFrame)">onReset</a></span>&#8203;(<a href="Stream.html" title="interface in org.eclipse.jetty.http2.api">Stream</a>&nbsp;stream,
<a href="../frames/ResetFrame.html" title="class in org.eclipse.jetty.http2.frames">ResetFrame</a>&nbsp;frame)</code></th>
<td class="colLast">
<div class="block">Callback method invoked when a RST_STREAM frame has been received for this stream.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>default void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onReset(org.eclipse.jetty.http2.api.Stream,org.eclipse.jetty.http2.frames.ResetFrame,org.eclipse.jetty.util.Callback)">onReset</a></span>&#8203;(<a href="Stream.html" title="interface in org.eclipse.jetty.http2.api">Stream</a>&nbsp;stream,
<a href="../frames/ResetFrame.html" title="class in org.eclipse.jetty.http2.frames">ResetFrame</a>&nbsp;frame,
<a href="../../util/Callback.html" title="interface in org.eclipse.jetty.util">Callback</a>&nbsp;callback)</code></th>
<td class="colLast">
<div class="block">Callback method invoked when a RST_STREAM frame has been received for this stream.</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="onNewStream(org.eclipse.jetty.http2.api.Stream)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>onNewStream</h4>
<pre class="methodSignature">default&nbsp;void&nbsp;onNewStream&#8203;(<a href="Stream.html" title="interface in org.eclipse.jetty.http2.api">Stream</a>&nbsp;stream)</pre>
<div class="block"><p>Callback method invoked when a stream is created locally by
<a href="Session.html#newStream(org.eclipse.jetty.http2.frames.HeadersFrame,org.eclipse.jetty.util.Promise,org.eclipse.jetty.http2.api.Stream.Listener)"><code>Session.newStream(HeadersFrame, Promise, Listener)</code></a>.</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>stream</code> - the newly created stream</dd>
</dl>
</li>
</ul>
<a id="onHeaders(org.eclipse.jetty.http2.api.Stream,org.eclipse.jetty.http2.frames.HeadersFrame)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>onHeaders</h4>
<pre class="methodSignature">void&nbsp;onHeaders&#8203;(<a href="Stream.html" title="interface in org.eclipse.jetty.http2.api">Stream</a>&nbsp;stream,
<a href="../frames/HeadersFrame.html" title="class in org.eclipse.jetty.http2.frames">HeadersFrame</a>&nbsp;frame)</pre>
<div class="block"><p>Callback method invoked when a HEADERS frame representing the HTTP response has been received.</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>stream</code> - the stream</dd>
<dd><code>frame</code> - the HEADERS frame received</dd>
</dl>
</li>
</ul>
<a id="onPush(org.eclipse.jetty.http2.api.Stream,org.eclipse.jetty.http2.frames.PushPromiseFrame)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>onPush</h4>
<pre class="methodSignature"><a href="Stream.Listener.html" title="interface in org.eclipse.jetty.http2.api">Stream.Listener</a>&nbsp;onPush&#8203;(<a href="Stream.html" title="interface in org.eclipse.jetty.http2.api">Stream</a>&nbsp;stream,
<a href="../frames/PushPromiseFrame.html" title="class in org.eclipse.jetty.http2.frames">PushPromiseFrame</a>&nbsp;frame)</pre>
<div class="block"><p>Callback method invoked when a PUSH_PROMISE frame has been received.</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>stream</code> - the pushed stream</dd>
<dd><code>frame</code> - the PUSH_PROMISE frame received</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a Stream.Listener that will be notified of pushed stream events</dd>
</dl>
</li>
</ul>
<a id="onBeforeData(org.eclipse.jetty.http2.api.Stream)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>onBeforeData</h4>
<pre class="methodSignature">default&nbsp;void&nbsp;onBeforeData&#8203;(<a href="Stream.html" title="interface in org.eclipse.jetty.http2.api">Stream</a>&nbsp;stream)</pre>
<div class="block"><p>Callback method invoked before notifying the first DATA frame.</p>
<p>The default implementation initializes the demand for DATA frames.</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>stream</code> - the stream</dd>
</dl>
</li>
</ul>
<a id="onData(org.eclipse.jetty.http2.api.Stream,org.eclipse.jetty.http2.frames.DataFrame,org.eclipse.jetty.util.Callback)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>onData</h4>
<pre class="methodSignature">default&nbsp;void&nbsp;onData&#8203;(<a href="Stream.html" title="interface in org.eclipse.jetty.http2.api">Stream</a>&nbsp;stream,
<a href="../frames/DataFrame.html" title="class in org.eclipse.jetty.http2.frames">DataFrame</a>&nbsp;frame,
<a href="../../util/Callback.html" title="interface in org.eclipse.jetty.util">Callback</a>&nbsp;callback)</pre>
<div class="block"><p>Callback method invoked when a DATA frame has been received.</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>stream</code> - the stream</dd>
<dd><code>frame</code> - the DATA frame received</dd>
<dd><code>callback</code> - the callback to complete when the bytes of the DATA frame have been consumed</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="#onDataDemanded(org.eclipse.jetty.http2.api.Stream,org.eclipse.jetty.http2.frames.DataFrame,org.eclipse.jetty.util.Callback)"><code>onDataDemanded(Stream, DataFrame, Callback)</code></a></dd>
</dl>
</li>
</ul>
<a id="onDataDemanded(org.eclipse.jetty.http2.api.Stream,org.eclipse.jetty.http2.frames.DataFrame,org.eclipse.jetty.util.Callback)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>onDataDemanded</h4>
<pre class="methodSignature">default&nbsp;void&nbsp;onDataDemanded&#8203;(<a href="Stream.html" title="interface in org.eclipse.jetty.http2.api">Stream</a>&nbsp;stream,
<a href="../frames/DataFrame.html" title="class in org.eclipse.jetty.http2.frames">DataFrame</a>&nbsp;frame,
<a href="../../util/Callback.html" title="interface in org.eclipse.jetty.util">Callback</a>&nbsp;callback)</pre>
<div class="block"><p>Callback method invoked when a DATA frame has been demanded.</p>
<p>Implementations of this method must arrange to call (within the
method or otherwise asynchronously) <a href="Stream.html#demand(long)"><code>Stream.demand(long)</code></a>.</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>stream</code> - the stream</dd>
<dd><code>frame</code> - the DATA frame received</dd>
<dd><code>callback</code> - the callback to complete when the bytes of the DATA frame have been consumed</dd>
</dl>
</li>
</ul>
<a id="onReset(org.eclipse.jetty.http2.api.Stream,org.eclipse.jetty.http2.frames.ResetFrame,org.eclipse.jetty.util.Callback)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>onReset</h4>
<pre class="methodSignature">default&nbsp;void&nbsp;onReset&#8203;(<a href="Stream.html" title="interface in org.eclipse.jetty.http2.api">Stream</a>&nbsp;stream,
<a href="../frames/ResetFrame.html" title="class in org.eclipse.jetty.http2.frames">ResetFrame</a>&nbsp;frame,
<a href="../../util/Callback.html" title="interface in org.eclipse.jetty.util">Callback</a>&nbsp;callback)</pre>
<div class="block"><p>Callback method invoked when a RST_STREAM frame has been received for this stream.</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>stream</code> - the stream</dd>
<dd><code>frame</code> - the RST_FRAME received</dd>
<dd><code>callback</code> - the callback to complete when the reset has been handled</dd>
</dl>
</li>
</ul>
<a id="onReset(org.eclipse.jetty.http2.api.Stream,org.eclipse.jetty.http2.frames.ResetFrame)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>onReset</h4>
<pre class="methodSignature">default&nbsp;void&nbsp;onReset&#8203;(<a href="Stream.html" title="interface in org.eclipse.jetty.http2.api">Stream</a>&nbsp;stream,
<a href="../frames/ResetFrame.html" title="class in org.eclipse.jetty.http2.frames">ResetFrame</a>&nbsp;frame)</pre>
<div class="block"><p>Callback method invoked when a RST_STREAM frame has been received for this stream.</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>stream</code> - the stream</dd>
<dd><code>frame</code> - the RST_FRAME received</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="Session.Listener.html#onReset(org.eclipse.jetty.http2.api.Session,org.eclipse.jetty.http2.frames.ResetFrame)"><code>Session.Listener.onReset(Session, ResetFrame)</code></a></dd>
</dl>
</li>
</ul>
<a id="onIdleTimeout(org.eclipse.jetty.http2.api.Stream,java.lang.Throwable)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>onIdleTimeout</h4>
<pre class="methodSignature">boolean&nbsp;onIdleTimeout&#8203;(<a href="Stream.html" title="interface in org.eclipse.jetty.http2.api">Stream</a>&nbsp;stream,
java.lang.Throwable&nbsp;x)</pre>
<div class="block"><p>Callback method invoked when the stream exceeds its idle timeout.</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>stream</code> - the stream</dd>
<dd><code>x</code> - the timeout failure</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true to reset the stream, false to ignore the idle timeout</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="Stream.html#getIdleTimeout()"><code>Stream.getIdleTimeout()</code></a></dd>
</dl>
</li>
</ul>
<a id="onFailure(org.eclipse.jetty.http2.api.Stream,int,java.lang.String,java.lang.Throwable,org.eclipse.jetty.util.Callback)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>onFailure</h4>
<pre class="methodSignature">default&nbsp;void&nbsp;onFailure&#8203;(<a href="Stream.html" title="interface in org.eclipse.jetty.http2.api">Stream</a>&nbsp;stream,
int&nbsp;error,
java.lang.String&nbsp;reason,
java.lang.Throwable&nbsp;failure,
<a href="../../util/Callback.html" title="interface in org.eclipse.jetty.util">Callback</a>&nbsp;callback)</pre>
<div class="block"><p>Callback method invoked when the stream failed.</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>stream</code> - the stream</dd>
<dd><code>error</code> - the error code</dd>
<dd><code>reason</code> - the error reason, or null</dd>
<dd><code>failure</code> - the failure</dd>
<dd><code>callback</code> - the callback to complete when the failure has been handled</dd>
</dl>
</li>
</ul>
<a id="onClosed(org.eclipse.jetty.http2.api.Stream)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>onClosed</h4>
<pre class="methodSignature">default&nbsp;void&nbsp;onClosed&#8203;(<a href="Stream.html" title="interface in org.eclipse.jetty.http2.api">Stream</a>&nbsp;stream)</pre>
<div class="block"><p>Callback method invoked after the stream has been closed.</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>stream</code> - the stream</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/Stream.Listener.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>Field&nbsp;|&nbsp;</li>
<li>Constr&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>Constr&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>