| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.9) on Wed Nov 04 12:15:18 CST 2020 --> |
| <title>WebSocketSession (Jetty :: Project 9.4.34.v20201102 API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2020-11-04"> |
| <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="WebSocketSession (Jetty :: Project 9.4.34.v20201102 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":10,"i32":10,"i33":10,"i34":10,"i35":10,"i36":10,"i37":10,"i38":10,"i39":10,"i40":10,"i41":42,"i42":10,"i43":10,"i44":10,"i45":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| var pathtoroot = "../../../../../"; |
| var useModuleDirectories = false; |
| 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/WebSocketSession.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><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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.common</a></div> |
| <h2 title="Class WebSocketSession" class="title">Class WebSocketSession</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../util/component/AbstractLifeCycle.html" title="class in org.eclipse.jetty.util.component">org.eclipse.jetty.util.component.AbstractLifeCycle</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../util/component/ContainerLifeCycle.html" title="class in org.eclipse.jetty.util.component">org.eclipse.jetty.util.component.ContainerLifeCycle</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.eclipse.jetty.websocket.common.WebSocketSession</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code>java.io.Closeable</code>, <code>java.lang.AutoCloseable</code>, <code><a href="../../io/Connection.Listener.html" title="interface in org.eclipse.jetty.io">Connection.Listener</a></code>, <code><a href="../../util/component/Container.html" title="interface in org.eclipse.jetty.util.component">Container</a></code>, <code><a href="../../util/component/Destroyable.html" title="interface in org.eclipse.jetty.util.component">Destroyable</a></code>, <code><a href="../../util/component/Dumpable.html" title="interface in org.eclipse.jetty.util.component">Dumpable</a></code>, <code><a href="../../util/component/Dumpable.DumpableContainer.html" title="interface in org.eclipse.jetty.util.component">Dumpable.DumpableContainer</a></code>, <code><a href="../../util/component/LifeCycle.html" title="interface in org.eclipse.jetty.util.component">LifeCycle</a></code>, <code><a href="../api/extensions/IncomingFrames.html" title="interface in org.eclipse.jetty.websocket.api.extensions">IncomingFrames</a></code>, <code><a href="../api/extensions/OutgoingFrames.html" title="interface in org.eclipse.jetty.websocket.api.extensions">OutgoingFrames</a></code>, <code><a href="../api/Session.html" title="interface in org.eclipse.jetty.websocket.api">Session</a></code>, <code><a href="RemoteEndpointFactory.html" title="interface in org.eclipse.jetty.websocket.common">RemoteEndpointFactory</a></code>, <code><a href="scopes/WebSocketSessionScope.html" title="interface in org.eclipse.jetty.websocket.common.scopes">WebSocketSessionScope</a></code></dd> |
| </dl> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><code><a href="../jsr356/JsrSession.html" title="class in org.eclipse.jetty.websocket.jsr356">JsrSession</a></code></dd> |
| </dl> |
| <hr> |
| <pre><a href="../../util/annotation/ManagedObject.html" title="annotation in org.eclipse.jetty.util.annotation">@ManagedObject</a>("A Jetty WebSocket Session") |
| public class <span class="typeNameLabel">WebSocketSession</span> |
| extends <a href="../../util/component/ContainerLifeCycle.html" title="class in org.eclipse.jetty.util.component">ContainerLifeCycle</a> |
| implements <a href="../api/Session.html" title="interface in org.eclipse.jetty.websocket.api">Session</a>, <a href="RemoteEndpointFactory.html" title="interface in org.eclipse.jetty.websocket.common">RemoteEndpointFactory</a>, <a href="scopes/WebSocketSessionScope.html" title="interface in org.eclipse.jetty.websocket.common.scopes">WebSocketSessionScope</a>, <a href="../api/extensions/IncomingFrames.html" title="interface in org.eclipse.jetty.websocket.api.extensions">IncomingFrames</a>, <a href="../api/extensions/OutgoingFrames.html" title="interface in org.eclipse.jetty.websocket.api.extensions">OutgoingFrames</a>, <a href="../../io/Connection.Listener.html" title="interface in org.eclipse.jetty.io">Connection.Listener</a></pre> |
| </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> |
| <ul class="blockList"> |
| <li class="blockList"><a id="nested.classes.inherited.from.class.org.eclipse.jetty.util.component.AbstractLifeCycle"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from class org.eclipse.jetty.util.component.<a href="../../util/component/AbstractLifeCycle.html" title="class in org.eclipse.jetty.util.component">AbstractLifeCycle</a></h3> |
| <code><a href="../../util/component/AbstractLifeCycle.AbstractLifeCycleListener.html" title="class in org.eclipse.jetty.util.component">AbstractLifeCycle.AbstractLifeCycleListener</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="nested.classes.inherited.from.class.org.eclipse.jetty.io.Connection.Listener"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from interface org.eclipse.jetty.io.<a href="../../io/Connection.Listener.html" title="interface in org.eclipse.jetty.io">Connection.Listener</a></h3> |
| <code><a href="../../io/Connection.Listener.Adapter.html" title="class in org.eclipse.jetty.io">Connection.Listener.Adapter</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="nested.classes.inherited.from.class.org.eclipse.jetty.util.component.Container"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.<a href="../../util/component/Container.html" title="interface in org.eclipse.jetty.util.component">Container</a></h3> |
| <code><a href="../../util/component/Container.InheritedListener.html" title="interface in org.eclipse.jetty.util.component">Container.InheritedListener</a>, <a href="../../util/component/Container.Listener.html" title="interface in org.eclipse.jetty.util.component">Container.Listener</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="nested.classes.inherited.from.class.org.eclipse.jetty.util.component.Dumpable"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.<a href="../../util/component/Dumpable.html" title="interface in org.eclipse.jetty.util.component">Dumpable</a></h3> |
| <code><a href="../../util/component/Dumpable.DumpableContainer.html" title="interface in org.eclipse.jetty.util.component">Dumpable.DumpableContainer</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="nested.classes.inherited.from.class.org.eclipse.jetty.util.component.LifeCycle"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.<a href="../../util/component/LifeCycle.html" title="interface in org.eclipse.jetty.util.component">LifeCycle</a></h3> |
| <code><a href="../../util/component/LifeCycle.Listener.html" title="interface in org.eclipse.jetty.util.component">LifeCycle.Listener</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a id="fields.inherited.from.class.org.eclipse.jetty.util.component.AbstractLifeCycle"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.eclipse.jetty.util.component.<a href="../../util/component/AbstractLifeCycle.html" title="class in org.eclipse.jetty.util.component">AbstractLifeCycle</a></h3> |
| <code><a href="../../util/component/AbstractLifeCycle.html#FAILED">FAILED</a>, <a href="../../util/component/AbstractLifeCycle.html#RUNNING">RUNNING</a>, <a href="../../util/component/AbstractLifeCycle.html#STARTED">STARTED</a>, <a href="../../util/component/AbstractLifeCycle.html#STARTING">STARTING</a>, <a href="../../util/component/AbstractLifeCycle.html#STOPPED">STOPPED</a>, <a href="../../util/component/AbstractLifeCycle.html#STOPPING">STOPPING</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="fields.inherited.from.class.org.eclipse.jetty.util.component.Dumpable"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from interface org.eclipse.jetty.util.component.<a href="../../util/component/Dumpable.html" title="interface in org.eclipse.jetty.util.component">Dumpable</a></h3> |
| <code><a href="../../util/component/Dumpable.html#KEY">KEY</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Constructor</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.eclipse.jetty.websocket.common.scopes.WebSocketContainerScope,java.net.URI,org.eclipse.jetty.websocket.common.events.EventDriver,org.eclipse.jetty.websocket.common.LogicalConnection)">WebSocketSession</a></span>​(<a href="scopes/WebSocketContainerScope.html" title="interface in org.eclipse.jetty.websocket.common.scopes">WebSocketContainerScope</a> containerScope, |
| java.net.URI requestURI, |
| <a href="events/EventDriver.html" title="interface in org.eclipse.jetty.websocket.common.events">EventDriver</a> websocket, |
| <a href="LogicalConnection.html" title="interface in org.eclipse.jetty.websocket.common">LogicalConnection</a> connection)</code></th> |
| <td class="colLast"> </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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#callApplicationOnClose(org.eclipse.jetty.websocket.common.CloseInfo)">callApplicationOnClose</a></span>​(<a href="CloseInfo.html" title="class in org.eclipse.jetty.websocket.common">CloseInfo</a> closeInfo)</code></th> |
| <td class="colLast"> </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="#callApplicationOnError(java.lang.Throwable)">callApplicationOnError</a></span>​(java.lang.Throwable cause)</code></th> |
| <td class="colLast"> </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()">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="i3" 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="i4" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#close(java.lang.Throwable)">close</a></span>​(java.lang.Throwable cause)</code></th> |
| <td class="colLast"> |
| <div class="block">Close the active session based on the throwable</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <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="../api/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="i6" class="altColor"> |
| <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">Harsh disconnect</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#dispatch(java.lang.Runnable)">dispatch</a></span>​(java.lang.Runnable runnable)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#doStart()">doStart</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Starts the managed lifecycle beans in the order they were added.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#doStop()">doStop</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Stops the managed lifecycle beans in the reverse order they were added.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#dumpSelf()">dumpSelf</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">The description of this/self found in the dump.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code><a href="../api/BatchMode.html" title="enum in org.eclipse.jetty.websocket.api">BatchMode</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getBatchMode()">getBatchMode</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code><a href="../../io/ByteBufferPool.html" title="interface in org.eclipse.jetty.io">ByteBufferPool</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getBufferPool()">getBufferPool</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>java.lang.ClassLoader</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getClassLoader()">getClassLoader</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code><a href="LogicalConnection.html" title="interface in org.eclipse.jetty.websocket.common">LogicalConnection</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getConnection()">getConnection</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code><a href="scopes/WebSocketContainerScope.html" title="interface in org.eclipse.jetty.websocket.common.scopes">WebSocketContainerScope</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getContainerScope()">getContainerScope</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">The parent <a href="scopes/WebSocketContainerScope.html" title="interface in org.eclipse.jetty.websocket.common.scopes"><code>WebSocketContainerScope</code></a> for this session scope.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code><a href="../api/extensions/ExtensionFactory.html" title="class in org.eclipse.jetty.websocket.api.extensions">ExtensionFactory</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getExtensionFactory()">getExtensionFactory</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getIdleTimeout()">getIdleTimeout</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">The idle timeout in milliseconds</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code><a href="../api/extensions/IncomingFrames.html" title="interface in org.eclipse.jetty.websocket.api.extensions">IncomingFrames</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getIncomingHandler()">getIncomingHandler</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i19" 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">Get the address of the local side.</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code><a href="../api/extensions/OutgoingFrames.html" title="interface in org.eclipse.jetty.websocket.api.extensions">OutgoingFrames</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getOutgoingHandler()">getOutgoingHandler</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code><a href="../api/WebSocketPolicy.html" title="class 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="../api/WebSocketPolicy.html" title="class in org.eclipse.jetty.websocket.api"><code>WebSocketPolicy</code></a> in use for this connection.</div> |
| </td> |
| </tr> |
| <tr id="i22" 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="i23" class="rowColor"> |
| <td class="colFirst"><code><a href="../api/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="i24" class="altColor"> |
| <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">Get the address of the remote side.</div> |
| </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><code>java.net.URI</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRequestURI()">getRequestURI</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i26" class="altColor"> |
| <td class="colFirst"><code><a href="../api/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="i27" class="rowColor"> |
| <td class="colFirst"><code><a href="../api/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="i28" class="altColor"> |
| <td class="colFirst"><code><a href="WebSocketSession.html" title="class in org.eclipse.jetty.websocket.common">WebSocketSession</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getWebSocketSession()">getWebSocketSession</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Active <a href="WebSocketSession.html" title="class in org.eclipse.jetty.websocket.common"><code>WebSocketSession</code></a> associated with this scope.</div> |
| </td> |
| </tr> |
| <tr id="i29" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#incomingFrame(org.eclipse.jetty.websocket.api.extensions.Frame)">incomingFrame</a></span>​(<a href="../api/extensions/Frame.html" title="interface in org.eclipse.jetty.websocket.api.extensions">Frame</a> frame)</code></th> |
| <td class="colLast"> |
| <div class="block">Incoming Raw Frames from Parser</div> |
| </td> |
| </tr> |
| <tr id="i30" class="altColor"> |
| <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="i31" class="rowColor"> |
| <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="i32" class="altColor"> |
| <td class="colFirst"><code><a href="WebSocketRemoteEndpoint.html" title="class in org.eclipse.jetty.websocket.common">WebSocketRemoteEndpoint</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#newRemoteEndpoint(org.eclipse.jetty.websocket.common.LogicalConnection,org.eclipse.jetty.websocket.api.extensions.OutgoingFrames,org.eclipse.jetty.websocket.api.BatchMode)">newRemoteEndpoint</a></span>​(<a href="LogicalConnection.html" title="interface in org.eclipse.jetty.websocket.common">LogicalConnection</a> connection, |
| <a href="../api/extensions/OutgoingFrames.html" title="interface in org.eclipse.jetty.websocket.api.extensions">OutgoingFrames</a> outgoingFrames, |
| <a href="../api/BatchMode.html" title="enum in org.eclipse.jetty.websocket.api">BatchMode</a> batchMode)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i33" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onClosed(org.eclipse.jetty.io.Connection)">onClosed</a></span>​(<a href="../../io/Connection.html" title="interface in org.eclipse.jetty.io">Connection</a> connection)</code></th> |
| <td class="colLast"> |
| <div class="block">Jetty Connection onSessionClosed event</div> |
| </td> |
| </tr> |
| <tr id="i34" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onOpened(org.eclipse.jetty.io.Connection)">onOpened</a></span>​(<a href="../../io/Connection.html" title="interface in org.eclipse.jetty.io">Connection</a> connection)</code></th> |
| <td class="colLast"> |
| <div class="block">Jetty Connection onOpen event</div> |
| </td> |
| </tr> |
| <tr id="i35" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#open()">open</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Open/Activate the session</div> |
| </td> |
| </tr> |
| <tr id="i36" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#outgoingFrame(org.eclipse.jetty.websocket.api.extensions.Frame,org.eclipse.jetty.websocket.api.WriteCallback,org.eclipse.jetty.websocket.api.BatchMode)">outgoingFrame</a></span>​(<a href="../api/extensions/Frame.html" title="interface in org.eclipse.jetty.websocket.api.extensions">Frame</a> frame, |
| <a href="../api/WriteCallback.html" title="interface in org.eclipse.jetty.websocket.api">WriteCallback</a> callback, |
| <a href="../api/BatchMode.html" title="enum in org.eclipse.jetty.websocket.api">BatchMode</a> batchMode)</code></th> |
| <td class="colLast"> |
| <div class="block">A frame, and optional callback, intended for the network layer.</div> |
| </td> |
| </tr> |
| <tr id="i37" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setExtensionFactory(org.eclipse.jetty.websocket.api.extensions.ExtensionFactory)">setExtensionFactory</a></span>​(<a href="../api/extensions/ExtensionFactory.html" title="class in org.eclipse.jetty.websocket.api.extensions">ExtensionFactory</a> extensionFactory)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i38" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setFuture(java.util.concurrent.CompletableFuture)">setFuture</a></span>​(java.util.concurrent.CompletableFuture<<a href="../api/Session.html" title="interface in org.eclipse.jetty.websocket.api">Session</a>> fut)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i39" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setIdleTimeout(long)">setIdleTimeout</a></span>​(long ms)</code></th> |
| <td class="colLast"> |
| <div class="block">Set the timeout in milliseconds</div> |
| </td> |
| </tr> |
| <tr id="i40" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setOutgoingHandler(org.eclipse.jetty.websocket.api.extensions.OutgoingFrames)">setOutgoingHandler</a></span>​(<a href="../api/extensions/OutgoingFrames.html" title="interface in org.eclipse.jetty.websocket.api.extensions">OutgoingFrames</a> outgoing)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i41" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setPolicy(org.eclipse.jetty.websocket.api.WebSocketPolicy)">setPolicy</a></span>​(<a href="../api/WebSocketPolicy.html" title="class in org.eclipse.jetty.websocket.api">WebSocketPolicy</a> policy)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| </td> |
| </tr> |
| <tr id="i42" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setUpgradeRequest(org.eclipse.jetty.websocket.api.UpgradeRequest)">setUpgradeRequest</a></span>​(<a href="../api/UpgradeRequest.html" title="interface in org.eclipse.jetty.websocket.api">UpgradeRequest</a> request)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i43" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setUpgradeResponse(org.eclipse.jetty.websocket.api.UpgradeResponse)">setUpgradeResponse</a></span>​(<a href="../api/UpgradeResponse.html" title="interface in org.eclipse.jetty.websocket.api">UpgradeResponse</a> response)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i44" class="altColor"> |
| <td class="colFirst"><code><a href="../api/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 incoming read events on the connection.</div> |
| </td> |
| </tr> |
| <tr id="i45" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toString()">toString</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.eclipse.jetty.util.component.ContainerLifeCycle"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.eclipse.jetty.util.component.<a href="../../util/component/ContainerLifeCycle.html" title="class in org.eclipse.jetty.util.component">ContainerLifeCycle</a></h3> |
| <code><a href="../../util/component/ContainerLifeCycle.html#addBean(java.lang.Object)">addBean</a>, <a href="../../util/component/ContainerLifeCycle.html#addBean(java.lang.Object,boolean)">addBean</a>, <a href="../../util/component/ContainerLifeCycle.html#addEventListener(org.eclipse.jetty.util.component.Container.Listener)">addEventListener</a>, <a href="../../util/component/ContainerLifeCycle.html#addManaged(org.eclipse.jetty.util.component.LifeCycle)">addManaged</a>, <a href="../../util/component/ContainerLifeCycle.html#contains(java.lang.Object)">contains</a>, <a href="../../util/component/ContainerLifeCycle.html#destroy()">destroy</a>, <a href="../../util/component/ContainerLifeCycle.html#dump()">dump</a>, <a href="../../util/component/ContainerLifeCycle.html#dump(java.lang.Appendable)">dump</a>, <a href="../../util/component/ContainerLifeCycle.html#dump(java.lang.Appendable,java.lang.String)">dump</a>, <a href="../../util/component/ContainerLifeCycle.html#dump(java.lang.Appendable,java.lang.String,java.util.Collection...)">dump</a>, <a href="../../util/component/ContainerLifeCycle.html#dump(org.eclipse.jetty.util.component.Dumpable)">dump</a>, <a href="../../util/component/ContainerLifeCycle.html#dumpBeans(java.lang.Appendable,java.lang.String,java.util.Collection...)">dumpBeans</a>, <a href="../../util/component/ContainerLifeCycle.html#dumpObject(java.lang.Appendable,java.lang.Object)">dumpObject</a>, <a href="../../util/component/ContainerLifeCycle.html#dumpObjects(java.lang.Appendable,java.lang.String,java.lang.Object...)">dumpObjects</a>, <a href="../../util/component/ContainerLifeCycle.html#dumpStdErr()">dumpStdErr</a>, <a href="../../util/component/ContainerLifeCycle.html#dumpThis(java.lang.Appendable)">dumpThis</a>, <a href="../../util/component/ContainerLifeCycle.html#getBean(java.lang.Class)">getBean</a>, <a href="../../util/component/ContainerLifeCycle.html#getBeans()">getBeans</a>, <a href="../../util/component/ContainerLifeCycle.html#getBeans(java.lang.Class)">getBeans</a>, <a href="../../util/component/ContainerLifeCycle.html#getContainedBeans(java.lang.Class)">getContainedBeans</a>, <a href="../../util/component/ContainerLifeCycle.html#getContainedBeans(java.lang.Class,java.util.Collection)">getContainedBeans</a>, <a href="../../util/component/ContainerLifeCycle.html#isAuto(java.lang.Object)">isAuto</a>, <a href="../../util/component/ContainerLifeCycle.html#isManaged(java.lang.Object)">isManaged</a>, <a href="../../util/component/ContainerLifeCycle.html#isUnmanaged(java.lang.Object)">isUnmanaged</a>, <a href="../../util/component/ContainerLifeCycle.html#manage(java.lang.Object)">manage</a>, <a href="../../util/component/ContainerLifeCycle.html#removeBean(java.lang.Object)">removeBean</a>, <a href="../../util/component/ContainerLifeCycle.html#removeBeans()">removeBeans</a>, <a href="../../util/component/ContainerLifeCycle.html#removeEventListener(org.eclipse.jetty.util.component.Container.Listener)">removeEventListener</a>, <a href="../../util/component/ContainerLifeCycle.html#setBeans(java.util.Collection)">setBeans</a>, <a href="../../util/component/ContainerLifeCycle.html#setStopTimeout(long)">setStopTimeout</a>, <a href="../../util/component/ContainerLifeCycle.html#start(org.eclipse.jetty.util.component.LifeCycle)">start</a>, <a href="../../util/component/ContainerLifeCycle.html#stop(org.eclipse.jetty.util.component.LifeCycle)">stop</a>, <a href="../../util/component/ContainerLifeCycle.html#unmanage(java.lang.Object)">unmanage</a>, <a href="../../util/component/ContainerLifeCycle.html#updateBean(java.lang.Object,java.lang.Object)">updateBean</a>, <a href="../../util/component/ContainerLifeCycle.html#updateBean(java.lang.Object,java.lang.Object,boolean)">updateBean</a>, <a href="../../util/component/ContainerLifeCycle.html#updateBeans(java.lang.Object%5B%5D,java.lang.Object%5B%5D)">updateBeans</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.eclipse.jetty.util.component.AbstractLifeCycle"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.eclipse.jetty.util.component.<a href="../../util/component/AbstractLifeCycle.html" title="class in org.eclipse.jetty.util.component">AbstractLifeCycle</a></h3> |
| <code><a href="../../util/component/AbstractLifeCycle.html#addLifeCycleListener(org.eclipse.jetty.util.component.LifeCycle.Listener)">addLifeCycleListener</a>, <a href="../../util/component/AbstractLifeCycle.html#getState()">getState</a>, <a href="../../util/component/AbstractLifeCycle.html#getState(org.eclipse.jetty.util.component.LifeCycle)">getState</a>, <a href="../../util/component/AbstractLifeCycle.html#getStopTimeout()">getStopTimeout</a>, <a href="../../util/component/AbstractLifeCycle.html#isFailed()">isFailed</a>, <a href="../../util/component/AbstractLifeCycle.html#isRunning()">isRunning</a>, <a href="../../util/component/AbstractLifeCycle.html#isStarted()">isStarted</a>, <a href="../../util/component/AbstractLifeCycle.html#isStarting()">isStarting</a>, <a href="../../util/component/AbstractLifeCycle.html#isStopped()">isStopped</a>, <a href="../../util/component/AbstractLifeCycle.html#isStopping()">isStopping</a>, <a href="../../util/component/AbstractLifeCycle.html#removeLifeCycleListener(org.eclipse.jetty.util.component.LifeCycle.Listener)">removeLifeCycleListener</a>, <a href="../../util/component/AbstractLifeCycle.html#start()">start</a>, <a href="../../util/component/AbstractLifeCycle.html#stop()">stop</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.Object</h3> |
| <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.eclipse.jetty.util.component.Dumpable.DumpableContainer"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.eclipse.jetty.util.component.<a href="../../util/component/Dumpable.DumpableContainer.html" title="interface in org.eclipse.jetty.util.component">Dumpable.DumpableContainer</a></h3> |
| <code><a href="../../util/component/Dumpable.DumpableContainer.html#isDumpable(java.lang.Object)">isDumpable</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a id="<init>(org.eclipse.jetty.websocket.common.scopes.WebSocketContainerScope,java.net.URI,org.eclipse.jetty.websocket.common.events.EventDriver,org.eclipse.jetty.websocket.common.LogicalConnection)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>WebSocketSession</h4> |
| <pre>public WebSocketSession​(<a href="scopes/WebSocketContainerScope.html" title="interface in org.eclipse.jetty.websocket.common.scopes">WebSocketContainerScope</a> containerScope, |
| java.net.URI requestURI, |
| <a href="events/EventDriver.html" title="interface in org.eclipse.jetty.websocket.common.events">EventDriver</a> websocket, |
| <a href="LogicalConnection.html" title="interface in org.eclipse.jetty.websocket.common">LogicalConnection</a> connection)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="close(java.lang.Throwable)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>close</h4> |
| <pre class="methodSignature">public void close​(java.lang.Throwable cause)</pre> |
| <div class="block">Close the active session based on the throwable</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>cause</code> - the cause for closing the connection</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="close()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>close</h4> |
| <pre class="methodSignature">public void close()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../api/Session.html#close()">Session</a></code></span></div> |
| <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="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../api/Session.html#close()">close</a></code> in interface <code><a href="../api/Session.html" title="interface in org.eclipse.jetty.websocket.api">Session</a></code></dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../api/Session.html#close(org.eclipse.jetty.websocket.api.CloseStatus)"><code>Session.close(CloseStatus)</code></a>, |
| <a href="../api/Session.html#close(int,java.lang.String)"><code>Session.close(int, String)</code></a>, |
| <a href="../api/Session.html#disconnect()"><code>Session.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">public void close​(<a href="../api/CloseStatus.html" title="class in org.eclipse.jetty.websocket.api">CloseStatus</a> closeStatus)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../api/Session.html#close(org.eclipse.jetty.websocket.api.CloseStatus)">Session</a></code></span></div> |
| <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="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../api/Session.html#close(org.eclipse.jetty.websocket.api.CloseStatus)">close</a></code> in interface <code><a href="../api/Session.html" title="interface in org.eclipse.jetty.websocket.api">Session</a></code></dd> |
| <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="../api/Session.html#close()"><code>Session.close()</code></a>, |
| <a href="../api/Session.html#close(int,java.lang.String)"><code>Session.close(int, String)</code></a>, |
| <a href="../api/Session.html#disconnect()"><code>Session.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">public void close​(int statusCode, |
| java.lang.String reason)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../api/Session.html#close(int,java.lang.String)">Session</a></code></span></div> |
| <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="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../api/Session.html#close(int,java.lang.String)">close</a></code> in interface <code><a href="../api/Session.html" title="interface in org.eclipse.jetty.websocket.api">Session</a></code></dd> |
| <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="../api/StatusCode.html" title="class in org.eclipse.jetty.websocket.api"><code>StatusCode</code></a>, |
| <a href="../api/Session.html#close()"><code>Session.close()</code></a>, |
| <a href="../api/Session.html#close(org.eclipse.jetty.websocket.api.CloseStatus)"><code>Session.close(CloseStatus)</code></a>, |
| <a href="../api/Session.html#disconnect()"><code>Session.disconnect()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="disconnect()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>disconnect</h4> |
| <pre class="methodSignature">public void disconnect()</pre> |
| <div class="block">Harsh disconnect</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../api/Session.html#disconnect()">disconnect</a></code> in interface <code><a href="../api/Session.html" title="interface in org.eclipse.jetty.websocket.api">Session</a></code></dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../api/Session.html#close()"><code>Session.close()</code></a>, |
| <a href="../api/Session.html#close(org.eclipse.jetty.websocket.api.CloseStatus)"><code>Session.close(CloseStatus)</code></a>, |
| <a href="../api/Session.html#close(int,java.lang.String)"><code>Session.close(int, String)</code></a>, |
| <a href="../api/Session.html#disconnect()"><code>Session.disconnect()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="dispatch(java.lang.Runnable)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>dispatch</h4> |
| <pre class="methodSignature">public void dispatch​(java.lang.Runnable runnable)</pre> |
| </li> |
| </ul> |
| <a id="doStart()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>doStart</h4> |
| <pre class="methodSignature">protected void doStart() |
| throws java.lang.Exception</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../util/component/ContainerLifeCycle.html#doStart()">ContainerLifeCycle</a></code></span></div> |
| <div class="block">Starts the managed lifecycle beans in the order they were added.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../util/component/ContainerLifeCycle.html#doStart()">doStart</a></code> in class <code><a href="../../util/component/ContainerLifeCycle.html" title="class in org.eclipse.jetty.util.component">ContainerLifeCycle</a></code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.Exception</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="doStop()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>doStop</h4> |
| <pre class="methodSignature">protected void doStop() |
| throws java.lang.Exception</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../util/component/ContainerLifeCycle.html#doStop()">ContainerLifeCycle</a></code></span></div> |
| <div class="block">Stops the managed lifecycle beans in the reverse order they were added.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../util/component/ContainerLifeCycle.html#doStop()">doStop</a></code> in class <code><a href="../../util/component/ContainerLifeCycle.html" title="class in org.eclipse.jetty.util.component">ContainerLifeCycle</a></code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.Exception</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="dumpSelf()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>dumpSelf</h4> |
| <pre class="methodSignature">public java.lang.String dumpSelf()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../util/component/Dumpable.html#dumpSelf()">Dumpable</a></code></span></div> |
| <div class="block">The description of this/self found in the dump. |
| Allows for alternative representation of Object other then .toString() |
| where the long form output of toString() is represented in a cleaner way |
| within the dump infrastructure.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../util/component/Dumpable.html#dumpSelf()">dumpSelf</a></code> in interface <code><a href="../../util/component/Dumpable.html" title="interface in org.eclipse.jetty.util.component">Dumpable</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the representation of self</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getBufferPool()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBufferPool</h4> |
| <pre class="methodSignature">public <a href="../../io/ByteBufferPool.html" title="interface in org.eclipse.jetty.io">ByteBufferPool</a> getBufferPool()</pre> |
| </li> |
| </ul> |
| <a id="getClassLoader()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getClassLoader</h4> |
| <pre class="methodSignature">public java.lang.ClassLoader getClassLoader()</pre> |
| </li> |
| </ul> |
| <a id="getConnection()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getConnection</h4> |
| <pre class="methodSignature">public <a href="LogicalConnection.html" title="interface in org.eclipse.jetty.websocket.common">LogicalConnection</a> getConnection()</pre> |
| </li> |
| </ul> |
| <a id="getContainerScope()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getContainerScope</h4> |
| <pre class="methodSignature">public <a href="scopes/WebSocketContainerScope.html" title="interface in org.eclipse.jetty.websocket.common.scopes">WebSocketContainerScope</a> getContainerScope()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="scopes/WebSocketSessionScope.html#getContainerScope()">WebSocketSessionScope</a></code></span></div> |
| <div class="block">The parent <a href="scopes/WebSocketContainerScope.html" title="interface in org.eclipse.jetty.websocket.common.scopes"><code>WebSocketContainerScope</code></a> for this session scope.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="scopes/WebSocketSessionScope.html#getContainerScope()">getContainerScope</a></code> in interface <code><a href="scopes/WebSocketSessionScope.html" title="interface in org.eclipse.jetty.websocket.common.scopes">WebSocketSessionScope</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the websocket container scope</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getExtensionFactory()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getExtensionFactory</h4> |
| <pre class="methodSignature">public <a href="../api/extensions/ExtensionFactory.html" title="class in org.eclipse.jetty.websocket.api.extensions">ExtensionFactory</a> getExtensionFactory()</pre> |
| </li> |
| </ul> |
| <a id="getIdleTimeout()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getIdleTimeout</h4> |
| <pre class="methodSignature">public long getIdleTimeout()</pre> |
| <div class="block">The idle timeout in milliseconds</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../api/Session.html#getIdleTimeout()">getIdleTimeout</a></code> in interface <code><a href="../api/Session.html" title="interface in org.eclipse.jetty.websocket.api">Session</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the timeout in milliseconds.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getIncomingHandler()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getIncomingHandler</h4> |
| <pre class="methodSignature"><a href="../../util/annotation/ManagedAttribute.html" title="annotation in org.eclipse.jetty.util.annotation">@ManagedAttribute</a>(<a href="../../util/annotation/ManagedAttribute.html#readonly()">readonly</a>=true) |
| public <a href="../api/extensions/IncomingFrames.html" title="interface in org.eclipse.jetty.websocket.api.extensions">IncomingFrames</a> getIncomingHandler()</pre> |
| </li> |
| </ul> |
| <a id="getLocalAddress()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLocalAddress</h4> |
| <pre class="methodSignature">public java.net.InetSocketAddress getLocalAddress()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../api/Session.html#getLocalAddress()">Session</a></code></span></div> |
| <div class="block">Get the address of the local side.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../api/Session.html#getLocalAddress()">getLocalAddress</a></code> in interface <code><a href="../api/Session.html" title="interface in org.eclipse.jetty.websocket.api">Session</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the local side address</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getOutgoingHandler()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOutgoingHandler</h4> |
| <pre class="methodSignature"><a href="../../util/annotation/ManagedAttribute.html" title="annotation in org.eclipse.jetty.util.annotation">@ManagedAttribute</a>(<a href="../../util/annotation/ManagedAttribute.html#readonly()">readonly</a>=true) |
| public <a href="../api/extensions/OutgoingFrames.html" title="interface in org.eclipse.jetty.websocket.api.extensions">OutgoingFrames</a> getOutgoingHandler()</pre> |
| </li> |
| </ul> |
| <a id="getPolicy()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPolicy</h4> |
| <pre class="methodSignature">public <a href="../api/WebSocketPolicy.html" title="class in org.eclipse.jetty.websocket.api">WebSocketPolicy</a> getPolicy()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../api/Session.html#getPolicy()">Session</a></code></span></div> |
| <div class="block">Access the (now read-only) <a href="../api/WebSocketPolicy.html" title="class in org.eclipse.jetty.websocket.api"><code>WebSocketPolicy</code></a> in use for this connection.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../api/Session.html#getPolicy()">getPolicy</a></code> in interface <code><a href="../api/Session.html" title="interface in org.eclipse.jetty.websocket.api">Session</a></code></dd> |
| <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">public java.lang.String getProtocolVersion()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../api/Session.html#getProtocolVersion()">Session</a></code></span></div> |
| <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="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../api/Session.html#getProtocolVersion()">getProtocolVersion</a></code> in interface <code><a href="../api/Session.html" title="interface in org.eclipse.jetty.websocket.api">Session</a></code></dd> |
| <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">public <a href="../api/RemoteEndpoint.html" title="interface in org.eclipse.jetty.websocket.api">RemoteEndpoint</a> getRemote()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../api/Session.html#getRemote()">Session</a></code></span></div> |
| <div class="block">Return a reference to the RemoteEndpoint object representing the other end of this conversation.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../api/Session.html#getRemote()">getRemote</a></code> in interface <code><a href="../api/Session.html" title="interface in org.eclipse.jetty.websocket.api">Session</a></code></dd> |
| <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">public java.net.InetSocketAddress getRemoteAddress()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../api/Session.html#getRemoteAddress()">Session</a></code></span></div> |
| <div class="block">Get the address of the remote side.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../api/Session.html#getRemoteAddress()">getRemoteAddress</a></code> in interface <code><a href="../api/Session.html" title="interface in org.eclipse.jetty.websocket.api">Session</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the remote side address</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getRequestURI()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRequestURI</h4> |
| <pre class="methodSignature">public java.net.URI getRequestURI()</pre> |
| </li> |
| </ul> |
| <a id="getUpgradeRequest()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getUpgradeRequest</h4> |
| <pre class="methodSignature">public <a href="../api/UpgradeRequest.html" title="interface in org.eclipse.jetty.websocket.api">UpgradeRequest</a> getUpgradeRequest()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../api/Session.html#getUpgradeRequest()">Session</a></code></span></div> |
| <div class="block">Get the UpgradeRequest used to create this session</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../api/Session.html#getUpgradeRequest()">getUpgradeRequest</a></code> in interface <code><a href="../api/Session.html" title="interface in org.eclipse.jetty.websocket.api">Session</a></code></dd> |
| <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">public <a href="../api/UpgradeResponse.html" title="interface in org.eclipse.jetty.websocket.api">UpgradeResponse</a> getUpgradeResponse()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../api/Session.html#getUpgradeResponse()">Session</a></code></span></div> |
| <div class="block">Get the UpgradeResponse used to create this session</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../api/Session.html#getUpgradeResponse()">getUpgradeResponse</a></code> in interface <code><a href="../api/Session.html" title="interface in org.eclipse.jetty.websocket.api">Session</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the UpgradeResponse used to create this session</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getWebSocketSession()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getWebSocketSession</h4> |
| <pre class="methodSignature">public <a href="WebSocketSession.html" title="class in org.eclipse.jetty.websocket.common">WebSocketSession</a> getWebSocketSession()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="scopes/WebSocketSessionScope.html#getWebSocketSession()">WebSocketSessionScope</a></code></span></div> |
| <div class="block">Active <a href="WebSocketSession.html" title="class in org.eclipse.jetty.websocket.common"><code>WebSocketSession</code></a> associated with this scope.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="scopes/WebSocketSessionScope.html#getWebSocketSession()">getWebSocketSession</a></code> in interface <code><a href="scopes/WebSocketSessionScope.html" title="interface in org.eclipse.jetty.websocket.common.scopes">WebSocketSessionScope</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the websocket session</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="incomingFrame(org.eclipse.jetty.websocket.api.extensions.Frame)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>incomingFrame</h4> |
| <pre class="methodSignature">public void incomingFrame​(<a href="../api/extensions/Frame.html" title="interface in org.eclipse.jetty.websocket.api.extensions">Frame</a> frame)</pre> |
| <div class="block">Incoming Raw Frames from Parser</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../api/extensions/IncomingFrames.html#incomingFrame(org.eclipse.jetty.websocket.api.extensions.Frame)">incomingFrame</a></code> in interface <code><a href="../api/extensions/IncomingFrames.html" title="interface in org.eclipse.jetty.websocket.api.extensions">IncomingFrames</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>frame</code> - the frame to process</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="outgoingFrame(org.eclipse.jetty.websocket.api.extensions.Frame,org.eclipse.jetty.websocket.api.WriteCallback,org.eclipse.jetty.websocket.api.BatchMode)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>outgoingFrame</h4> |
| <pre class="methodSignature">public void outgoingFrame​(<a href="../api/extensions/Frame.html" title="interface in org.eclipse.jetty.websocket.api.extensions">Frame</a> frame, |
| <a href="../api/WriteCallback.html" title="interface in org.eclipse.jetty.websocket.api">WriteCallback</a> callback, |
| <a href="../api/BatchMode.html" title="enum in org.eclipse.jetty.websocket.api">BatchMode</a> batchMode)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../api/extensions/OutgoingFrames.html#outgoingFrame(org.eclipse.jetty.websocket.api.extensions.Frame,org.eclipse.jetty.websocket.api.WriteCallback,org.eclipse.jetty.websocket.api.BatchMode)">OutgoingFrames</a></code></span></div> |
| <div class="block">A frame, and optional callback, intended for the network layer. |
| <p> |
| Note: the frame can undergo many transformations in the various |
| layers and extensions present in the implementation. |
| <p> |
| If you are implementing a mutation, you are obliged to handle |
| the incoming WriteCallback appropriately.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../api/extensions/OutgoingFrames.html#outgoingFrame(org.eclipse.jetty.websocket.api.extensions.Frame,org.eclipse.jetty.websocket.api.WriteCallback,org.eclipse.jetty.websocket.api.BatchMode)">outgoingFrame</a></code> in interface <code><a href="../api/extensions/OutgoingFrames.html" title="interface in org.eclipse.jetty.websocket.api.extensions">OutgoingFrames</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>frame</code> - the frame to eventually write to the network layer.</dd> |
| <dd><code>callback</code> - the callback to notify when the frame is written.</dd> |
| <dd><code>batchMode</code> - the batch mode requested by the sender.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isOpen()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isOpen</h4> |
| <pre class="methodSignature">public boolean isOpen()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../api/Session.html#isOpen()">Session</a></code></span></div> |
| <div class="block">Return true if and only if the underlying socket is open.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../api/Session.html#isOpen()">isOpen</a></code> in interface <code><a href="../api/Session.html" title="interface in org.eclipse.jetty.websocket.api">Session</a></code></dd> |
| <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">public boolean isSecure()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../api/Session.html#isSecure()">Session</a></code></span></div> |
| <div class="block">Return true if and only if the underlying socket is using a secure transport.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../api/Session.html#isSecure()">isSecure</a></code> in interface <code><a href="../api/Session.html" title="interface in org.eclipse.jetty.websocket.api">Session</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>whether its using a secure transport</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="callApplicationOnClose(org.eclipse.jetty.websocket.common.CloseInfo)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>callApplicationOnClose</h4> |
| <pre class="methodSignature">public void callApplicationOnClose​(<a href="CloseInfo.html" title="class in org.eclipse.jetty.websocket.common">CloseInfo</a> closeInfo)</pre> |
| </li> |
| </ul> |
| <a id="callApplicationOnError(java.lang.Throwable)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>callApplicationOnError</h4> |
| <pre class="methodSignature">public void callApplicationOnError​(java.lang.Throwable cause)</pre> |
| </li> |
| </ul> |
| <a id="onClosed(org.eclipse.jetty.io.Connection)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>onClosed</h4> |
| <pre class="methodSignature">public void onClosed​(<a href="../../io/Connection.html" title="interface in org.eclipse.jetty.io">Connection</a> connection)</pre> |
| <div class="block">Jetty Connection onSessionClosed event</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../io/Connection.Listener.html#onClosed(org.eclipse.jetty.io.Connection)">onClosed</a></code> in interface <code><a href="../../io/Connection.Listener.html" title="interface in org.eclipse.jetty.io">Connection.Listener</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>connection</code> - the connection that was closed</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="onOpened(org.eclipse.jetty.io.Connection)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>onOpened</h4> |
| <pre class="methodSignature">public void onOpened​(<a href="../../io/Connection.html" title="interface in org.eclipse.jetty.io">Connection</a> connection)</pre> |
| <div class="block">Jetty Connection onOpen event</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../io/Connection.Listener.html#onOpened(org.eclipse.jetty.io.Connection)">onOpened</a></code> in interface <code><a href="../../io/Connection.Listener.html" title="interface in org.eclipse.jetty.io">Connection.Listener</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>connection</code> - the connection that was opened</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="newRemoteEndpoint(org.eclipse.jetty.websocket.common.LogicalConnection,org.eclipse.jetty.websocket.api.extensions.OutgoingFrames,org.eclipse.jetty.websocket.api.BatchMode)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newRemoteEndpoint</h4> |
| <pre class="methodSignature">public <a href="WebSocketRemoteEndpoint.html" title="class in org.eclipse.jetty.websocket.common">WebSocketRemoteEndpoint</a> newRemoteEndpoint​(<a href="LogicalConnection.html" title="interface in org.eclipse.jetty.websocket.common">LogicalConnection</a> connection, |
| <a href="../api/extensions/OutgoingFrames.html" title="interface in org.eclipse.jetty.websocket.api.extensions">OutgoingFrames</a> outgoingFrames, |
| <a href="../api/BatchMode.html" title="enum in org.eclipse.jetty.websocket.api">BatchMode</a> batchMode)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="RemoteEndpointFactory.html#newRemoteEndpoint(org.eclipse.jetty.websocket.common.LogicalConnection,org.eclipse.jetty.websocket.api.extensions.OutgoingFrames,org.eclipse.jetty.websocket.api.BatchMode)">newRemoteEndpoint</a></code> in interface <code><a href="RemoteEndpointFactory.html" title="interface in org.eclipse.jetty.websocket.common">RemoteEndpointFactory</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="open()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>open</h4> |
| <pre class="methodSignature">public void open()</pre> |
| <div class="block">Open/Activate the session</div> |
| </li> |
| </ul> |
| <a id="setExtensionFactory(org.eclipse.jetty.websocket.api.extensions.ExtensionFactory)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setExtensionFactory</h4> |
| <pre class="methodSignature">public void setExtensionFactory​(<a href="../api/extensions/ExtensionFactory.html" title="class in org.eclipse.jetty.websocket.api.extensions">ExtensionFactory</a> extensionFactory)</pre> |
| </li> |
| </ul> |
| <a id="setFuture(java.util.concurrent.CompletableFuture)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setFuture</h4> |
| <pre class="methodSignature">public void setFuture​(java.util.concurrent.CompletableFuture<<a href="../api/Session.html" title="interface in org.eclipse.jetty.websocket.api">Session</a>> fut)</pre> |
| </li> |
| </ul> |
| <a id="setIdleTimeout(long)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setIdleTimeout</h4> |
| <pre class="methodSignature">public void setIdleTimeout​(long ms)</pre> |
| <div class="block">Set the timeout in milliseconds</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../api/Session.html#setIdleTimeout(long)">setIdleTimeout</a></code> in interface <code><a href="../api/Session.html" title="interface in org.eclipse.jetty.websocket.api">Session</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>ms</code> - the number of milliseconds.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setOutgoingHandler(org.eclipse.jetty.websocket.api.extensions.OutgoingFrames)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setOutgoingHandler</h4> |
| <pre class="methodSignature">public void setOutgoingHandler​(<a href="../api/extensions/OutgoingFrames.html" title="interface in org.eclipse.jetty.websocket.api.extensions">OutgoingFrames</a> outgoing)</pre> |
| </li> |
| </ul> |
| <a id="setPolicy(org.eclipse.jetty.websocket.api.WebSocketPolicy)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPolicy</h4> |
| <pre class="methodSignature">@Deprecated |
| public void setPolicy​(<a href="../api/WebSocketPolicy.html" title="class in org.eclipse.jetty.websocket.api">WebSocketPolicy</a> policy)</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| </li> |
| </ul> |
| <a id="setUpgradeRequest(org.eclipse.jetty.websocket.api.UpgradeRequest)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setUpgradeRequest</h4> |
| <pre class="methodSignature">public void setUpgradeRequest​(<a href="../api/UpgradeRequest.html" title="interface in org.eclipse.jetty.websocket.api">UpgradeRequest</a> request)</pre> |
| </li> |
| </ul> |
| <a id="setUpgradeResponse(org.eclipse.jetty.websocket.api.UpgradeResponse)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setUpgradeResponse</h4> |
| <pre class="methodSignature">public void setUpgradeResponse​(<a href="../api/UpgradeResponse.html" title="interface in org.eclipse.jetty.websocket.api">UpgradeResponse</a> response)</pre> |
| </li> |
| </ul> |
| <a id="suspend()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>suspend</h4> |
| <pre class="methodSignature">public <a href="../api/SuspendToken.html" title="interface in org.eclipse.jetty.websocket.api">SuspendToken</a> suspend()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../api/Session.html#suspend()">Session</a></code></span></div> |
| <div class="block">Suspend the incoming read events on the connection.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../api/Session.html#suspend()">suspend</a></code> in interface <code><a href="../api/Session.html" title="interface in org.eclipse.jetty.websocket.api">Session</a></code></dd> |
| <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> |
| <a id="getBatchMode()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBatchMode</h4> |
| <pre class="methodSignature">public <a href="../api/BatchMode.html" title="enum in org.eclipse.jetty.websocket.api">BatchMode</a> getBatchMode()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the default (initial) value for the batching mode.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="toString()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>toString</h4> |
| <pre class="methodSignature">public java.lang.String toString()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../util/component/AbstractLifeCycle.html#toString()">toString</a></code> in class <code><a href="../../util/component/AbstractLifeCycle.html" title="class in org.eclipse.jetty.util.component">AbstractLifeCycle</a></code></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/WebSocketSession.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><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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–2020 <a href="https://webtide.com">Webtide</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |