| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) on Thu Sep 15 14:13:16 CDT 2022 --> |
| <title>ISession (Eclipse Jetty API Doc - v11.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, interface: ISession"> |
| <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/ISession.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: </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="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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> <a href="package-summary.html">org.eclipse.jetty.http2</a></div> |
| <h1 title="Interface ISession" class="title">Interface ISession</h1> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Superinterfaces:</dt> |
| <dd><code><a href="api/Session.html" title="interface in org.eclipse.jetty.http2.api">Session</a></code></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="client/HTTP2ClientSession.html" title="class in org.eclipse.jetty.http2.client">HTTP2ClientSession</a></code>, <code><a href="server/HTTP2ServerSession.html" title="class in org.eclipse.jetty.http2.server">HTTP2ServerSession</a></code>, <code><a href="HTTP2Session.html" title="class in org.eclipse.jetty.http2">HTTP2Session</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">ISession</span><span class="extends-implements"> |
| extends <a href="api/Session.html" title="interface in org.eclipse.jetty.http2.api">Session</a></span></div> |
| <div class="block"><p>The SPI interface for implementing an HTTP/2 session.</p> |
| <p>This class extends <a href="api/Session.html" title="interface in org.eclipse.jetty.http2.api"><code>Session</code></a> by adding the methods required to |
| implement the HTTP/2 session functionalities.</p></div> |
| </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="inherited-list"> |
| <h2 id="nested-classes-inherited-from-class-org.eclipse.jetty.http2.api.Session">Nested classes/interfaces inherited from interface org.eclipse.jetty.http2.api.<a href="api/Session.html" title="interface in org.eclipse.jetty.http2.api">Session</a></h2> |
| <code><a href="api/Session.Listener.html" title="interface in org.eclipse.jetty.http2.api">Session.Listener</a></code></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></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-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="#data(org.eclipse.jetty.http2.IStream,org.eclipse.jetty.util.Callback,org.eclipse.jetty.http2.frames.DataFrame)" class="member-name-link">data</a><wbr>(<a href="IStream.html" title="interface in org.eclipse.jetty.http2">IStream</a> stream, |
| <a href="../util/Callback.html" title="interface in org.eclipse.jetty.util">Callback</a> callback, |
| <a href="frames/DataFrame.html" title="class in org.eclipse.jetty.http2.frames">DataFrame</a> frame)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Enqueues the given DATA frame to be written to the connection.</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="#frames(org.eclipse.jetty.http2.IStream,java.util.List,org.eclipse.jetty.util.Callback)" class="member-name-link">frames</a><wbr>(<a href="IStream.html" title="interface in org.eclipse.jetty.http2">IStream</a> stream, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><? extends <a href="frames/Frame.html" title="class in org.eclipse.jetty.http2.frames">Frame</a>> frames, |
| <a href="../util/Callback.html" title="interface in org.eclipse.jetty.util">Callback</a> callback)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Enqueues the given frames to be written to the connection.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>long</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getBytesWritten()" class="member-name-link">getBytesWritten</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="IStream.html" title="interface in org.eclipse.jetty.http2">IStream</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getStream(int)" class="member-name-link">getStream</a><wbr>(int streamId)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Retrieves the stream with the given <code>streamId</code>.</div> |
| </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="#isPushEnabled()" class="member-name-link">isPushEnabled</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </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="#newStream(org.eclipse.jetty.http2.IStream.FrameList,org.eclipse.jetty.util.Promise,org.eclipse.jetty.http2.api.Stream.Listener)" class="member-name-link">newStream</a><wbr>(<a href="IStream.FrameList.html" title="class in org.eclipse.jetty.http2">IStream.FrameList</a> frames, |
| <a href="../util/Promise.html" title="interface in org.eclipse.jetty.util">Promise</a><<a href="api/Stream.html" title="interface in org.eclipse.jetty.http2.api">Stream</a>> promise, |
| <a href="api/Stream.Listener.html" title="interface in org.eclipse.jetty.http2.api">Stream.Listener</a> listener)</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 list of frames to create a new <a href="api/Stream.html" title="interface in org.eclipse.jetty.http2.api"><code>Stream</code></a>.</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="#onData(org.eclipse.jetty.http2.frames.DataFrame,org.eclipse.jetty.util.Callback)" class="member-name-link">onData</a><wbr>(<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></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Callback method invoked when a DATA frame is received.</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="#onFlushed(long)" class="member-name-link">onFlushed</a><wbr>(long bytes)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Callback method invoked when bytes are flushed to the network.</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="#onFrame(org.eclipse.jetty.http2.frames.Frame)" class="member-name-link">onFrame</a><wbr>(<a href="frames/Frame.html" title="class in org.eclipse.jetty.http2.frames">Frame</a> frame)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Callback method invoked during an HTTP/1.1 to HTTP/2 upgrade requests |
| to process the given synthetic frame.</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="#onIdleTimeout()" class="member-name-link">onIdleTimeout</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Callback invoked when the idle timeout expires.</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="#onShutdown()" class="member-name-link">onShutdown</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Callback invoked when the connection reads -1.</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="#onWindowUpdate(org.eclipse.jetty.http2.IStream,org.eclipse.jetty.http2.frames.WindowUpdateFrame)" class="member-name-link">onWindowUpdate</a><wbr>(<a href="IStream.html" title="interface in org.eclipse.jetty.http2">IStream</a> stream, |
| <a href="frames/WindowUpdateFrame.html" title="class in org.eclipse.jetty.http2.frames">WindowUpdateFrame</a> frame)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Callback method invoked when a WINDOW_UPDATE frame has been received.</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.IStream,org.eclipse.jetty.util.Promise,org.eclipse.jetty.http2.frames.PushPromiseFrame,org.eclipse.jetty.http2.api.Stream.Listener)" class="member-name-link">push</a><wbr>(<a href="IStream.html" title="interface in org.eclipse.jetty.http2">IStream</a> stream, |
| <a href="../util/Promise.html" title="interface in org.eclipse.jetty.util">Promise</a><<a href="api/Stream.html" title="interface in org.eclipse.jetty.http2.api">Stream</a>> promise, |
| <a href="frames/PushPromiseFrame.html" title="class in org.eclipse.jetty.http2.frames">PushPromiseFrame</a> frame, |
| <a href="api/Stream.Listener.html" title="interface in org.eclipse.jetty.http2.api">Stream.Listener</a> listener)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Enqueues the given PUSH_PROMISE frame to be written to the connection.</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="#removeStream(org.eclipse.jetty.http2.IStream)" class="member-name-link">removeStream</a><wbr>(<a href="IStream.html" title="interface in org.eclipse.jetty.http2">IStream</a> stream)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Removes the given <code>stream</code>.</div> |
| </div> |
| <div class="col-first even-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/util/concurrent/CompletableFuture.html" title="class or interface in java.util.concurrent" class="external-link">CompletableFuture</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Void.html" title="class or interface in java.lang" class="external-link">Void</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#shutdown()" class="member-name-link">shutdown</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Gracefully closes the session, returning a <code>CompletableFuture</code> that |
| is completed when all the streams currently being processed are completed.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#updateRecvWindow(int)" class="member-name-link">updateRecvWindow</a><wbr>(int delta)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Updates the session receive window by the given <code>delta</code>.</div> |
| </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="#updateSendWindow(int)" class="member-name-link">updateSendWindow</a><wbr>(int delta)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Updates the session send window by the given <code>delta</code>.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.eclipse.jetty.http2.api.Session">Methods inherited from interface org.eclipse.jetty.http2.api.<a href="api/Session.html" title="interface in org.eclipse.jetty.http2.api">Session</a></h3> |
| <code><a href="api/Session.html#close(int,java.lang.String,org.eclipse.jetty.util.Callback)">close</a>, <a href="api/Session.html#getLocalAddress()">getLocalAddress</a>, <a href="api/Session.html#getLocalSocketAddress()">getLocalSocketAddress</a>, <a href="api/Session.html#getRemoteAddress()">getRemoteAddress</a>, <a href="api/Session.html#getRemoteSocketAddress()">getRemoteSocketAddress</a>, <a href="api/Session.html#getStreams()">getStreams</a>, <a href="api/Session.html#isClosed()">isClosed</a>, <a href="api/Session.html#newStream(org.eclipse.jetty.http2.frames.HeadersFrame,org.eclipse.jetty.http2.api.Stream.Listener)">newStream</a>, <a href="api/Session.html#newStream(org.eclipse.jetty.http2.frames.HeadersFrame,org.eclipse.jetty.util.Promise,org.eclipse.jetty.http2.api.Stream.Listener)">newStream</a>, <a href="api/Session.html#ping(org.eclipse.jetty.http2.frames.PingFrame,org.eclipse.jetty.util.Callback)">ping</a>, <a href="api/Session.html#priority(org.eclipse.jetty.http2.frames.PriorityFrame,org.eclipse.jetty.util.Callback)">priority</a>, <a href="api/Session.html#settings(org.eclipse.jetty.http2.frames.SettingsFrame,org.eclipse.jetty.util.Callback)">settings</a></code></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="getStream(int)"> |
| <h3>getStream</h3> |
| <div class="member-signature"><span class="return-type"><a href="IStream.html" title="interface in org.eclipse.jetty.http2">IStream</a></span> <span class="element-name">getStream</span><wbr><span class="parameters">(int streamId)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="api/Session.html#getStream(int)">Session</a></code></span></div> |
| <div class="block"><p>Retrieves the stream with the given <code>streamId</code>.</p></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="api/Session.html#getStream(int)">getStream</a></code> in interface <code><a href="api/Session.html" title="interface in org.eclipse.jetty.http2.api">Session</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>streamId</code> - the stream id of the stream looked for</dd> |
| <dt>Returns:</dt> |
| <dd>the stream with the given id, or null if no such stream exist</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="removeStream(org.eclipse.jetty.http2.IStream)"> |
| <h3>removeStream</h3> |
| <div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">removeStream</span><wbr><span class="parameters">(<a href="IStream.html" title="interface in org.eclipse.jetty.http2">IStream</a> stream)</span></div> |
| <div class="block"><p>Removes the given <code>stream</code>.</p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>stream</code> - the stream to remove</dd> |
| <dt>Returns:</dt> |
| <dd>whether the stream was removed</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="newStream(org.eclipse.jetty.http2.IStream.FrameList,org.eclipse.jetty.util.Promise,org.eclipse.jetty.http2.api.Stream.Listener)"> |
| <h3>newStream</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">newStream</span><wbr><span class="parameters">(<a href="IStream.FrameList.html" title="class in org.eclipse.jetty.http2">IStream.FrameList</a> frames, |
| <a href="../util/Promise.html" title="interface in org.eclipse.jetty.util">Promise</a><<a href="api/Stream.html" title="interface in org.eclipse.jetty.http2.api">Stream</a>> promise, |
| <a href="api/Stream.Listener.html" title="interface in org.eclipse.jetty.http2.api">Stream.Listener</a> listener)</span></div> |
| <div class="block"><p>Sends the given list of frames to create a new <a href="api/Stream.html" title="interface in org.eclipse.jetty.http2.api"><code>Stream</code></a>.</p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>frames</code> - the list of frames to send</dd> |
| <dd><code>promise</code> - the promise that gets notified of the stream creation</dd> |
| <dd><code>listener</code> - the listener that gets notified of stream events</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="frames(org.eclipse.jetty.http2.IStream,java.util.List,org.eclipse.jetty.util.Callback)"> |
| <h3>frames</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">frames</span><wbr><span class="parameters">(<a href="IStream.html" title="interface in org.eclipse.jetty.http2">IStream</a> stream, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><? extends <a href="frames/Frame.html" title="class in org.eclipse.jetty.http2.frames">Frame</a>> frames, |
| <a href="../util/Callback.html" title="interface in org.eclipse.jetty.util">Callback</a> callback)</span></div> |
| <div class="block"><p>Enqueues the given frames to be written to the connection.</p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>stream</code> - the stream the frames belong to</dd> |
| <dd><code>frames</code> - the frames to enqueue</dd> |
| <dd><code>callback</code> - the callback that gets notified when the frames have been sent</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="push(org.eclipse.jetty.http2.IStream,org.eclipse.jetty.util.Promise,org.eclipse.jetty.http2.frames.PushPromiseFrame,org.eclipse.jetty.http2.api.Stream.Listener)"> |
| <h3>push</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">push</span><wbr><span class="parameters">(<a href="IStream.html" title="interface in org.eclipse.jetty.http2">IStream</a> stream, |
| <a href="../util/Promise.html" title="interface in org.eclipse.jetty.util">Promise</a><<a href="api/Stream.html" title="interface in org.eclipse.jetty.http2.api">Stream</a>> promise, |
| <a href="frames/PushPromiseFrame.html" title="class in org.eclipse.jetty.http2.frames">PushPromiseFrame</a> frame, |
| <a href="api/Stream.Listener.html" title="interface in org.eclipse.jetty.http2.api">Stream.Listener</a> listener)</span></div> |
| <div class="block"><p>Enqueues the given PUSH_PROMISE frame to be written to the connection.</p> |
| <p>Differently from <a href="#frames(org.eclipse.jetty.http2.IStream,java.util.List,org.eclipse.jetty.util.Callback)"><code>frames(IStream, List, Callback)</code></a>, this method |
| generates atomically the stream id for the pushed stream.</p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>stream</code> - the stream associated to the pushed stream</dd> |
| <dd><code>promise</code> - the promise that gets notified of the pushed stream creation</dd> |
| <dd><code>frame</code> - the PUSH_PROMISE frame to enqueue</dd> |
| <dd><code>listener</code> - the listener that gets notified of pushed stream events</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="data(org.eclipse.jetty.http2.IStream,org.eclipse.jetty.util.Callback,org.eclipse.jetty.http2.frames.DataFrame)"> |
| <h3>data</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">data</span><wbr><span class="parameters">(<a href="IStream.html" title="interface in org.eclipse.jetty.http2">IStream</a> stream, |
| <a href="../util/Callback.html" title="interface in org.eclipse.jetty.util">Callback</a> callback, |
| <a href="frames/DataFrame.html" title="class in org.eclipse.jetty.http2.frames">DataFrame</a> frame)</span></div> |
| <div class="block"><p>Enqueues the given DATA frame to be written to the connection.</p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>stream</code> - the stream the data frame belongs to</dd> |
| <dd><code>callback</code> - the callback that gets notified when the frame has been sent</dd> |
| <dd><code>frame</code> - the DATA frame to send</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="updateSendWindow(int)"> |
| <h3>updateSendWindow</h3> |
| <div class="member-signature"><span class="return-type">int</span> <span class="element-name">updateSendWindow</span><wbr><span class="parameters">(int delta)</span></div> |
| <div class="block"><p>Updates the session send window by the given <code>delta</code>.</p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>delta</code> - the delta value (positive or negative) to add to the session send window</dd> |
| <dt>Returns:</dt> |
| <dd>the previous value of the session send window</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="updateRecvWindow(int)"> |
| <h3>updateRecvWindow</h3> |
| <div class="member-signature"><span class="return-type">int</span> <span class="element-name">updateRecvWindow</span><wbr><span class="parameters">(int delta)</span></div> |
| <div class="block"><p>Updates the session receive window by the given <code>delta</code>.</p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>delta</code> - the delta value (positive or negative) to add to the session receive window</dd> |
| <dt>Returns:</dt> |
| <dd>the previous value of the session receive window</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="onWindowUpdate(org.eclipse.jetty.http2.IStream,org.eclipse.jetty.http2.frames.WindowUpdateFrame)"> |
| <h3>onWindowUpdate</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">onWindowUpdate</span><wbr><span class="parameters">(<a href="IStream.html" title="interface in org.eclipse.jetty.http2">IStream</a> stream, |
| <a href="frames/WindowUpdateFrame.html" title="class in org.eclipse.jetty.http2.frames">WindowUpdateFrame</a> frame)</span></div> |
| <div class="block"><p>Callback method invoked when a WINDOW_UPDATE frame has been received.</p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>stream</code> - the stream the window update belongs to, or null if the window update belongs to the session</dd> |
| <dd><code>frame</code> - the WINDOW_UPDATE frame received</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isPushEnabled()"> |
| <h3>isPushEnabled</h3> |
| <div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">isPushEnabled</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>whether the push functionality is enabled</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="onShutdown()"> |
| <h3>onShutdown</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">onShutdown</span>()</div> |
| <div class="block"><p>Callback invoked when the connection reads -1.</p></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list-long"> |
| <li><a href="#onIdleTimeout()"><code>onIdleTimeout()</code></a></li> |
| <li><a href="api/Session.html#close(int,java.lang.String,org.eclipse.jetty.util.Callback)"><code>Session.close(int, String, Callback)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="onIdleTimeout()"> |
| <h3>onIdleTimeout</h3> |
| <div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">onIdleTimeout</span>()</div> |
| <div class="block"><p>Callback invoked when the idle timeout expires.</p></div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd><code>true</code> if the session has expired</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list-long"> |
| <li><a href="#onShutdown()"><code>onShutdown()</code></a></li> |
| <li><a href="api/Session.html#close(int,java.lang.String,org.eclipse.jetty.util.Callback)"><code>Session.close(int, String, Callback)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="onFrame(org.eclipse.jetty.http2.frames.Frame)"> |
| <h3>onFrame</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">onFrame</span><wbr><span class="parameters">(<a href="frames/Frame.html" title="class in org.eclipse.jetty.http2.frames">Frame</a> frame)</span></div> |
| <div class="block"><p>Callback method invoked during an HTTP/1.1 to HTTP/2 upgrade requests |
| to process the given synthetic frame.</p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>frame</code> - the synthetic frame to process</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="onFlushed(long)"> |
| <h3>onFlushed</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">onFlushed</span><wbr><span class="parameters">(long bytes)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block"><p>Callback method invoked when bytes are flushed to the network.</p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>bytes</code> - the number of bytes flushed to the network</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - if the flush should fail</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getBytesWritten()"> |
| <h3>getBytesWritten</h3> |
| <div class="member-signature"><span class="return-type">long</span> <span class="element-name">getBytesWritten</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the number of bytes written by this session</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="onData(org.eclipse.jetty.http2.frames.DataFrame,org.eclipse.jetty.util.Callback)"> |
| <h3>onData</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">onData</span><wbr><span class="parameters">(<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)</span></div> |
| <div class="block"><p>Callback method invoked when a DATA frame is received.</p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>frame</code> - the DATA frame received</dd> |
| <dd><code>callback</code> - the callback to notify when the frame has been processed</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="shutdown()"> |
| <h3>shutdown</h3> |
| <div class="member-signature"><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><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Void.html" title="class or interface in java.lang" class="external-link">Void</a>></span> <span class="element-name">shutdown</span>()</div> |
| <div class="block"><p>Gracefully closes the session, returning a <code>CompletableFuture</code> that |
| is completed when all the streams currently being processed are completed.</p> |
| <p>Implementation is idempotent, i.e. calling this method a second time |
| or concurrently results in a no-operation.</p></div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>a <code>CompletableFuture</code> that is completed when all the streams are completed</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 1995–2022 <a href="https://webtide.com">Webtide</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
