| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.11) on Wed Jul 07 10:55:45 EDT 2021 --> |
| <title>Stream (Eclipse Jetty API Doc - v10.0.6)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2021-07-07"> |
| <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 (Eclipse Jetty API Doc - v10.0.6)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":18,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":18,"i8":6,"i9":6,"i10":6,"i11":18,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6}; |
| 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.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 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: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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"> </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> <a href="package-summary.html">org.eclipse.jetty.http2.api</a></div> |
| <h2 title="Interface Stream" class="title">Interface Stream</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Subinterfaces:</dt> |
| <dd><code><a href="../IStream.html" title="interface in org.eclipse.jetty.http2">IStream</a></code></dd> |
| </dl> |
| <dl> |
| <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> |
| <pre>public interface <span class="typeNameLabel">Stream</span></pre> |
| <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> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="Stream.Listener.html" title="interface in org.eclipse.jetty.http2.api"><code>Stream.Listener</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"> </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 interface </code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="Stream.Listener.html" title="interface in org.eclipse.jetty.http2.api">Stream.Listener</a></span></code></th> |
| <td class="colLast"> |
| <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> |
| </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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default Methods</a></span><span class="tabEnd"> </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 java.util.concurrent.CompletableFuture<<a href="Stream.html" title="interface in org.eclipse.jetty.http2.api">Stream</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#data(org.eclipse.jetty.http2.frames.DataFrame)">data</a></span>​(<a href="../frames/DataFrame.html" title="class in org.eclipse.jetty.http2.frames">DataFrame</a> frame)</code></th> |
| <td class="colLast"> |
| <div class="block">Sends the given DATA <code>frame</code>.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#data(org.eclipse.jetty.http2.frames.DataFrame,org.eclipse.jetty.util.Callback)">data</a></span>​(<a href="../frames/DataFrame.html" title="class in org.eclipse.jetty.http2.frames">DataFrame</a> frame, |
| <a href="../../util/Callback.html" title="interface in org.eclipse.jetty.util">Callback</a> callback)</code></th> |
| <td class="colLast"> |
| <div class="block">Sends the given DATA <code>frame</code>.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#demand(long)">demand</a></span>​(long n)</code></th> |
| <td class="colLast"> |
| <div class="block">Demands <code>n</code> more <code>DATA</code> frames for this stream.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>java.lang.Object</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAttribute(java.lang.String)">getAttribute</a></span>​(java.lang.String key)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getId()">getId</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getIdleTimeout()">getIdleTimeout</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="Session.html" title="interface in org.eclipse.jetty.http2.api">Session</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSession()">getSession</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>default java.util.concurrent.CompletableFuture<<a href="Stream.html" title="interface in org.eclipse.jetty.http2.api">Stream</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#headers(org.eclipse.jetty.http2.frames.HeadersFrame)">headers</a></span>​(<a href="../frames/HeadersFrame.html" title="class in org.eclipse.jetty.http2.frames">HeadersFrame</a> frame)</code></th> |
| <td class="colLast"> |
| <div class="block">Sends the given HEADERS <code>frame</code> representing an HTTP response.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#headers(org.eclipse.jetty.http2.frames.HeadersFrame,org.eclipse.jetty.util.Callback)">headers</a></span>​(<a href="../frames/HeadersFrame.html" title="class in org.eclipse.jetty.http2.frames">HeadersFrame</a> frame, |
| <a href="../../util/Callback.html" title="interface in org.eclipse.jetty.util">Callback</a> callback)</code></th> |
| <td class="colLast"> |
| <div class="block">Sends the given HEADERS <code>frame</code>.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isClosed()">isClosed</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isReset()">isReset</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>default java.util.concurrent.CompletableFuture<<a href="Stream.html" title="interface in org.eclipse.jetty.http2.api">Stream</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#push(org.eclipse.jetty.http2.frames.PushPromiseFrame,org.eclipse.jetty.http2.api.Stream.Listener)">push</a></span>​(<a href="../frames/PushPromiseFrame.html" title="class in org.eclipse.jetty.http2.frames">PushPromiseFrame</a> frame, |
| <a href="Stream.Listener.html" title="interface in org.eclipse.jetty.http2.api">Stream.Listener</a> listener)</code></th> |
| <td class="colLast"> |
| <div class="block">Sends the given PUSH_PROMISE <code>frame</code>.</div> |
| </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="#push(org.eclipse.jetty.http2.frames.PushPromiseFrame,org.eclipse.jetty.util.Promise,org.eclipse.jetty.http2.api.Stream.Listener)">push</a></span>​(<a href="../frames/PushPromiseFrame.html" title="class in org.eclipse.jetty.http2.frames">PushPromiseFrame</a> frame, |
| <a href="../../util/Promise.html" title="interface in org.eclipse.jetty.util">Promise</a><<a href="Stream.html" title="interface in org.eclipse.jetty.http2.api">Stream</a>> promise, |
| <a href="Stream.Listener.html" title="interface in org.eclipse.jetty.http2.api">Stream.Listener</a> listener)</code></th> |
| <td class="colLast"> |
| <div class="block">Sends the given PUSH_PROMISE <code>frame</code>.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>java.lang.Object</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeAttribute(java.lang.String)">removeAttribute</a></span>​(java.lang.String key)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#reset(org.eclipse.jetty.http2.frames.ResetFrame,org.eclipse.jetty.util.Callback)">reset</a></span>​(<a href="../frames/ResetFrame.html" title="class in org.eclipse.jetty.http2.frames">ResetFrame</a> frame, |
| <a href="../../util/Callback.html" title="interface in org.eclipse.jetty.util">Callback</a> callback)</code></th> |
| <td class="colLast"> |
| <div class="block">Sends the given RST_STREAM <code>frame</code>.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setAttribute(java.lang.String,java.lang.Object)">setAttribute</a></span>​(java.lang.String key, |
| java.lang.Object value)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setIdleTimeout(long)">setIdleTimeout</a></span>​(long idleTimeout)</code></th> |
| <td class="colLast"> </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="getId()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getId</h4> |
| <pre class="methodSignature">int getId()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the stream unique id</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getSession()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSession</h4> |
| <pre class="methodSignature"><a href="Session.html" title="interface in org.eclipse.jetty.http2.api">Session</a> getSession()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the session this stream is associated to</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="headers(org.eclipse.jetty.http2.frames.HeadersFrame)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>headers</h4> |
| <pre class="methodSignature">default java.util.concurrent.CompletableFuture<<a href="Stream.html" title="interface in org.eclipse.jetty.http2.api">Stream</a>> headers​(<a href="../frames/HeadersFrame.html" title="class in org.eclipse.jetty.http2.frames">HeadersFrame</a> frame)</pre> |
| <div class="block"><p>Sends the given HEADERS <code>frame</code> representing an HTTP response.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>frame</code> - the HEADERS frame to send</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the CompletableFuture that gets notified when the frame has been sent</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="headers(org.eclipse.jetty.http2.frames.HeadersFrame,org.eclipse.jetty.util.Callback)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>headers</h4> |
| <pre class="methodSignature">void headers​(<a href="../frames/HeadersFrame.html" title="class in org.eclipse.jetty.http2.frames">HeadersFrame</a> frame, |
| <a href="../../util/Callback.html" title="interface in org.eclipse.jetty.util">Callback</a> callback)</pre> |
| <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> |
| <dt><span class="paramLabel">Parameters:</span></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> |
| </li> |
| </ul> |
| <a id="push(org.eclipse.jetty.http2.frames.PushPromiseFrame,org.eclipse.jetty.http2.api.Stream.Listener)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>push</h4> |
| <pre class="methodSignature">default java.util.concurrent.CompletableFuture<<a href="Stream.html" title="interface in org.eclipse.jetty.http2.api">Stream</a>> push​(<a href="../frames/PushPromiseFrame.html" title="class in org.eclipse.jetty.http2.frames">PushPromiseFrame</a> frame, |
| <a href="Stream.Listener.html" title="interface in org.eclipse.jetty.http2.api">Stream.Listener</a> listener)</pre> |
| <div class="block"><p>Sends the given PUSH_PROMISE <code>frame</code>.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></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><span class="returnLabel">Returns:</span></dt> |
| <dd>the CompletableFuture that gets notified of the pushed stream creation</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="push(org.eclipse.jetty.http2.frames.PushPromiseFrame,org.eclipse.jetty.util.Promise,org.eclipse.jetty.http2.api.Stream.Listener)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>push</h4> |
| <pre class="methodSignature">void push​(<a href="../frames/PushPromiseFrame.html" title="class in org.eclipse.jetty.http2.frames">PushPromiseFrame</a> frame, |
| <a href="../../util/Promise.html" title="interface in org.eclipse.jetty.util">Promise</a><<a href="Stream.html" title="interface in org.eclipse.jetty.http2.api">Stream</a>> promise, |
| <a href="Stream.Listener.html" title="interface in org.eclipse.jetty.http2.api">Stream.Listener</a> listener)</pre> |
| <div class="block"><p>Sends the given PUSH_PROMISE <code>frame</code>.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></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> |
| </li> |
| </ul> |
| <a id="data(org.eclipse.jetty.http2.frames.DataFrame)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>data</h4> |
| <pre class="methodSignature">default java.util.concurrent.CompletableFuture<<a href="Stream.html" title="interface in org.eclipse.jetty.http2.api">Stream</a>> data​(<a href="../frames/DataFrame.html" title="class in org.eclipse.jetty.http2.frames">DataFrame</a> frame)</pre> |
| <div class="block"><p>Sends the given DATA <code>frame</code>.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>frame</code> - the DATA frame to send</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the CompletableFuture that gets notified when the frame has been sent</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="data(org.eclipse.jetty.http2.frames.DataFrame,org.eclipse.jetty.util.Callback)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>data</h4> |
| <pre class="methodSignature">void data​(<a href="../frames/DataFrame.html" title="class in org.eclipse.jetty.http2.frames">DataFrame</a> frame, |
| <a href="../../util/Callback.html" title="interface in org.eclipse.jetty.util">Callback</a> callback)</pre> |
| <div class="block"><p>Sends the given DATA <code>frame</code>.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></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> |
| </li> |
| </ul> |
| <a id="reset(org.eclipse.jetty.http2.frames.ResetFrame,org.eclipse.jetty.util.Callback)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>reset</h4> |
| <pre class="methodSignature">void reset​(<a href="../frames/ResetFrame.html" title="class in org.eclipse.jetty.http2.frames">ResetFrame</a> frame, |
| <a href="../../util/Callback.html" title="interface in org.eclipse.jetty.util">Callback</a> callback)</pre> |
| <div class="block"><p>Sends the given RST_STREAM <code>frame</code>.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></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> |
| </li> |
| </ul> |
| <a id="getAttribute(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAttribute</h4> |
| <pre class="methodSignature">java.lang.Object getAttribute​(java.lang.String key)</pre> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - the attribute key</dd> |
| <dt><span class="returnLabel">Returns:</span></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><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#setAttribute(java.lang.String,java.lang.Object)"><code>setAttribute(String, Object)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setAttribute(java.lang.String,java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setAttribute</h4> |
| <pre class="methodSignature">void setAttribute​(java.lang.String key, |
| java.lang.Object value)</pre> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></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><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#getAttribute(java.lang.String)"><code>getAttribute(String)</code></a>, |
| <a href="#removeAttribute(java.lang.String)"><code>removeAttribute(String)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="removeAttribute(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeAttribute</h4> |
| <pre class="methodSignature">java.lang.Object removeAttribute​(java.lang.String key)</pre> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - the attribute key</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the arbitrary object associated with the given key to this stream</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#setAttribute(java.lang.String,java.lang.Object)"><code>setAttribute(String, Object)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isReset()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isReset</h4> |
| <pre class="methodSignature">boolean isReset()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>whether this stream has been reset</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isClosed()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isClosed</h4> |
| <pre class="methodSignature">boolean isClosed()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>whether this stream is closed, both locally and remotely.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getIdleTimeout()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getIdleTimeout</h4> |
| <pre class="methodSignature">long getIdleTimeout()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the stream idle timeout</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#setIdleTimeout(long)"><code>setIdleTimeout(long)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setIdleTimeout(long)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setIdleTimeout</h4> |
| <pre class="methodSignature">void setIdleTimeout​(long idleTimeout)</pre> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>idleTimeout</code> - the stream idle timeout</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#getIdleTimeout()"><code>getIdleTimeout()</code></a>, |
| <a href="Stream.Listener.html#onIdleTimeout(org.eclipse.jetty.http2.api.Stream,java.lang.Throwable)"><code>Stream.Listener.onIdleTimeout(Stream, Throwable)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="demand(long)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>demand</h4> |
| <pre class="methodSignature">void demand​(long n)</pre> |
| <div class="block"><p>Demands <code>n</code> more <code>DATA</code> frames for this stream.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>n</code> - the increment of the demand, must be greater than zero</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><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></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.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 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: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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 © 1995–2021 <a href="https://webtide.com">Webtide</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |