| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.11) on Mon Jun 14 16:44:01 EDT 2021 --> |
| <title>Session (Eclipse Jetty API Doc - v11.0.5)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2021-06-14"> |
| <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 - v11.0.5)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":18,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| var pathtoroot = "../../../../../"; |
| var useModuleDirectories = true; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/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>Nested | </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.websocket.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 Superinterfaces:</dt> |
| <dd><code>java.lang.AutoCloseable</code>, <code>java.io.Closeable</code>, <code><a href="WebSocketPolicy.html" title="interface in org.eclipse.jetty.websocket.api">WebSocketPolicy</a></code></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="../common/WebSocketSession.html" title="class in org.eclipse.jetty.websocket.common">WebSocketSession</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public interface <span class="typeNameLabel">Session</span> |
| extends <a href="WebSocketPolicy.html" title="interface in org.eclipse.jetty.websocket.api">WebSocketPolicy</a>, java.io.Closeable</pre> |
| <div class="block">Session represents an active link of communications with a Remote WebSocket Endpoint.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>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">Request a close of the current conversation with a normal status code and no reason phrase.</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="#close(int,java.lang.String)">close</a></span>​(int statusCode, |
| java.lang.String reason)</code></th> |
| <td class="colLast"> |
| <div class="block">Send a websocket Close frame, with status code.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#close(org.eclipse.jetty.websocket.api.CloseStatus)">close</a></span>​(<a href="CloseStatus.html" title="class in org.eclipse.jetty.websocket.api">CloseStatus</a> closeStatus)</code></th> |
| <td class="colLast"> |
| <div class="block">Request Close the current conversation, giving a reason for the closure.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#disconnect()">disconnect</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Issue a harsh disconnect of the underlying connection.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>java.net.SocketAddress</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">The Local Socket Address for the active Session</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>default <a href="WebSocketPolicy.html" title="interface in org.eclipse.jetty.websocket.api">WebSocketPolicy</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPolicy()">getPolicy</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Access the (now read-only) <a href="WebSocketPolicy.html" title="interface in org.eclipse.jetty.websocket.api"><code>WebSocketPolicy</code></a> in use for this connection.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getProtocolVersion()">getProtocolVersion</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the version of the websocket protocol currently being used.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="RemoteEndpoint.html" title="interface in org.eclipse.jetty.websocket.api">RemoteEndpoint</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRemote()">getRemote</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Return a reference to the RemoteEndpoint object representing the other end of this conversation.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>java.net.SocketAddress</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">The Remote Socket Address for the active Session</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="UpgradeRequest.html" title="interface in org.eclipse.jetty.websocket.api">UpgradeRequest</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getUpgradeRequest()">getUpgradeRequest</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Get the UpgradeRequest used to create this session</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><a href="UpgradeResponse.html" title="interface in org.eclipse.jetty.websocket.api">UpgradeResponse</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getUpgradeResponse()">getUpgradeResponse</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Get the UpgradeResponse used to create this session</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isOpen()">isOpen</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Return true if and only if the underlying socket is open.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isSecure()">isSecure</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Return true if and only if the underlying socket is using a secure transport.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code><a href="SuspendToken.html" title="interface in org.eclipse.jetty.websocket.api">SuspendToken</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#suspend()">suspend</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Suspend the delivery of incoming WebSocket frames.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.eclipse.jetty.websocket.api.WebSocketPolicy"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.eclipse.jetty.websocket.api.<a href="WebSocketPolicy.html" title="interface in org.eclipse.jetty.websocket.api">WebSocketPolicy</a></h3> |
| <code><a href="WebSocketPolicy.html#getBehavior()">getBehavior</a>, <a href="WebSocketPolicy.html#getIdleTimeout()">getIdleTimeout</a>, <a href="WebSocketPolicy.html#getInputBufferSize()">getInputBufferSize</a>, <a href="WebSocketPolicy.html#getMaxBinaryMessageSize()">getMaxBinaryMessageSize</a>, <a href="WebSocketPolicy.html#getMaxFrameSize()">getMaxFrameSize</a>, <a href="WebSocketPolicy.html#getMaxTextMessageSize()">getMaxTextMessageSize</a>, <a href="WebSocketPolicy.html#getOutputBufferSize()">getOutputBufferSize</a>, <a href="WebSocketPolicy.html#isAutoFragment()">isAutoFragment</a>, <a href="WebSocketPolicy.html#setAutoFragment(boolean)">setAutoFragment</a>, <a href="WebSocketPolicy.html#setIdleTimeout(java.time.Duration)">setIdleTimeout</a>, <a href="WebSocketPolicy.html#setInputBufferSize(int)">setInputBufferSize</a>, <a href="WebSocketPolicy.html#setMaxBinaryMessageSize(long)">setMaxBinaryMessageSize</a>, <a href="WebSocketPolicy.html#setMaxFrameSize(long)">setMaxFrameSize</a>, <a href="WebSocketPolicy.html#setMaxTextMessageSize(long)">setMaxTextMessageSize</a>, <a href="WebSocketPolicy.html#setOutputBufferSize(int)">setOutputBufferSize</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="close()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>close</h4> |
| <pre class="methodSignature">void close()</pre> |
| <div class="block">Request a close of the current conversation with a normal status code and no reason phrase. |
| <p> |
| This will enqueue a graceful close to the remote endpoint.</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> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#close(org.eclipse.jetty.websocket.api.CloseStatus)"><code>close(CloseStatus)</code></a>, |
| <a href="#close(int,java.lang.String)"><code>close(int, String)</code></a>, |
| <a href="#disconnect()"><code>disconnect()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="close(org.eclipse.jetty.websocket.api.CloseStatus)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>close</h4> |
| <pre class="methodSignature">void close​(<a href="CloseStatus.html" title="class in org.eclipse.jetty.websocket.api">CloseStatus</a> closeStatus)</pre> |
| <div class="block">Request Close the current conversation, giving a reason for the closure. Note the websocket spec defines the acceptable uses of status codes and reason |
| phrases. |
| <p> |
| This will enqueue a graceful close to the remote endpoint.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>closeStatus</code> - the reason for the closure</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#close()"><code>close()</code></a>, |
| <a href="#close(int,java.lang.String)"><code>close(int, String)</code></a>, |
| <a href="#disconnect()"><code>disconnect()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="close(int,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>close</h4> |
| <pre class="methodSignature">void close​(int statusCode, |
| java.lang.String reason)</pre> |
| <div class="block">Send a websocket Close frame, with status code. |
| <p> |
| This will enqueue a graceful close to the remote endpoint.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>statusCode</code> - the status code</dd> |
| <dd><code>reason</code> - the (optional) reason. (can be null for no reason)</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="StatusCode.html" title="class in org.eclipse.jetty.websocket.api"><code>StatusCode</code></a>, |
| <a href="#close()"><code>close()</code></a>, |
| <a href="#close(org.eclipse.jetty.websocket.api.CloseStatus)"><code>close(CloseStatus)</code></a>, |
| <a href="#disconnect()"><code>disconnect()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="disconnect()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>disconnect</h4> |
| <pre class="methodSignature">void disconnect()</pre> |
| <div class="block">Issue a harsh disconnect of the underlying connection. |
| <p> |
| This will terminate the connection, without sending a websocket close frame. |
| <p> |
| Once called, any read/write activity on the websocket from this point will be indeterminate. |
| <p> |
| Once the underlying connection has been determined to be closed, the various onClose() events (either |
| <a href="WebSocketConnectionListener.html#onWebSocketClose(int,java.lang.String)"><code>WebSocketConnectionListener.onWebSocketClose(int, String)</code></a> or <a href="annotations/OnWebSocketClose.html" title="annotation in org.eclipse.jetty.websocket.api.annotations"><code>OnWebSocketClose</code></a>) will be called on your |
| websocket.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#close()"><code>close()</code></a>, |
| <a href="#close(org.eclipse.jetty.websocket.api.CloseStatus)"><code>close(CloseStatus)</code></a>, |
| <a href="#close(int,java.lang.String)"><code>close(int, String)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getLocalAddress()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLocalAddress</h4> |
| <pre class="methodSignature">java.net.SocketAddress getLocalAddress()</pre> |
| <div class="block">The Local Socket Address for the active Session |
| <p> |
| Do not assume that this will return a <code>InetSocketAddress</code> in all cases. |
| Use of various proxies, and even UnixSockets can result a SocketAddress being returned |
| without supporting <code>InetSocketAddress</code> |
| </p></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the SocketAddress for the local connection, or null if not supported by Session</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getPolicy()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPolicy</h4> |
| <pre class="methodSignature">default <a href="WebSocketPolicy.html" title="interface in org.eclipse.jetty.websocket.api">WebSocketPolicy</a> getPolicy()</pre> |
| <div class="block">Access the (now read-only) <a href="WebSocketPolicy.html" title="interface in org.eclipse.jetty.websocket.api"><code>WebSocketPolicy</code></a> in use for this connection.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the policy in use</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getProtocolVersion()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getProtocolVersion</h4> |
| <pre class="methodSignature">java.lang.String getProtocolVersion()</pre> |
| <div class="block">Returns the version of the websocket protocol currently being used. This is taken as the value of the Sec-WebSocket-Version header used in the opening |
| handshake. i.e. "13".</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the protocol version</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getRemote()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRemote</h4> |
| <pre class="methodSignature"><a href="RemoteEndpoint.html" title="interface in org.eclipse.jetty.websocket.api">RemoteEndpoint</a> getRemote()</pre> |
| <div class="block">Return a reference to the RemoteEndpoint object representing the other end of this conversation.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the remote endpoint</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getRemoteAddress()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRemoteAddress</h4> |
| <pre class="methodSignature">java.net.SocketAddress getRemoteAddress()</pre> |
| <div class="block">The Remote Socket Address for the active Session |
| <p> |
| Do not assume that this will return a <code>InetSocketAddress</code> in all cases. |
| Use of various proxies, and even UnixSockets can result a SocketAddress being returned |
| without supporting <code>InetSocketAddress</code> |
| </p></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the SocketAddress for the remote connection, or null if not supported by Session</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getUpgradeRequest()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getUpgradeRequest</h4> |
| <pre class="methodSignature"><a href="UpgradeRequest.html" title="interface in org.eclipse.jetty.websocket.api">UpgradeRequest</a> getUpgradeRequest()</pre> |
| <div class="block">Get the UpgradeRequest used to create this session</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the UpgradeRequest used to create this session</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getUpgradeResponse()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getUpgradeResponse</h4> |
| <pre class="methodSignature"><a href="UpgradeResponse.html" title="interface in org.eclipse.jetty.websocket.api">UpgradeResponse</a> getUpgradeResponse()</pre> |
| <div class="block">Get the UpgradeResponse used to create this session</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the UpgradeResponse used to create this session</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isOpen()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isOpen</h4> |
| <pre class="methodSignature">boolean isOpen()</pre> |
| <div class="block">Return true if and only if the underlying socket is open.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>whether the session is open</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isSecure()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isSecure</h4> |
| <pre class="methodSignature">boolean isSecure()</pre> |
| <div class="block">Return true if and only if the underlying socket is using a secure transport.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>whether its using a secure transport</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="suspend()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>suspend</h4> |
| <pre class="methodSignature"><a href="SuspendToken.html" title="interface in org.eclipse.jetty.websocket.api">SuspendToken</a> suspend()</pre> |
| <div class="block">Suspend the delivery of incoming WebSocket frames. |
| <p> |
| If this is called from inside the scope of the message handler the suspend takes effect immediately. |
| If suspend is called outside the scope of the message handler then the call may take effect |
| after 1 more frame is delivered. |
| </p></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the suspend token suitable for resuming the reading of data on the connection.</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>Nested | </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> |