| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.11) on Mon Oct 11 11:08:51 CDT 2021 --> |
| <title>IStream (Eclipse Jetty API Doc - v10.0.7)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2021-10-11"> |
| <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="IStream (Eclipse Jetty API Doc - v10.0.7)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/IStream.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</a></div> |
| <h2 title="Interface IStream" class="title">Interface IStream</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><code><a href="../util/Attachable.html" title="interface in org.eclipse.jetty.util">Attachable</a></code>, <code>java.lang.AutoCloseable</code>, <code>java.io.Closeable</code>, <code><a href="api/Stream.html" title="interface in org.eclipse.jetty.http2.api">Stream</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">IStream</span> |
| extends <a href="api/Stream.html" title="interface in org.eclipse.jetty.http2.api">Stream</a>, <a href="../util/Attachable.html" title="interface in org.eclipse.jetty.util">Attachable</a>, java.io.Closeable</pre> |
| <div class="block"><p>The SPI interface for implementing an HTTP/2 stream.</p> |
| <p>This class extends <a href="api/Stream.html" title="interface in org.eclipse.jetty.http2.api"><code>Stream</code></a> by adding the methods required to |
| implement the HTTP/2 stream functionalities.</p></div> |
| </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 class </code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="IStream.FrameList.html" title="class in org.eclipse.jetty.http2">IStream.FrameList</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">An ordered list of frames belonging to the same stream.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="nested.classes.inherited.from.class.org.eclipse.jetty.http2.api.Stream"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from interface org.eclipse.jetty.http2.api.<a href="api/Stream.html" title="interface in org.eclipse.jetty.http2.api">Stream</a></h3> |
| <code><a href="api/Stream.Listener.html" title="interface in org.eclipse.jetty.http2.api">Stream.Listener</a></code></li> |
| </ul> |
| </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></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>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#close()">close</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Forcibly closes this stream.</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="#commit()">commit</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Marks this stream as committed.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#failAllData(java.lang.Throwable)">failAllData</a></span>​(java.lang.Throwable x)</code></th> |
| <td class="colLast"> |
| <div class="block">Fail all data queued in the stream and reset |
| demand to 0.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="api/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="#getListener()">getListener</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="ISession.html" title="interface in org.eclipse.jetty.http2">ISession</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="i5" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isCommitted()">isCommitted</a></span>()</code></th> |
| <td class="colLast"> </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="#isLocal()">isLocal</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isRemotelyClosed()">isRemotelyClosed</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isResetOrFailed()">isResetOrFailed</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#notIdle()">notIdle</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Marks this stream as not idle so that the |
| <a href="api/Stream.html#getIdleTimeout()"><code>idle timeout</code></a> is postponed.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#process(org.eclipse.jetty.http2.frames.Frame,org.eclipse.jetty.util.Callback)">process</a></span>​(<a href="frames/Frame.html" title="class in org.eclipse.jetty.http2.frames">Frame</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">Processes the given <code>frame</code>, belonging to this stream.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#send(org.eclipse.jetty.http2.IStream.FrameList,org.eclipse.jetty.util.Callback)">send</a></span>​(<a href="IStream.FrameList.html" title="class in org.eclipse.jetty.http2">IStream.FrameList</a> frameList, |
| <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 list of frames.</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="#setListener(org.eclipse.jetty.http2.api.Stream.Listener)">setListener</a></span>​(<a href="api/Stream.Listener.html" title="interface in org.eclipse.jetty.http2.api">Stream.Listener</a> listener)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#updateClose(boolean,org.eclipse.jetty.http2.CloseState.Event)">updateClose</a></span>​(boolean update, |
| <a href="CloseState.Event.html" title="enum in org.eclipse.jetty.http2">CloseState.Event</a> event)</code></th> |
| <td class="colLast"> |
| <div class="block">Updates the close state of this stream.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#updateRecvWindow(int)">updateRecvWindow</a></span>​(int delta)</code></th> |
| <td class="colLast"> |
| <div class="block">Updates the stream receive window by the given <code>delta</code>.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#updateSendWindow(int)">updateSendWindow</a></span>​(int delta)</code></th> |
| <td class="colLast"> |
| <div class="block">Updates the stream send window by the given <code>delta</code>.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.eclipse.jetty.util.Attachable"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.eclipse.jetty.util.<a href="../util/Attachable.html" title="interface in org.eclipse.jetty.util">Attachable</a></h3> |
| <code><a href="../util/Attachable.html#getAttachment()">getAttachment</a>, <a href="../util/Attachable.html#setAttachment(java.lang.Object)">setAttachment</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.eclipse.jetty.http2.api.Stream"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.eclipse.jetty.http2.api.<a href="api/Stream.html" title="interface in org.eclipse.jetty.http2.api">Stream</a></h3> |
| <code><a href="api/Stream.html#data(org.eclipse.jetty.http2.frames.DataFrame)">data</a>, <a href="api/Stream.html#data(org.eclipse.jetty.http2.frames.DataFrame,org.eclipse.jetty.util.Callback)">data</a>, <a href="api/Stream.html#demand(long)">demand</a>, <a href="api/Stream.html#getAttribute(java.lang.String)">getAttribute</a>, <a href="api/Stream.html#getId()">getId</a>, <a href="api/Stream.html#getIdleTimeout()">getIdleTimeout</a>, <a href="api/Stream.html#headers(org.eclipse.jetty.http2.frames.HeadersFrame)">headers</a>, <a href="api/Stream.html#headers(org.eclipse.jetty.http2.frames.HeadersFrame,org.eclipse.jetty.util.Callback)">headers</a>, <a href="api/Stream.html#isClosed()">isClosed</a>, <a href="api/Stream.html#isReset()">isReset</a>, <a href="api/Stream.html#push(org.eclipse.jetty.http2.frames.PushPromiseFrame,org.eclipse.jetty.http2.api.Stream.Listener)">push</a>, <a href="api/Stream.html#push(org.eclipse.jetty.http2.frames.PushPromiseFrame,org.eclipse.jetty.util.Promise,org.eclipse.jetty.http2.api.Stream.Listener)">push</a>, <a href="api/Stream.html#removeAttribute(java.lang.String)">removeAttribute</a>, <a href="api/Stream.html#reset(org.eclipse.jetty.http2.frames.ResetFrame,org.eclipse.jetty.util.Callback)">reset</a>, <a href="api/Stream.html#setAttribute(java.lang.String,java.lang.Object)">setAttribute</a>, <a href="api/Stream.html#setIdleTimeout(long)">setIdleTimeout</a></code></li> |
| </ul> |
| </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="isLocal()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isLocal</h4> |
| <pre class="methodSignature">boolean isLocal()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>whether this stream is local or remote</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getSession()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSession</h4> |
| <pre class="methodSignature"><a href="ISession.html" title="interface in org.eclipse.jetty.http2">ISession</a> getSession()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="api/Stream.html#getSession()">getSession</a></code> in interface <code><a href="api/Stream.html" title="interface in org.eclipse.jetty.http2.api">Stream</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the session this stream is associated to</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getListener()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getListener</h4> |
| <pre class="methodSignature"><a href="api/Stream.Listener.html" title="interface in org.eclipse.jetty.http2.api">Stream.Listener</a> getListener()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the <a href="api/Stream.Listener.html" title="interface in org.eclipse.jetty.http2.api"><code>Stream.Listener</code></a> associated with this stream</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#setListener(org.eclipse.jetty.http2.api.Stream.Listener)"><code>setListener(Stream.Listener)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setListener(org.eclipse.jetty.http2.api.Stream.Listener)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setListener</h4> |
| <pre class="methodSignature">void setListener​(<a href="api/Stream.Listener.html" title="interface in org.eclipse.jetty.http2.api">Stream.Listener</a> listener)</pre> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>listener</code> - the <a href="api/Stream.Listener.html" title="interface in org.eclipse.jetty.http2.api"><code>Stream.Listener</code></a> associated with this stream</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#getListener()"><code>getListener()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="send(org.eclipse.jetty.http2.IStream.FrameList,org.eclipse.jetty.util.Callback)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>send</h4> |
| <pre class="methodSignature">void send​(<a href="IStream.FrameList.html" title="class in org.eclipse.jetty.http2">IStream.FrameList</a> frameList, |
| <a href="../util/Callback.html" title="interface in org.eclipse.jetty.util">Callback</a> callback)</pre> |
| <div class="block"><p>Sends the given list of frames.</p> |
| <p>Typically used to send HTTP headers along with content and possibly trailers.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>frameList</code> - the list of frames to send</dd> |
| <dd><code>callback</code> - the callback that gets notified when the frames have been sent</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="process(org.eclipse.jetty.http2.frames.Frame,org.eclipse.jetty.util.Callback)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>process</h4> |
| <pre class="methodSignature">void process​(<a href="frames/Frame.html" title="class in org.eclipse.jetty.http2.frames">Frame</a> frame, |
| <a href="../util/Callback.html" title="interface in org.eclipse.jetty.util">Callback</a> callback)</pre> |
| <div class="block"><p>Processes the given <code>frame</code>, belonging to this stream.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>frame</code> - the frame to process</dd> |
| <dd><code>callback</code> - the callback to complete when frame has been processed</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="updateClose(boolean,org.eclipse.jetty.http2.CloseState.Event)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>updateClose</h4> |
| <pre class="methodSignature">boolean updateClose​(boolean update, |
| <a href="CloseState.Event.html" title="enum in org.eclipse.jetty.http2">CloseState.Event</a> event)</pre> |
| <div class="block"><p>Updates the close state of this stream.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>update</code> - whether to update the close state</dd> |
| <dd><code>event</code> - the event that caused the close state update</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>whether the stream has been fully closed by this invocation</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="close()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>close</h4> |
| <pre class="methodSignature">void close()</pre> |
| <div class="block"><p>Forcibly closes this stream.</p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>close</code> in interface <code>java.lang.AutoCloseable</code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>close</code> in interface <code>java.io.Closeable</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="updateSendWindow(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>updateSendWindow</h4> |
| <pre class="methodSignature">int updateSendWindow​(int delta)</pre> |
| <div class="block"><p>Updates the stream send window by the given <code>delta</code>.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>delta</code> - the delta value (positive or negative) to add to the stream send window</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the previous value of the stream send window</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="updateRecvWindow(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>updateRecvWindow</h4> |
| <pre class="methodSignature">int updateRecvWindow​(int delta)</pre> |
| <div class="block"><p>Updates the stream receive window by the given <code>delta</code>.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>delta</code> - the delta value (positive or negative) to add to the stream receive window</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the previous value of the stream receive window</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="notIdle()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>notIdle</h4> |
| <pre class="methodSignature">void notIdle()</pre> |
| <div class="block"><p>Marks this stream as not idle so that the |
| <a href="api/Stream.html#getIdleTimeout()"><code>idle timeout</code></a> is postponed.</p></div> |
| </li> |
| </ul> |
| <a id="isRemotelyClosed()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isRemotelyClosed</h4> |
| <pre class="methodSignature">boolean isRemotelyClosed()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>whether the stream is closed remotely.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="api/Stream.html#isClosed()"><code>Stream.isClosed()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="failAllData(java.lang.Throwable)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>failAllData</h4> |
| <pre class="methodSignature">boolean failAllData​(java.lang.Throwable x)</pre> |
| <div class="block">Fail all data queued in the stream and reset |
| demand to 0.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>x</code> - the exception to fail the data with.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the end of the stream was reached, false otherwise.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isResetOrFailed()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isResetOrFailed</h4> |
| <pre class="methodSignature">boolean isResetOrFailed()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>whether this stream has been reset (locally or remotely) or has been failed</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="api/Stream.html#isReset()"><code>Stream.isReset()</code></a>, |
| <a href="api/Stream.Listener.html#onFailure(org.eclipse.jetty.http2.api.Stream,int,java.lang.String,java.lang.Throwable,org.eclipse.jetty.util.Callback)"><code>Stream.Listener.onFailure(Stream, int, String, Throwable, Callback)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="commit()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>commit</h4> |
| <pre class="methodSignature">void commit()</pre> |
| <div class="block">Marks this stream as committed.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#isCommitted()"><code>isCommitted()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isCommitted()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>isCommitted</h4> |
| <pre class="methodSignature">boolean isCommitted()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>whether bytes for this stream have been sent to the remote peer.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#commit()"><code>commit()</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/IStream.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> |
