blob: 5c7c63c44ce53e0083617f7f788d9aae65a324eb [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Thu Sep 15 14:12:07 CDT 2022 -->
<title>Stream (Eclipse Jetty API Doc - v10.0.12)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-09-15">
<meta name="description" content="declaration: package: org.eclipse.jetty.http2.api, interface: Stream">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script>
</head>
<body class="class-declaration-page">
<script type="text/javascript">var evenRowColor = "even-row-color";
var oddRowColor = "odd-row-color";
var tableTab = "table-tab";
var activeTableTab = "active-table-tab";
var pathtoroot = "../../../../../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</li>
<li><a href="class-use/Stream.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html#class">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div>
<ul class="sub-nav-list">
<li>Summary:&nbsp;</li>
<li><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="sub-nav-list">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method-detail">Method</a></li>
</ul>
</div>
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">org.eclipse.jetty.http2.api</a></div>
<h1 title="Interface Stream" class="title">Interface Stream</h1>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Known Subinterfaces:</dt>
<dd><code><a href="../IStream.html" title="interface in org.eclipse.jetty.http2">IStream</a></code></dd>
</dl>
<dl class="notes">
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="../HTTP2Stream.html" title="class in org.eclipse.jetty.http2">HTTP2Stream</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">Stream</span></div>
<div class="block"><p>A <a href="Stream.html" title="interface in org.eclipse.jetty.http2.api"><code>Stream</code></a> represents a bidirectional exchange of data on top of a <a href="Session.html" title="interface in org.eclipse.jetty.http2.api"><code>Session</code></a>.</p>
<p>Differently from socket streams, where the input and output streams are permanently associated
with the socket (and hence with the connection that the socket represents), there can be multiple
HTTP/2 streams present concurrently for an HTTP/2 session.</p>
<p>A <a href="Stream.html" title="interface in org.eclipse.jetty.http2.api"><code>Stream</code></a> maps to an HTTP request/response cycle, and after the request/response cycle is
completed, the stream is closed and removed from the session.</p>
<p>Like <a href="Session.html" title="interface in org.eclipse.jetty.http2.api"><code>Session</code></a>, <a href="Stream.html" title="interface in org.eclipse.jetty.http2.api"><code>Stream</code></a> is the active part and by calling its API applications
can generate events on the stream; conversely, <a href="Stream.Listener.html" title="interface in org.eclipse.jetty.http2.api"><code>Stream.Listener</code></a> is the passive part, and
its callbacks are invoked when events happen on the stream.</p></div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="Stream.Listener.html" title="interface in org.eclipse.jetty.http2.api"><code>Stream.Listener</code></a></li>
</ul>
</dd>
</dl>
</section>
<section class="summary">
<ul class="summary-list">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<li>
<section class="nested-class-summary" id="nested-class-summary">
<h2>Nested Class Summary</h2>
<div class="caption"><span>Nested Classes</span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Interface</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>static interface&nbsp;</code></div>
<div class="col-second even-row-color"><code><a href="Stream.Listener.html" class="type-name-link" title="interface in org.eclipse.jetty.http2.api">Stream.Listener</a></code></div>
<div class="col-last even-row-color">
<div class="block">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.</div>
</div>
</div>
</section>
</li>
<!-- ========== METHOD SUMMARY =========== -->
<li>
<section class="method-summary" id="method-summary">
<h2>Method Summary</h2>
<div id="method-summary-table">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button><button id="method-summary-table-tab5" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab5', 3)" class="table-tab">Default Methods</button></div>
<div id="method-summary-table.tabpanel" role="tabpanel">
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/CompletableFuture.html" title="class or interface in java.util.concurrent" class="external-link">CompletableFuture</a>&lt;<a href="Stream.html" title="interface in org.eclipse.jetty.http2.api">Stream</a>&gt;</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#data(org.eclipse.jetty.http2.frames.DataFrame)" class="member-name-link">data</a><wbr>(<a href="../frames/DataFrame.html" title="class in org.eclipse.jetty.http2.frames">DataFrame</a>&nbsp;frame)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">
<div class="block">Sends the given DATA <code>frame</code>.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#data(org.eclipse.jetty.http2.frames.DataFrame,org.eclipse.jetty.util.Callback)" class="member-name-link">data</a><wbr>(<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></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Sends the given DATA <code>frame</code>.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#demand(long)" class="member-name-link">demand</a><wbr>(long&nbsp;n)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Demands <code>n</code> more <code>DATA</code> frames for this stream.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getAttribute(java.lang.String)" class="member-name-link">getAttribute</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;key)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">&nbsp;</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>int</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getId()" class="member-name-link">getId</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>long</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getIdleTimeout()" class="member-name-link">getIdleTimeout</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">&nbsp;</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="Session.html" title="interface in org.eclipse.jetty.http2.api">Session</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getSession()" class="member-name-link">getSession</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/CompletableFuture.html" title="class or interface in java.util.concurrent" class="external-link">CompletableFuture</a>&lt;<a href="Stream.html" title="interface in org.eclipse.jetty.http2.api">Stream</a>&gt;</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#headers(org.eclipse.jetty.http2.frames.HeadersFrame)" class="member-name-link">headers</a><wbr>(<a href="../frames/HeadersFrame.html" title="class in org.eclipse.jetty.http2.frames">HeadersFrame</a>&nbsp;frame)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">
<div class="block">Sends the given HEADERS <code>frame</code> representing an HTTP response.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#headers(org.eclipse.jetty.http2.frames.HeadersFrame,org.eclipse.jetty.util.Callback)" class="member-name-link">headers</a><wbr>(<a href="../frames/HeadersFrame.html" title="class in org.eclipse.jetty.http2.frames">HeadersFrame</a>&nbsp;frame,
<a href="../../util/Callback.html" title="interface in org.eclipse.jetty.util">Callback</a>&nbsp;callback)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Sends the given HEADERS <code>frame</code>.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#isClosed()" class="member-name-link">isClosed</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">&nbsp;</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#isReset()" class="member-name-link">isReset</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/CompletableFuture.html" title="class or interface in java.util.concurrent" class="external-link">CompletableFuture</a>&lt;<a href="Stream.html" title="interface in org.eclipse.jetty.http2.api">Stream</a>&gt;</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#push(org.eclipse.jetty.http2.frames.PushPromiseFrame,org.eclipse.jetty.http2.api.Stream.Listener)" class="member-name-link">push</a><wbr>(<a href="../frames/PushPromiseFrame.html" title="class in org.eclipse.jetty.http2.frames">PushPromiseFrame</a>&nbsp;frame,
<a href="Stream.Listener.html" title="interface in org.eclipse.jetty.http2.api">Stream.Listener</a>&nbsp;listener)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">
<div class="block">Sends the given PUSH_PROMISE <code>frame</code>.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#push(org.eclipse.jetty.http2.frames.PushPromiseFrame,org.eclipse.jetty.util.Promise,org.eclipse.jetty.http2.api.Stream.Listener)" class="member-name-link">push</a><wbr>(<a href="../frames/PushPromiseFrame.html" title="class in org.eclipse.jetty.http2.frames">PushPromiseFrame</a>&nbsp;frame,
<a href="../../util/Promise.html" title="interface in org.eclipse.jetty.util">Promise</a>&lt;<a href="Stream.html" title="interface in org.eclipse.jetty.http2.api">Stream</a>&gt;&nbsp;promise,
<a href="Stream.Listener.html" title="interface in org.eclipse.jetty.http2.api">Stream.Listener</a>&nbsp;listener)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Sends the given PUSH_PROMISE <code>frame</code>.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#removeAttribute(java.lang.String)" class="member-name-link">removeAttribute</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;key)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">&nbsp;</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#reset(org.eclipse.jetty.http2.frames.ResetFrame,org.eclipse.jetty.util.Callback)" class="member-name-link">reset</a><wbr>(<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></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Sends the given RST_STREAM <code>frame</code>.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setAttribute(java.lang.String,java.lang.Object)" class="member-name-link">setAttribute</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;key,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&nbsp;value)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">&nbsp;</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setIdleTimeout(long)" class="member-name-link">setIdleTimeout</a><wbr>(long&nbsp;idleTimeout)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">&nbsp;</div>
</div>
</div>
</div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="getId()">
<h3>getId</h3>
<div class="member-signature"><span class="return-type">int</span>&nbsp;<span class="element-name">getId</span>()</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the stream unique id</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getSession()">
<h3>getSession</h3>
<div class="member-signature"><span class="return-type"><a href="Session.html" title="interface in org.eclipse.jetty.http2.api">Session</a></span>&nbsp;<span class="element-name">getSession</span>()</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the session this stream is associated to</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="headers(org.eclipse.jetty.http2.frames.HeadersFrame)">
<h3>headers</h3>
<div class="member-signature"><span class="modifiers">default</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/CompletableFuture.html" title="class or interface in java.util.concurrent" class="external-link">CompletableFuture</a>&lt;<a href="Stream.html" title="interface in org.eclipse.jetty.http2.api">Stream</a>&gt;</span>&nbsp;<span class="element-name">headers</span><wbr><span class="parameters">(<a href="../frames/HeadersFrame.html" title="class in org.eclipse.jetty.http2.frames">HeadersFrame</a>&nbsp;frame)</span></div>
<div class="block"><p>Sends the given HEADERS <code>frame</code> representing an HTTP response.</p></div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>frame</code> - the HEADERS frame to send</dd>
<dt>Returns:</dt>
<dd>the CompletableFuture that gets notified when the frame has been sent</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="headers(org.eclipse.jetty.http2.frames.HeadersFrame,org.eclipse.jetty.util.Callback)">
<h3>headers</h3>
<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">headers</span><wbr><span class="parameters">(<a href="../frames/HeadersFrame.html" title="class in org.eclipse.jetty.http2.frames">HeadersFrame</a>&nbsp;frame,
<a href="../../util/Callback.html" title="interface in org.eclipse.jetty.util">Callback</a>&nbsp;callback)</span></div>
<div class="block"><p>Sends the given HEADERS <code>frame</code>.</p>
<p>Typically used to send an HTTP response or to send the HTTP response trailers.</p></div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>frame</code> - the HEADERS frame to send</dd>
<dd><code>callback</code> - the callback that gets notified when the frame has been sent</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="push(org.eclipse.jetty.http2.frames.PushPromiseFrame,org.eclipse.jetty.http2.api.Stream.Listener)">
<h3>push</h3>
<div class="member-signature"><span class="modifiers">default</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/CompletableFuture.html" title="class or interface in java.util.concurrent" class="external-link">CompletableFuture</a>&lt;<a href="Stream.html" title="interface in org.eclipse.jetty.http2.api">Stream</a>&gt;</span>&nbsp;<span class="element-name">push</span><wbr><span class="parameters">(<a href="../frames/PushPromiseFrame.html" title="class in org.eclipse.jetty.http2.frames">PushPromiseFrame</a>&nbsp;frame,
<a href="Stream.Listener.html" title="interface in org.eclipse.jetty.http2.api">Stream.Listener</a>&nbsp;listener)</span></div>
<div class="block"><p>Sends the given PUSH_PROMISE <code>frame</code>.</p></div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>frame</code> - the PUSH_PROMISE frame to send</dd>
<dd><code>listener</code> - the listener that gets notified of stream events</dd>
<dt>Returns:</dt>
<dd>the CompletableFuture that gets notified of the pushed stream creation</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="push(org.eclipse.jetty.http2.frames.PushPromiseFrame,org.eclipse.jetty.util.Promise,org.eclipse.jetty.http2.api.Stream.Listener)">
<h3>push</h3>
<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">push</span><wbr><span class="parameters">(<a href="../frames/PushPromiseFrame.html" title="class in org.eclipse.jetty.http2.frames">PushPromiseFrame</a>&nbsp;frame,
<a href="../../util/Promise.html" title="interface in org.eclipse.jetty.util">Promise</a>&lt;<a href="Stream.html" title="interface in org.eclipse.jetty.http2.api">Stream</a>&gt;&nbsp;promise,
<a href="Stream.Listener.html" title="interface in org.eclipse.jetty.http2.api">Stream.Listener</a>&nbsp;listener)</span></div>
<div class="block"><p>Sends the given PUSH_PROMISE <code>frame</code>.</p></div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>frame</code> - the PUSH_PROMISE frame to send</dd>
<dd><code>promise</code> - the promise that gets notified of the pushed stream creation</dd>
<dd><code>listener</code> - the listener that gets notified of stream events</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="data(org.eclipse.jetty.http2.frames.DataFrame)">
<h3>data</h3>
<div class="member-signature"><span class="modifiers">default</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/CompletableFuture.html" title="class or interface in java.util.concurrent" class="external-link">CompletableFuture</a>&lt;<a href="Stream.html" title="interface in org.eclipse.jetty.http2.api">Stream</a>&gt;</span>&nbsp;<span class="element-name">data</span><wbr><span class="parameters">(<a href="../frames/DataFrame.html" title="class in org.eclipse.jetty.http2.frames">DataFrame</a>&nbsp;frame)</span></div>
<div class="block"><p>Sends the given DATA <code>frame</code>.</p></div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>frame</code> - the DATA frame to send</dd>
<dt>Returns:</dt>
<dd>the CompletableFuture that gets notified when the frame has been sent</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="data(org.eclipse.jetty.http2.frames.DataFrame,org.eclipse.jetty.util.Callback)">
<h3>data</h3>
<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">data</span><wbr><span class="parameters">(<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)</span></div>
<div class="block"><p>Sends the given DATA <code>frame</code>.</p></div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>frame</code> - the DATA frame to send</dd>
<dd><code>callback</code> - the callback that gets notified when the frame has been sent</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="reset(org.eclipse.jetty.http2.frames.ResetFrame,org.eclipse.jetty.util.Callback)">
<h3>reset</h3>
<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">reset</span><wbr><span class="parameters">(<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)</span></div>
<div class="block"><p>Sends the given RST_STREAM <code>frame</code>.</p></div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>frame</code> - the RST_FRAME to send</dd>
<dd><code>callback</code> - the callback that gets notified when the frame has been sent</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getAttribute(java.lang.String)">
<h3>getAttribute</h3>
<div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span>&nbsp;<span class="element-name">getAttribute</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;key)</span></div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>key</code> - the attribute key</dd>
<dt>Returns:</dt>
<dd>an arbitrary object associated with the given key to this stream
or null if no object can be found for the given key.</dd>
<dt>See Also:</dt>
<dd>
<ul class="see-list-long">
<li><a href="#setAttribute(java.lang.String,java.lang.Object)"><code>setAttribute(String, Object)</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setAttribute(java.lang.String,java.lang.Object)">
<h3>setAttribute</h3>
<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">setAttribute</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;key,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&nbsp;value)</span></div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>key</code> - the attribute key</dd>
<dd><code>value</code> - an arbitrary object to associate with the given key to this stream</dd>
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="#getAttribute(java.lang.String)"><code>getAttribute(String)</code></a></li>
<li><a href="#removeAttribute(java.lang.String)"><code>removeAttribute(String)</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="removeAttribute(java.lang.String)">
<h3>removeAttribute</h3>
<div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span>&nbsp;<span class="element-name">removeAttribute</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;key)</span></div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>key</code> - the attribute key</dd>
<dt>Returns:</dt>
<dd>the arbitrary object associated with the given key to this stream</dd>
<dt>See Also:</dt>
<dd>
<ul class="see-list-long">
<li><a href="#setAttribute(java.lang.String,java.lang.Object)"><code>setAttribute(String, Object)</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="isReset()">
<h3>isReset</h3>
<div class="member-signature"><span class="return-type">boolean</span>&nbsp;<span class="element-name">isReset</span>()</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>whether this stream has been reset</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="isClosed()">
<h3>isClosed</h3>
<div class="member-signature"><span class="return-type">boolean</span>&nbsp;<span class="element-name">isClosed</span>()</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>whether this stream is closed, both locally and remotely.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getIdleTimeout()">
<h3>getIdleTimeout</h3>
<div class="member-signature"><span class="return-type">long</span>&nbsp;<span class="element-name">getIdleTimeout</span>()</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the stream idle timeout</dd>
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="#setIdleTimeout(long)"><code>setIdleTimeout(long)</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setIdleTimeout(long)">
<h3>setIdleTimeout</h3>
<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">setIdleTimeout</span><wbr><span class="parameters">(long&nbsp;idleTimeout)</span></div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>idleTimeout</code> - the stream idle timeout</dd>
<dt>See Also:</dt>
<dd>
<ul class="see-list-long">
<li><a href="#getIdleTimeout()"><code>getIdleTimeout()</code></a></li>
<li><a href="Stream.Listener.html#onIdleTimeout(org.eclipse.jetty.http2.api.Stream,java.lang.Throwable)"><code>Stream.Listener.onIdleTimeout(Stream, Throwable)</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="demand(long)">
<h3>demand</h3>
<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">demand</span><wbr><span class="parameters">(long&nbsp;n)</span></div>
<div class="block"><p>Demands <code>n</code> more <code>DATA</code> frames for this stream.</p></div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>n</code> - the increment of the demand, must be greater than zero</dd>
<dt>See Also:</dt>
<dd>
<ul class="see-list-long">
<li><a href="Stream.Listener.html#onDataDemanded(org.eclipse.jetty.http2.api.Stream,org.eclipse.jetty.http2.frames.DataFrame,org.eclipse.jetty.util.Callback)"><code>Stream.Listener.onDataDemanded(Stream, DataFrame, Callback)</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &#169; 1995&#x2013;2022 <a href="https://webtide.com">Webtide</a>. All rights reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>