| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.11) on Mon Oct 11 11:08:51 CDT 2021 --> |
| <title>Session (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="Session (Eclipse Jetty API Doc - v10.0.7)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":6,"i1":38,"i2":18,"i3":38,"i4":18,"i5":6,"i6":6,"i7":6,"i8":18,"i9":6,"i10":6,"i11":6,"i12":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default Methods"],32:["t6","Deprecated 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/Session.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 Session" class="title">Interface Session</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Subinterfaces:</dt> |
| <dd><code><a href="../ISession.html" title="interface in org.eclipse.jetty.http2">ISession</a></code></dd> |
| </dl> |
| <dl> |
| <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> |
| <pre>public interface <span class="typeNameLabel">Session</span></pre> |
| <div class="block"><p>A <a href="Session.html" title="interface in org.eclipse.jetty.http2.api"><code>Session</code></a> represents the client-side endpoint of an HTTP/2 connection to a single origin server.</p> |
| <p>Once a <a href="Session.html" title="interface in org.eclipse.jetty.http2.api"><code>Session</code></a> has been obtained, it can be used to open HTTP/2 streams:</p> |
| <pre> |
| Session session = ...; |
| HeadersFrame frame = ...; |
| Promise<Stream> promise = ... |
| session.newStream(frame, promise, new Stream.Listener.Adapter() |
| { |
| public void onHeaders(Stream stream, HeadersFrame frame) |
| { |
| // Reply received |
| } |
| }); |
| </pre> |
| <p>A <a href="Session.html" title="interface in org.eclipse.jetty.http2.api"><code>Session</code></a> is the active part of the endpoint, and by calling its API applications can generate |
| events on the connection; conversely <a href="Session.Listener.html" title="interface in org.eclipse.jetty.http2.api"><code>Session.Listener</code></a> is the passive part of the endpoint, and |
| has callbacks that are invoked when events happen on the connection.</p></div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="Session.Listener.html" title="interface in org.eclipse.jetty.http2.api"><code>Session.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="Session.Listener.html" title="interface in org.eclipse.jetty.http2.api">Session.Listener</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">A <a href="Session.Listener.html" title="interface in org.eclipse.jetty.http2.api"><code>Session.Listener</code></a> is the passive counterpart of a <a href="Session.html" title="interface in org.eclipse.jetty.http2.api"><code>Session</code></a> and |
| receives events happening on an HTTP/2 connection.</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><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated 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>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#close(int,java.lang.String,org.eclipse.jetty.util.Callback)">close</a></span>​(int error, |
| java.lang.String payload, |
| <a href="../../util/Callback.html" title="interface in org.eclipse.jetty.util">Callback</a> callback)</code></th> |
| <td class="colLast"> |
| <div class="block">Closes the session by sending a GOAWAY frame with the given error code |
| and payload.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>java.net.InetSocketAddress</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLocalAddress()">getLocalAddress</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">use <a href="#getLocalSocketAddress()"><code>getLocalSocketAddress()</code></a> instead</div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>default java.net.SocketAddress</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLocalSocketAddress()">getLocalSocketAddress</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>java.net.InetSocketAddress</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRemoteAddress()">getRemoteAddress</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">use <a href="#getRemoteSocketAddress()"><code>getRemoteSocketAddress()</code></a> instead</div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>default java.net.SocketAddress</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRemoteSocketAddress()">getRemoteSocketAddress</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><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="#getStream(int)">getStream</a></span>​(int streamId)</code></th> |
| <td class="colLast"> |
| <div class="block">Retrieves the stream with the given <code>streamId</code>.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>java.util.Collection<<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="#getStreams()">getStreams</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="#isClosed()">isClosed</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i8" 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="#newStream(org.eclipse.jetty.http2.frames.HeadersFrame,org.eclipse.jetty.http2.api.Stream.Listener)">newStream</a></span>​(<a href="../frames/HeadersFrame.html" title="class in org.eclipse.jetty.http2.frames">HeadersFrame</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 HEADERS <code>frame</code> to create a new <a href="Stream.html" title="interface in org.eclipse.jetty.http2.api"><code>Stream</code></a>.</div> |
| </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="#newStream(org.eclipse.jetty.http2.frames.HeadersFrame,org.eclipse.jetty.util.Promise,org.eclipse.jetty.http2.api.Stream.Listener)">newStream</a></span>​(<a href="../frames/HeadersFrame.html" title="class in org.eclipse.jetty.http2.frames">HeadersFrame</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 HEADERS <code>frame</code> to create a new <a href="Stream.html" title="interface in org.eclipse.jetty.http2.api"><code>Stream</code></a>.</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="#ping(org.eclipse.jetty.http2.frames.PingFrame,org.eclipse.jetty.util.Callback)">ping</a></span>​(<a href="../frames/PingFrame.html" title="class in org.eclipse.jetty.http2.frames">PingFrame</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 PING <code>frame</code>.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#priority(org.eclipse.jetty.http2.frames.PriorityFrame,org.eclipse.jetty.util.Callback)">priority</a></span>​(<a href="../frames/PriorityFrame.html" title="class in org.eclipse.jetty.http2.frames">PriorityFrame</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 PRIORITY <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="#settings(org.eclipse.jetty.http2.frames.SettingsFrame,org.eclipse.jetty.util.Callback)">settings</a></span>​(<a href="../frames/SettingsFrame.html" title="class in org.eclipse.jetty.http2.frames">SettingsFrame</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 SETTINGS <code>frame</code> to configure the session.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="newStream(org.eclipse.jetty.http2.frames.HeadersFrame,org.eclipse.jetty.http2.api.Stream.Listener)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newStream</h4> |
| <pre class="methodSignature">default java.util.concurrent.CompletableFuture<<a href="Stream.html" title="interface in org.eclipse.jetty.http2.api">Stream</a>> newStream​(<a href="../frames/HeadersFrame.html" title="class in org.eclipse.jetty.http2.frames">HeadersFrame</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 HEADERS <code>frame</code> to create a new <a href="Stream.html" title="interface in org.eclipse.jetty.http2.api"><code>Stream</code></a>.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>frame</code> - the HEADERS frame containing the HTTP headers</dd> |
| <dd><code>listener</code> - the listener that gets notified of stream events</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a CompletableFuture that is notified of the stream creation</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="newStream(org.eclipse.jetty.http2.frames.HeadersFrame,org.eclipse.jetty.util.Promise,org.eclipse.jetty.http2.api.Stream.Listener)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newStream</h4> |
| <pre class="methodSignature">void newStream​(<a href="../frames/HeadersFrame.html" title="class in org.eclipse.jetty.http2.frames">HeadersFrame</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 HEADERS <code>frame</code> to create a new <a href="Stream.html" title="interface in org.eclipse.jetty.http2.api"><code>Stream</code></a>.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>frame</code> - the HEADERS frame containing the HTTP headers</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> |
| </li> |
| </ul> |
| <a id="priority(org.eclipse.jetty.http2.frames.PriorityFrame,org.eclipse.jetty.util.Callback)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>priority</h4> |
| <pre class="methodSignature">int priority​(<a href="../frames/PriorityFrame.html" title="class in org.eclipse.jetty.http2.frames">PriorityFrame</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 PRIORITY <code>frame</code>.</p> |
| <p>If the <code>frame</code> references a <code>streamId</code> that does not exist |
| (for example <code>0</code>), then a new <code>streamId</code> will be allocated, to |
| support <em>unused anchor streams</em> that act as parent for other streams.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>frame</code> - the PRIORITY frame to send</dd> |
| <dd><code>callback</code> - the callback that gets notified when the frame has been sent</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the new stream id generated by the PRIORITY frame, or the stream id |
| that it is already referencing</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="settings(org.eclipse.jetty.http2.frames.SettingsFrame,org.eclipse.jetty.util.Callback)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>settings</h4> |
| <pre class="methodSignature">void settings​(<a href="../frames/SettingsFrame.html" title="class in org.eclipse.jetty.http2.frames">SettingsFrame</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 SETTINGS <code>frame</code> to configure the session.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>frame</code> - the SETTINGS 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="ping(org.eclipse.jetty.http2.frames.PingFrame,org.eclipse.jetty.util.Callback)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ping</h4> |
| <pre class="methodSignature">void ping​(<a href="../frames/PingFrame.html" title="class in org.eclipse.jetty.http2.frames">PingFrame</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 PING <code>frame</code>.</p> |
| <p>PING frames may be used to test the connection integrity and to measure |
| round-trip time.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>frame</code> - the PING 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="close(int,java.lang.String,org.eclipse.jetty.util.Callback)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>close</h4> |
| <pre class="methodSignature">boolean close​(int error, |
| java.lang.String payload, |
| <a href="../../util/Callback.html" title="interface in org.eclipse.jetty.util">Callback</a> callback)</pre> |
| <div class="block"><p>Closes the session by sending a GOAWAY frame with the given error code |
| and payload.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>error</code> - the error code</dd> |
| <dd><code>payload</code> - an optional payload (may be null)</dd> |
| <dd><code>callback</code> - the callback that gets notified when the frame has been sent</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the frame is being sent, false if the session was already closed</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 the session is not open</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getStreams()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getStreams</h4> |
| <pre class="methodSignature">java.util.Collection<<a href="Stream.html" title="interface in org.eclipse.jetty.http2.api">Stream</a>> getStreams()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a snapshot of all the streams currently belonging to this session</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getStream(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getStream</h4> |
| <pre class="methodSignature"><a href="Stream.html" title="interface in org.eclipse.jetty.http2.api">Stream</a> getStream​(int streamId)</pre> |
| <div class="block"><p>Retrieves the stream with the given <code>streamId</code>.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>streamId</code> - the stream id of the stream looked for</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the stream with the given id, or null if no such stream exist</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getLocalAddress()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLocalAddress</h4> |
| <pre class="methodSignature">@Deprecated |
| java.net.InetSocketAddress getLocalAddress()</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">use <a href="#getLocalSocketAddress()"><code>getLocalSocketAddress()</code></a> instead</div> |
| </div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the local network address this session is bound to, |
| or <code>null</code> if this session is not bound to a network address</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getLocalSocketAddress()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLocalSocketAddress</h4> |
| <pre class="methodSignature">default java.net.SocketAddress getLocalSocketAddress()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the local network address this session is bound to, |
| or <code>null</code> if this session is not bound to a network address</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getRemoteAddress()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRemoteAddress</h4> |
| <pre class="methodSignature">@Deprecated |
| java.net.InetSocketAddress getRemoteAddress()</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">use <a href="#getRemoteSocketAddress()"><code>getRemoteSocketAddress()</code></a> instead</div> |
| </div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the remote network address this session is connected to, |
| or <code>null</code> if this session is not connected to a network address</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getRemoteSocketAddress()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getRemoteSocketAddress</h4> |
| <pre class="methodSignature">default java.net.SocketAddress getRemoteSocketAddress()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the remote network address this session is connected to, |
| or <code>null</code> if this session is not connected to a network address</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/Session.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> |
