Google Git
Sign in
eclipse / www.eclipse.org / jetty / 244b31480d88c4c2e783a862c86c320807c66eb3 / . / javadoc / 9.3.24.v20180605 / org / eclipse / jetty / websocket / common / WebSocketSession.html
blob: 3aff03409c3eec97ff9ec7bbae3ff0e00db261a9 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_92) on Thu Jun 07 14:26:32 EDT 2018 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>WebSocketSession (Jetty :: Project 9.3.24.v20180605 API)</title>
<meta name="date" content="2018-06-07">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="WebSocketSession (Jetty :: Project 9.3.24.v20180605 API)";
}
}
catch(err) {
}
//-->
var methods = {"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":10,"i42":10,"i43":10,"i44":10,"i45":10,"i46":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.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">
<li><a href="../../../../../org/eclipse/jetty/websocket/common/WebSocketRemoteEndpoint.html" title="class in org.eclipse.jetty.websocket.common"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/eclipse/jetty/websocket/common/WebSocketSession.Listener.html" title="interface in org.eclipse.jetty.websocket.common"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/eclipse/jetty/websocket/common/WebSocketSession.html" target="_top">Frames</a></li>
<li><a href="WebSocketSession.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></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>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#fields.inherited.from.class.org.eclipse.jetty.util.component.AbstractLifeCycle">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.eclipse.jetty.websocket.common</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="../../../../../org/eclipse/jetty/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="../../../../../org/eclipse/jetty/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>java.io.Closeable, java.lang.AutoCloseable, <a href="../../../../../org/eclipse/jetty/io/Connection.Listener.html" title="interface in org.eclipse.jetty.io">Connection.Listener</a>, <a href="../../../../../org/eclipse/jetty/util/component/Container.html" title="interface in org.eclipse.jetty.util.component">Container</a>, <a href="../../../../../org/eclipse/jetty/util/component/Destroyable.html" title="interface in org.eclipse.jetty.util.component">Destroyable</a>, <a href="../../../../../org/eclipse/jetty/util/component/Dumpable.html" title="interface in org.eclipse.jetty.util.component">Dumpable</a>, <a href="../../../../../org/eclipse/jetty/util/component/LifeCycle.html" title="interface in org.eclipse.jetty.util.component">LifeCycle</a>, <a href="../../../../../org/eclipse/jetty/websocket/api/extensions/IncomingFrames.html" title="interface in org.eclipse.jetty.websocket.api.extensions">IncomingFrames</a>, <a href="../../../../../org/eclipse/jetty/websocket/api/Session.html" title="interface in org.eclipse.jetty.websocket.api">Session</a>, <a href="../../../../../org/eclipse/jetty/websocket/common/io/IOState.ConnectionStateListener.html" title="interface in org.eclipse.jetty.websocket.common.io">IOState.ConnectionStateListener</a>, <a href="../../../../../org/eclipse/jetty/websocket/common/RemoteEndpointFactory.html" title="interface in org.eclipse.jetty.websocket.common">RemoteEndpointFactory</a>, <a href="../../../../../org/eclipse/jetty/websocket/common/scopes/WebSocketSessionScope.html" title="interface in org.eclipse.jetty.websocket.common.scopes">WebSocketSessionScope</a></dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../../org/eclipse/jetty/websocket/jsr356/JsrSession.html" title="class in org.eclipse.jetty.websocket.jsr356">JsrSession</a></dd>
</dl>
<hr>
<br>
<pre><a href="../../../../../org/eclipse/jetty/util/annotation/ManagedObject.html" title="annotation in org.eclipse.jetty.util.annotation">@ManagedObject</a>(<a href="../../../../../org/eclipse/jetty/util/annotation/ManagedObject.html#value--">value</a>="A Jetty WebSocket Session")
public class <span class="typeNameLabel">WebSocketSession</span>
extends <a href="../../../../../org/eclipse/jetty/util/component/ContainerLifeCycle.html" title="class in org.eclipse.jetty.util.component">ContainerLifeCycle</a>
implements <a href="../../../../../org/eclipse/jetty/websocket/api/Session.html" title="interface in org.eclipse.jetty.websocket.api">Session</a>, <a href="../../../../../org/eclipse/jetty/websocket/common/RemoteEndpointFactory.html" title="interface in org.eclipse.jetty.websocket.common">RemoteEndpointFactory</a>, <a href="../../../../../org/eclipse/jetty/websocket/common/scopes/WebSocketSessionScope.html" title="interface in org.eclipse.jetty.websocket.common.scopes">WebSocketSessionScope</a>, <a href="../../../../../org/eclipse/jetty/websocket/api/extensions/IncomingFrames.html" title="interface in org.eclipse.jetty.websocket.api.extensions">IncomingFrames</a>, <a href="../../../../../org/eclipse/jetty/io/Connection.Listener.html" title="interface in org.eclipse.jetty.io">Connection.Listener</a>, <a href="../../../../../org/eclipse/jetty/websocket/common/io/IOState.ConnectionStateListener.html" title="interface in org.eclipse.jetty.websocket.common.io">IOState.ConnectionStateListener</a></pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Class and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static interface&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/common/WebSocketSession.Listener.html" title="interface in org.eclipse.jetty.websocket.common">WebSocketSession.Listener</a></span></code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="nested.classes.inherited.from.class.org.eclipse.jetty.util.component.AbstractLifeCycle">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from class&nbsp;org.eclipse.jetty.util.component.<a href="../../../../../org/eclipse/jetty/util/component/AbstractLifeCycle.html" title="class in org.eclipse.jetty.util.component">AbstractLifeCycle</a></h3>
<code><a href="../../../../../org/eclipse/jetty/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 name="nested.classes.inherited.from.class.org.eclipse.jetty.io.Connection.Listener">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface&nbsp;org.eclipse.jetty.io.<a href="../../../../../org/eclipse/jetty/io/Connection.Listener.html" title="interface in org.eclipse.jetty.io">Connection.Listener</a></h3>
<code><a href="../../../../../org/eclipse/jetty/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 name="nested.classes.inherited.from.class.org.eclipse.jetty.util.component.Container">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface&nbsp;org.eclipse.jetty.util.component.<a href="../../../../../org/eclipse/jetty/util/component/Container.html" title="interface in org.eclipse.jetty.util.component">Container</a></h3>
<code><a href="../../../../../org/eclipse/jetty/util/component/Container.InheritedListener.html" title="interface in org.eclipse.jetty.util.component">Container.InheritedListener</a></code></li>
</ul>
</li>
</ul>
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.eclipse.jetty.util.component.AbstractLifeCycle">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.eclipse.jetty.util.component.<a href="../../../../../org/eclipse/jetty/util/component/AbstractLifeCycle.html" title="class in org.eclipse.jetty.util.component">AbstractLifeCycle</a></h3>
<code><a href="../../../../../org/eclipse/jetty/util/component/AbstractLifeCycle.html#FAILED">FAILED</a>, <a href="../../../../../org/eclipse/jetty/util/component/AbstractLifeCycle.html#RUNNING">RUNNING</a>, <a href="../../../../../org/eclipse/jetty/util/component/AbstractLifeCycle.html#STARTED">STARTED</a>, <a href="../../../../../org/eclipse/jetty/util/component/AbstractLifeCycle.html#STARTING">STARTING</a>, <a href="../../../../../org/eclipse/jetty/util/component/AbstractLifeCycle.html#STOP_ON_FAILURE">STOP_ON_FAILURE</a>, <a href="../../../../../org/eclipse/jetty/util/component/AbstractLifeCycle.html#STOPPED">STOPPED</a>, <a href="../../../../../org/eclipse/jetty/util/component/AbstractLifeCycle.html#STOPPING">STOPPING</a></code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/common/WebSocketSession.html#WebSocketSession-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="../../../../../org/eclipse/jetty/websocket/common/scopes/WebSocketContainerScope.html" title="interface in org.eclipse.jetty.websocket.common.scopes">WebSocketContainerScope</a>&nbsp;containerScope,
java.net.URI&nbsp;requestURI,
<a href="../../../../../org/eclipse/jetty/websocket/common/events/EventDriver.html" title="interface in org.eclipse.jetty.websocket.common.events">EventDriver</a>&nbsp;websocket,
<a href="../../../../../org/eclipse/jetty/websocket/common/LogicalConnection.html" title="interface in org.eclipse.jetty.websocket.common">LogicalConnection</a>&nbsp;connection)</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/common/WebSocketSession.html#close--">close</a></span>()</code>
<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>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/common/WebSocketSession.html#close-org.eclipse.jetty.websocket.api.CloseStatus-">close</a></span>(<a href="../../../../../org/eclipse/jetty/websocket/api/CloseStatus.html" title="class in org.eclipse.jetty.websocket.api">CloseStatus</a>&nbsp;closeStatus)</code>
<div class="block">Request Close the current conversation, giving a reason for the closure.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/common/WebSocketSession.html#close-int-java.lang.String-">close</a></span>(int&nbsp;statusCode,
java.lang.String&nbsp;reason)</code>
<div class="block">Send a websocket Close frame, with status code.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/common/WebSocketSession.html#disconnect--">disconnect</a></span>()</code>
<div class="block">Harsh disconnect</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/common/WebSocketSession.html#dispatch-java.lang.Runnable-">dispatch</a></span>(java.lang.Runnable&nbsp;runnable)</code>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/common/WebSocketSession.html#doStart--">doStart</a></span>()</code>
<div class="block">Starts the managed lifecycle beans in the order they were added.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/common/WebSocketSession.html#doStop--">doStop</a></span>()</code>
<div class="block">Stops the managed lifecycle beans in the reverse order they were added.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/common/WebSocketSession.html#dump-java.lang.Appendable-java.lang.String-">dump</a></span>(java.lang.Appendable&nbsp;out,
java.lang.String&nbsp;indent)</code>&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/common/WebSocketSession.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object&nbsp;obj)</code>&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/eclipse/jetty/websocket/api/BatchMode.html" title="enum in org.eclipse.jetty.websocket.api">BatchMode</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/common/WebSocketSession.html#getBatchMode--">getBatchMode</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/eclipse/jetty/io/ByteBufferPool.html" title="interface in org.eclipse.jetty.io">ByteBufferPool</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/common/WebSocketSession.html#getBufferPool--">getBufferPool</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>java.lang.ClassLoader</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/common/WebSocketSession.html#getClassLoader--">getClassLoader</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/eclipse/jetty/websocket/common/LogicalConnection.html" title="interface in org.eclipse.jetty.websocket.common">LogicalConnection</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/common/WebSocketSession.html#getConnection--">getConnection</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/eclipse/jetty/websocket/common/scopes/WebSocketContainerScope.html" title="interface in org.eclipse.jetty.websocket.common.scopes">WebSocketContainerScope</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/common/WebSocketSession.html#getContainerScope--">getContainerScope</a></span>()</code>
<div class="block">The parent <a href="../../../../../org/eclipse/jetty/websocket/common/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="i14" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/eclipse/jetty/websocket/api/extensions/ExtensionFactory.html" title="class in org.eclipse.jetty.websocket.api.extensions">ExtensionFactory</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/common/WebSocketSession.html#getExtensionFactory--">getExtensionFactory</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/common/WebSocketSession.html#getIdleTimeout--">getIdleTimeout</a></span>()</code>
<div class="block">The idle timeout in milliseconds</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/eclipse/jetty/websocket/api/extensions/IncomingFrames.html" title="interface in org.eclipse.jetty.websocket.api.extensions">IncomingFrames</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/common/WebSocketSession.html#getIncomingHandler--">getIncomingHandler</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>java.net.InetSocketAddress</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/common/WebSocketSession.html#getLocalAddress--">getLocalAddress</a></span>()</code>
<div class="block">Get the address of the local side.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/eclipse/jetty/websocket/api/extensions/OutgoingFrames.html" title="interface in org.eclipse.jetty.websocket.api.extensions">OutgoingFrames</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/common/WebSocketSession.html#getOutgoingHandler--">getOutgoingHandler</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/eclipse/jetty/websocket/api/WebSocketPolicy.html" title="class in org.eclipse.jetty.websocket.api">WebSocketPolicy</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/common/WebSocketSession.html#getPolicy--">getPolicy</a></span>()</code>
<div class="block">Access the (now read-only) <a href="../../../../../org/eclipse/jetty/websocket/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="i20" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/common/WebSocketSession.html#getProtocolVersion--">getProtocolVersion</a></span>()</code>
<div class="block">Returns the version of the websocket protocol currently being used.</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/eclipse/jetty/websocket/api/RemoteEndpoint.html" title="interface in org.eclipse.jetty.websocket.api">RemoteEndpoint</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/common/WebSocketSession.html#getRemote--">getRemote</a></span>()</code>
<div class="block">Return a reference to the RemoteEndpoint object representing the other end of this conversation.</div>
</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code>java.net.InetSocketAddress</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/common/WebSocketSession.html#getRemoteAddress--">getRemoteAddress</a></span>()</code>
<div class="block">Get the address of the remote side.</div>
</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code>java.net.URI</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/common/WebSocketSession.html#getRequestURI--">getRequestURI</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/eclipse/jetty/websocket/api/UpgradeRequest.html" title="class in org.eclipse.jetty.websocket.api">UpgradeRequest</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/common/WebSocketSession.html#getUpgradeRequest--">getUpgradeRequest</a></span>()</code>
<div class="block">Get the UpgradeRequest used to create this session</div>
</td>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/eclipse/jetty/websocket/api/UpgradeResponse.html" title="class in org.eclipse.jetty.websocket.api">UpgradeResponse</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/common/WebSocketSession.html#getUpgradeResponse--">getUpgradeResponse</a></span>()</code>
<div class="block">Get the UpgradeResponse used to create this session</div>
</td>
</tr>
<tr id="i26" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/eclipse/jetty/websocket/common/WebSocketSession.html" title="class in org.eclipse.jetty.websocket.common">WebSocketSession</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/common/WebSocketSession.html#getWebSocketSession--">getWebSocketSession</a></span>()</code>
<div class="block">Active <a href="../../../../../org/eclipse/jetty/websocket/common/WebSocketSession.html" title="class in org.eclipse.jetty.websocket.common"><code>WebSocketSession</code></a> associated with this scope.</div>
</td>
</tr>
<tr id="i27" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/common/WebSocketSession.html#hashCode--">hashCode</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i28" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/common/WebSocketSession.html#incomingError-java.lang.Throwable-">incomingError</a></span>(java.lang.Throwable&nbsp;t)</code>
<div class="block">Incoming Errors from Parser</div>
</td>
</tr>
<tr id="i29" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/common/WebSocketSession.html#incomingFrame-org.eclipse.jetty.websocket.api.extensions.Frame-">incomingFrame</a></span>(<a href="../../../../../org/eclipse/jetty/websocket/api/extensions/Frame.html" title="interface in org.eclipse.jetty.websocket.api.extensions">Frame</a>&nbsp;frame)</code>
<div class="block">Incoming Raw Frames from Parser</div>
</td>
</tr>
<tr id="i30" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/common/WebSocketSession.html#isOpen--">isOpen</a></span>()</code>
<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>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/common/WebSocketSession.html#isSecure--">isSecure</a></span>()</code>
<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="../../../../../org/eclipse/jetty/websocket/common/WebSocketRemoteEndpoint.html" title="class in org.eclipse.jetty.websocket.common">WebSocketRemoteEndpoint</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/common/WebSocketSession.html#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="../../../../../org/eclipse/jetty/websocket/common/LogicalConnection.html" title="interface in org.eclipse.jetty.websocket.common">LogicalConnection</a>&nbsp;connection,
<a href="../../../../../org/eclipse/jetty/websocket/api/extensions/OutgoingFrames.html" title="interface in org.eclipse.jetty.websocket.api.extensions">OutgoingFrames</a>&nbsp;outgoingFrames,
<a href="../../../../../org/eclipse/jetty/websocket/api/BatchMode.html" title="enum in org.eclipse.jetty.websocket.api">BatchMode</a>&nbsp;batchMode)</code>&nbsp;</td>
</tr>
<tr id="i33" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/common/WebSocketSession.html#notifyClose-int-java.lang.String-">notifyClose</a></span>(int&nbsp;statusCode,
java.lang.String&nbsp;reason)</code>&nbsp;</td>
</tr>
<tr id="i34" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/common/WebSocketSession.html#notifyError-java.lang.Throwable-">notifyError</a></span>(java.lang.Throwable&nbsp;cause)</code>&nbsp;</td>
</tr>
<tr id="i35" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/common/WebSocketSession.html#onClosed-org.eclipse.jetty.io.Connection-">onClosed</a></span>(<a href="../../../../../org/eclipse/jetty/io/Connection.html" title="interface in org.eclipse.jetty.io">Connection</a>&nbsp;connection)</code>&nbsp;</td>
</tr>
<tr id="i36" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/common/WebSocketSession.html#onConnectionStateChange-org.eclipse.jetty.websocket.common.ConnectionState-">onConnectionStateChange</a></span>(<a href="../../../../../org/eclipse/jetty/websocket/common/ConnectionState.html" title="enum in org.eclipse.jetty.websocket.common">ConnectionState</a>&nbsp;state)</code>&nbsp;</td>
</tr>
<tr id="i37" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/common/WebSocketSession.html#onOpened-org.eclipse.jetty.io.Connection-">onOpened</a></span>(<a href="../../../../../org/eclipse/jetty/io/Connection.html" title="interface in org.eclipse.jetty.io">Connection</a>&nbsp;connection)</code>&nbsp;</td>
</tr>
<tr id="i38" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/common/WebSocketSession.html#open--">open</a></span>()</code>
<div class="block">Open/Activate the session</div>
</td>
</tr>
<tr id="i39" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/common/WebSocketSession.html#setExtensionFactory-org.eclipse.jetty.websocket.api.extensions.ExtensionFactory-">setExtensionFactory</a></span>(<a href="../../../../../org/eclipse/jetty/websocket/api/extensions/ExtensionFactory.html" title="class in org.eclipse.jetty.websocket.api.extensions">ExtensionFactory</a>&nbsp;extensionFactory)</code>&nbsp;</td>
</tr>
<tr id="i40" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/common/WebSocketSession.html#setIdleTimeout-long-">setIdleTimeout</a></span>(long&nbsp;ms)</code>
<div class="block">Set the timeout in milliseconds</div>
</td>
</tr>
<tr id="i41" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/common/WebSocketSession.html#setOutgoingHandler-org.eclipse.jetty.websocket.api.extensions.OutgoingFrames-">setOutgoingHandler</a></span>(<a href="../../../../../org/eclipse/jetty/websocket/api/extensions/OutgoingFrames.html" title="interface in org.eclipse.jetty.websocket.api.extensions">OutgoingFrames</a>&nbsp;outgoing)</code>&nbsp;</td>
</tr>
<tr id="i42" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/common/WebSocketSession.html#setPolicy-org.eclipse.jetty.websocket.api.WebSocketPolicy-">setPolicy</a></span>(<a href="../../../../../org/eclipse/jetty/websocket/api/WebSocketPolicy.html" title="class in org.eclipse.jetty.websocket.api">WebSocketPolicy</a>&nbsp;policy)</code>&nbsp;</td>
</tr>
<tr id="i43" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/common/WebSocketSession.html#setUpgradeRequest-org.eclipse.jetty.websocket.api.UpgradeRequest-">setUpgradeRequest</a></span>(<a href="../../../../../org/eclipse/jetty/websocket/api/UpgradeRequest.html" title="class in org.eclipse.jetty.websocket.api">UpgradeRequest</a>&nbsp;request)</code>&nbsp;</td>
</tr>
<tr id="i44" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/common/WebSocketSession.html#setUpgradeResponse-org.eclipse.jetty.websocket.api.UpgradeResponse-">setUpgradeResponse</a></span>(<a href="../../../../../org/eclipse/jetty/websocket/api/UpgradeResponse.html" title="class in org.eclipse.jetty.websocket.api">UpgradeResponse</a>&nbsp;response)</code>&nbsp;</td>
</tr>
<tr id="i45" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/eclipse/jetty/websocket/api/SuspendToken.html" title="interface in org.eclipse.jetty.websocket.api">SuspendToken</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/common/WebSocketSession.html#suspend--">suspend</a></span>()</code>
<div class="block">Suspend a the incoming read events on the connection.</div>
</td>
</tr>
<tr id="i46" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/common/WebSocketSession.html#toString--">toString</a></span>()</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.eclipse.jetty.util.component.ContainerLifeCycle">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.eclipse.jetty.util.component.<a href="../../../../../org/eclipse/jetty/util/component/ContainerLifeCycle.html" title="class in org.eclipse.jetty.util.component">ContainerLifeCycle</a></h3>
<code><a href="../../../../../org/eclipse/jetty/util/component/ContainerLifeCycle.html#addBean-java.lang.Object-">addBean</a>, <a href="../../../../../org/eclipse/jetty/util/component/ContainerLifeCycle.html#addBean-java.lang.Object-boolean-">addBean</a>, <a href="../../../../../org/eclipse/jetty/util/component/ContainerLifeCycle.html#addBean-java.lang.Object-org.eclipse.jetty.util.component.ContainerLifeCycle.Managed-">addBean</a>, <a href="../../../../../org/eclipse/jetty/util/component/ContainerLifeCycle.html#addEventListener-org.eclipse.jetty.util.component.Container.Listener-">addEventListener</a>, <a href="../../../../../org/eclipse/jetty/util/component/ContainerLifeCycle.html#addManaged-org.eclipse.jetty.util.component.LifeCycle-">addManaged</a>, <a href="../../../../../org/eclipse/jetty/util/component/ContainerLifeCycle.html#contains-java.lang.Object-">contains</a>, <a href="../../../../../org/eclipse/jetty/util/component/ContainerLifeCycle.html#destroy--">destroy</a>, <a href="../../../../../org/eclipse/jetty/util/component/ContainerLifeCycle.html#dump--">dump</a>, <a href="../../../../../org/eclipse/jetty/util/component/ContainerLifeCycle.html#dump-java.lang.Appendable-">dump</a>, <a href="../../../../../org/eclipse/jetty/util/component/ContainerLifeCycle.html#dump-java.lang.Appendable-java.lang.String-java.util.Collection...-">dump</a>, <a href="../../../../../org/eclipse/jetty/util/component/ContainerLifeCycle.html#dump-org.eclipse.jetty.util.component.Dumpable-">dump</a>, <a href="../../../../../org/eclipse/jetty/util/component/ContainerLifeCycle.html#dumpBeans-java.lang.Appendable-java.lang.String-java.util.Collection...-">dumpBeans</a>, <a href="../../../../../org/eclipse/jetty/util/component/ContainerLifeCycle.html#dumpObject-java.lang.Appendable-java.lang.Object-">dumpObject</a>, <a href="../../../../../org/eclipse/jetty/util/component/ContainerLifeCycle.html#dumpStdErr--">dumpStdErr</a>, <a href="../../../../../org/eclipse/jetty/util/component/ContainerLifeCycle.html#dumpThis-java.lang.Appendable-">dumpThis</a>, <a href="../../../../../org/eclipse/jetty/util/component/ContainerLifeCycle.html#getBean-java.lang.Class-">getBean</a>, <a href="../../../../../org/eclipse/jetty/util/component/ContainerLifeCycle.html#getBeans--">getBeans</a>, <a href="../../../../../org/eclipse/jetty/util/component/ContainerLifeCycle.html#getBeans-java.lang.Class-">getBeans</a>, <a href="../../../../../org/eclipse/jetty/util/component/ContainerLifeCycle.html#isManaged-java.lang.Object-">isManaged</a>, <a href="../../../../../org/eclipse/jetty/util/component/ContainerLifeCycle.html#manage-java.lang.Object-">manage</a>, <a href="../../../../../org/eclipse/jetty/util/component/ContainerLifeCycle.html#removeBean-java.lang.Object-">removeBean</a>, <a href="../../../../../org/eclipse/jetty/util/component/ContainerLifeCycle.html#removeBeans--">removeBeans</a>, <a href="../../../../../org/eclipse/jetty/util/component/ContainerLifeCycle.html#removeEventListener-org.eclipse.jetty.util.component.Container.Listener-">removeEventListener</a>, <a href="../../../../../org/eclipse/jetty/util/component/ContainerLifeCycle.html#setBeans-java.util.Collection-">setBeans</a>, <a href="../../../../../org/eclipse/jetty/util/component/ContainerLifeCycle.html#setStopTimeout-long-">setStopTimeout</a>, <a href="../../../../../org/eclipse/jetty/util/component/ContainerLifeCycle.html#start-org.eclipse.jetty.util.component.LifeCycle-">start</a>, <a href="../../../../../org/eclipse/jetty/util/component/ContainerLifeCycle.html#stop-org.eclipse.jetty.util.component.LifeCycle-">stop</a>, <a href="../../../../../org/eclipse/jetty/util/component/ContainerLifeCycle.html#unmanage-java.lang.Object-">unmanage</a>, <a href="../../../../../org/eclipse/jetty/util/component/ContainerLifeCycle.html#updateBean-java.lang.Object-java.lang.Object-">updateBean</a>, <a href="../../../../../org/eclipse/jetty/util/component/ContainerLifeCycle.html#updateBean-java.lang.Object-java.lang.Object-boolean-">updateBean</a>, <a href="../../../../../org/eclipse/jetty/util/component/ContainerLifeCycle.html#updateBeans-java.lang.Object:A-java.lang.Object:A-">updateBeans</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.eclipse.jetty.util.component.AbstractLifeCycle">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.eclipse.jetty.util.component.<a href="../../../../../org/eclipse/jetty/util/component/AbstractLifeCycle.html" title="class in org.eclipse.jetty.util.component">AbstractLifeCycle</a></h3>
<code><a href="../../../../../org/eclipse/jetty/util/component/AbstractLifeCycle.html#addLifeCycleListener-org.eclipse.jetty.util.component.LifeCycle.Listener-">addLifeCycleListener</a>, <a href="../../../../../org/eclipse/jetty/util/component/AbstractLifeCycle.html#getState--">getState</a>, <a href="../../../../../org/eclipse/jetty/util/component/AbstractLifeCycle.html#getState-org.eclipse.jetty.util.component.LifeCycle-">getState</a>, <a href="../../../../../org/eclipse/jetty/util/component/AbstractLifeCycle.html#getStopTimeout--">getStopTimeout</a>, <a href="../../../../../org/eclipse/jetty/util/component/AbstractLifeCycle.html#isFailed--">isFailed</a>, <a href="../../../../../org/eclipse/jetty/util/component/AbstractLifeCycle.html#isRunning--">isRunning</a>, <a href="../../../../../org/eclipse/jetty/util/component/AbstractLifeCycle.html#isStarted--">isStarted</a>, <a href="../../../../../org/eclipse/jetty/util/component/AbstractLifeCycle.html#isStarting--">isStarting</a>, <a href="../../../../../org/eclipse/jetty/util/component/AbstractLifeCycle.html#isStopped--">isStopped</a>, <a href="../../../../../org/eclipse/jetty/util/component/AbstractLifeCycle.html#isStopping--">isStopping</a>, <a href="../../../../../org/eclipse/jetty/util/component/AbstractLifeCycle.html#removeLifeCycleListener-org.eclipse.jetty.util.component.LifeCycle.Listener-">removeLifeCycleListener</a>, <a href="../../../../../org/eclipse/jetty/util/component/AbstractLifeCycle.html#start--">start</a>, <a href="../../../../../org/eclipse/jetty/util/component/AbstractLifeCycle.html#stop--">stop</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, finalize, getClass, notify, notifyAll, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="WebSocketSession-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&nbsp;WebSocketSession(<a href="../../../../../org/eclipse/jetty/websocket/common/scopes/WebSocketContainerScope.html" title="interface in org.eclipse.jetty.websocket.common.scopes">WebSocketContainerScope</a>&nbsp;containerScope,
java.net.URI&nbsp;requestURI,
<a href="../../../../../org/eclipse/jetty/websocket/common/events/EventDriver.html" title="interface in org.eclipse.jetty.websocket.common.events">EventDriver</a>&nbsp;websocket,
<a href="../../../../../org/eclipse/jetty/websocket/common/LogicalConnection.html" title="interface in org.eclipse.jetty.websocket.common">LogicalConnection</a>&nbsp;connection)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="close--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>close</h4>
<pre>public&nbsp;void&nbsp;close()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/eclipse/jetty/websocket/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>&nbsp;in interface&nbsp;<code>java.io.Closeable</code></dd>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>close</code>&nbsp;in interface&nbsp;<code>java.lang.AutoCloseable</code></dd>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/eclipse/jetty/websocket/api/Session.html#close--">close</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/eclipse/jetty/websocket/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="../../../../../org/eclipse/jetty/websocket/api/Session.html#close-org.eclipse.jetty.websocket.api.CloseStatus-"><code>Session.close(CloseStatus)</code></a>,
<a href="../../../../../org/eclipse/jetty/websocket/api/Session.html#close-int-java.lang.String-"><code>Session.close(int, String)</code></a>,
<a href="../../../../../org/eclipse/jetty/websocket/api/Session.html#disconnect--"><code>Session.disconnect()</code></a></dd>
</dl>
</li>
</ul>
<a name="close-org.eclipse.jetty.websocket.api.CloseStatus-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>close</h4>
<pre>public&nbsp;void&nbsp;close(<a href="../../../../../org/eclipse/jetty/websocket/api/CloseStatus.html" title="class in org.eclipse.jetty.websocket.api">CloseStatus</a>&nbsp;closeStatus)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/eclipse/jetty/websocket/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="../../../../../org/eclipse/jetty/websocket/api/Session.html#close-org.eclipse.jetty.websocket.api.CloseStatus-">close</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/eclipse/jetty/websocket/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="../../../../../org/eclipse/jetty/websocket/api/Session.html#close--"><code>Session.close()</code></a>,
<a href="../../../../../org/eclipse/jetty/websocket/api/Session.html#close-int-java.lang.String-"><code>Session.close(int, String)</code></a>,
<a href="../../../../../org/eclipse/jetty/websocket/api/Session.html#disconnect--"><code>Session.disconnect()</code></a></dd>
</dl>
</li>
</ul>
<a name="close-int-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>close</h4>
<pre>public&nbsp;void&nbsp;close(int&nbsp;statusCode,
java.lang.String&nbsp;reason)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/eclipse/jetty/websocket/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="../../../../../org/eclipse/jetty/websocket/api/Session.html#close-int-java.lang.String-">close</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/eclipse/jetty/websocket/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="../../../../../org/eclipse/jetty/websocket/api/StatusCode.html" title="class in org.eclipse.jetty.websocket.api"><code>StatusCode</code></a>,
<a href="../../../../../org/eclipse/jetty/websocket/api/Session.html#close--"><code>Session.close()</code></a>,
<a href="../../../../../org/eclipse/jetty/websocket/api/Session.html#close-org.eclipse.jetty.websocket.api.CloseStatus-"><code>Session.close(CloseStatus)</code></a>,
<a href="../../../../../org/eclipse/jetty/websocket/api/Session.html#disconnect--"><code>Session.disconnect()</code></a></dd>
</dl>
</li>
</ul>
<a name="disconnect--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>disconnect</h4>
<pre>public&nbsp;void&nbsp;disconnect()</pre>
<div class="block">Harsh disconnect</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/eclipse/jetty/websocket/api/Session.html#disconnect--">disconnect</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/eclipse/jetty/websocket/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="../../../../../org/eclipse/jetty/websocket/api/Session.html#close--"><code>Session.close()</code></a>,
<a href="../../../../../org/eclipse/jetty/websocket/api/Session.html#close-org.eclipse.jetty.websocket.api.CloseStatus-"><code>Session.close(CloseStatus)</code></a>,
<a href="../../../../../org/eclipse/jetty/websocket/api/Session.html#close-int-java.lang.String-"><code>Session.close(int, String)</code></a>,
<a href="../../../../../org/eclipse/jetty/websocket/api/Session.html#disconnect--"><code>Session.disconnect()</code></a></dd>
</dl>
</li>
</ul>
<a name="dispatch-java.lang.Runnable-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>dispatch</h4>
<pre>public&nbsp;void&nbsp;dispatch(java.lang.Runnable&nbsp;runnable)</pre>
</li>
</ul>
<a name="doStart--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>doStart</h4>
<pre>protected&nbsp;void&nbsp;doStart()
throws java.lang.Exception</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/eclipse/jetty/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="../../../../../org/eclipse/jetty/util/component/ContainerLifeCycle.html#doStart--">doStart</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/eclipse/jetty/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 name="doStop--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>doStop</h4>
<pre>protected&nbsp;void&nbsp;doStop()
throws java.lang.Exception</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/eclipse/jetty/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="../../../../../org/eclipse/jetty/util/component/ContainerLifeCycle.html#doStop--">doStop</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/eclipse/jetty/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 name="dump-java.lang.Appendable-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>dump</h4>
<pre>public&nbsp;void&nbsp;dump(java.lang.Appendable&nbsp;out,
java.lang.String&nbsp;indent)
throws java.io.IOException</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/eclipse/jetty/util/component/Dumpable.html#dump-java.lang.Appendable-java.lang.String-">dump</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/eclipse/jetty/util/component/Dumpable.html" title="interface in org.eclipse.jetty.util.component">Dumpable</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/eclipse/jetty/util/component/ContainerLifeCycle.html#dump-java.lang.Appendable-java.lang.String-">dump</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/eclipse/jetty/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.io.IOException</code></dd>
</dl>
</li>
</ul>
<a name="equals-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>equals</h4>
<pre>public&nbsp;boolean&nbsp;equals(java.lang.Object&nbsp;obj)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>equals</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
<a name="getBufferPool--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBufferPool</h4>
<pre>public&nbsp;<a href="../../../../../org/eclipse/jetty/io/ByteBufferPool.html" title="interface in org.eclipse.jetty.io">ByteBufferPool</a>&nbsp;getBufferPool()</pre>
</li>
</ul>
<a name="getClassLoader--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getClassLoader</h4>
<pre>public&nbsp;java.lang.ClassLoader&nbsp;getClassLoader()</pre>
</li>
</ul>
<a name="getConnection--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConnection</h4>
<pre>public&nbsp;<a href="../../../../../org/eclipse/jetty/websocket/common/LogicalConnection.html" title="interface in org.eclipse.jetty.websocket.common">LogicalConnection</a>&nbsp;getConnection()</pre>
</li>
</ul>
<a name="getContainerScope--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getContainerScope</h4>
<pre>public&nbsp;<a href="../../../../../org/eclipse/jetty/websocket/common/scopes/WebSocketContainerScope.html" title="interface in org.eclipse.jetty.websocket.common.scopes">WebSocketContainerScope</a>&nbsp;getContainerScope()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/eclipse/jetty/websocket/common/scopes/WebSocketSessionScope.html#getContainerScope--">WebSocketSessionScope</a></code></span></div>
<div class="block">The parent <a href="../../../../../org/eclipse/jetty/websocket/common/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="../../../../../org/eclipse/jetty/websocket/common/scopes/WebSocketSessionScope.html#getContainerScope--">getContainerScope</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/eclipse/jetty/websocket/common/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 name="getExtensionFactory--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getExtensionFactory</h4>
<pre>public&nbsp;<a href="../../../../../org/eclipse/jetty/websocket/api/extensions/ExtensionFactory.html" title="class in org.eclipse.jetty.websocket.api.extensions">ExtensionFactory</a>&nbsp;getExtensionFactory()</pre>
</li>
</ul>
<a name="getIdleTimeout--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getIdleTimeout</h4>
<pre>public&nbsp;long&nbsp;getIdleTimeout()</pre>
<div class="block">The idle timeout in milliseconds</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/eclipse/jetty/websocket/api/Session.html#getIdleTimeout--">getIdleTimeout</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/eclipse/jetty/websocket/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 name="getIncomingHandler--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getIncomingHandler</h4>
<pre><a href="../../../../../org/eclipse/jetty/util/annotation/ManagedAttribute.html" title="annotation in org.eclipse.jetty.util.annotation">@ManagedAttribute</a>(<a href="../../../../../org/eclipse/jetty/util/annotation/ManagedAttribute.html#readonly--">readonly</a>=true)
public&nbsp;<a href="../../../../../org/eclipse/jetty/websocket/api/extensions/IncomingFrames.html" title="interface in org.eclipse.jetty.websocket.api.extensions">IncomingFrames</a>&nbsp;getIncomingHandler()</pre>
</li>
</ul>
<a name="getLocalAddress--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLocalAddress</h4>
<pre>public&nbsp;java.net.InetSocketAddress&nbsp;getLocalAddress()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/eclipse/jetty/websocket/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="../../../../../org/eclipse/jetty/websocket/api/Session.html#getLocalAddress--">getLocalAddress</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/eclipse/jetty/websocket/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 name="getOutgoingHandler--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOutgoingHandler</h4>
<pre><a href="../../../../../org/eclipse/jetty/util/annotation/ManagedAttribute.html" title="annotation in org.eclipse.jetty.util.annotation">@ManagedAttribute</a>(<a href="../../../../../org/eclipse/jetty/util/annotation/ManagedAttribute.html#readonly--">readonly</a>=true)
public&nbsp;<a href="../../../../../org/eclipse/jetty/websocket/api/extensions/OutgoingFrames.html" title="interface in org.eclipse.jetty.websocket.api.extensions">OutgoingFrames</a>&nbsp;getOutgoingHandler()</pre>
</li>
</ul>
<a name="getPolicy--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPolicy</h4>
<pre>public&nbsp;<a href="../../../../../org/eclipse/jetty/websocket/api/WebSocketPolicy.html" title="class in org.eclipse.jetty.websocket.api">WebSocketPolicy</a>&nbsp;getPolicy()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/eclipse/jetty/websocket/api/Session.html#getPolicy--">Session</a></code></span></div>
<div class="block">Access the (now read-only) <a href="../../../../../org/eclipse/jetty/websocket/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="../../../../../org/eclipse/jetty/websocket/api/Session.html#getPolicy--">getPolicy</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/eclipse/jetty/websocket/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 name="getProtocolVersion--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getProtocolVersion</h4>
<pre>public&nbsp;java.lang.String&nbsp;getProtocolVersion()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/eclipse/jetty/websocket/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="../../../../../org/eclipse/jetty/websocket/api/Session.html#getProtocolVersion--">getProtocolVersion</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/eclipse/jetty/websocket/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 name="getRemote--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRemote</h4>
<pre>public&nbsp;<a href="../../../../../org/eclipse/jetty/websocket/api/RemoteEndpoint.html" title="interface in org.eclipse.jetty.websocket.api">RemoteEndpoint</a>&nbsp;getRemote()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/eclipse/jetty/websocket/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="../../../../../org/eclipse/jetty/websocket/api/Session.html#getRemote--">getRemote</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/eclipse/jetty/websocket/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 name="getRemoteAddress--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRemoteAddress</h4>
<pre>public&nbsp;java.net.InetSocketAddress&nbsp;getRemoteAddress()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/eclipse/jetty/websocket/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="../../../../../org/eclipse/jetty/websocket/api/Session.html#getRemoteAddress--">getRemoteAddress</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/eclipse/jetty/websocket/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 name="getRequestURI--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRequestURI</h4>
<pre>public&nbsp;java.net.URI&nbsp;getRequestURI()</pre>
</li>
</ul>
<a name="getUpgradeRequest--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUpgradeRequest</h4>
<pre>public&nbsp;<a href="../../../../../org/eclipse/jetty/websocket/api/UpgradeRequest.html" title="class in org.eclipse.jetty.websocket.api">UpgradeRequest</a>&nbsp;getUpgradeRequest()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/eclipse/jetty/websocket/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="../../../../../org/eclipse/jetty/websocket/api/Session.html#getUpgradeRequest--">getUpgradeRequest</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/eclipse/jetty/websocket/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 name="getUpgradeResponse--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUpgradeResponse</h4>
<pre>public&nbsp;<a href="../../../../../org/eclipse/jetty/websocket/api/UpgradeResponse.html" title="class in org.eclipse.jetty.websocket.api">UpgradeResponse</a>&nbsp;getUpgradeResponse()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/eclipse/jetty/websocket/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="../../../../../org/eclipse/jetty/websocket/api/Session.html#getUpgradeResponse--">getUpgradeResponse</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/eclipse/jetty/websocket/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 name="getWebSocketSession--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getWebSocketSession</h4>
<pre>public&nbsp;<a href="../../../../../org/eclipse/jetty/websocket/common/WebSocketSession.html" title="class in org.eclipse.jetty.websocket.common">WebSocketSession</a>&nbsp;getWebSocketSession()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/eclipse/jetty/websocket/common/scopes/WebSocketSessionScope.html#getWebSocketSession--">WebSocketSessionScope</a></code></span></div>
<div class="block">Active <a href="../../../../../org/eclipse/jetty/websocket/common/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="../../../../../org/eclipse/jetty/websocket/common/scopes/WebSocketSessionScope.html#getWebSocketSession--">getWebSocketSession</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/eclipse/jetty/websocket/common/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 name="hashCode--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hashCode</h4>
<pre>public&nbsp;int&nbsp;hashCode()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>hashCode</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
<a name="incomingError-java.lang.Throwable-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>incomingError</h4>
<pre>public&nbsp;void&nbsp;incomingError(java.lang.Throwable&nbsp;t)</pre>
<div class="block">Incoming Errors from Parser</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/eclipse/jetty/websocket/api/extensions/IncomingFrames.html#incomingError-java.lang.Throwable-">incomingError</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/eclipse/jetty/websocket/api/extensions/IncomingFrames.html" title="interface in org.eclipse.jetty.websocket.api.extensions">IncomingFrames</a></code></dd>
</dl>
</li>
</ul>
<a name="incomingFrame-org.eclipse.jetty.websocket.api.extensions.Frame-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>incomingFrame</h4>
<pre>public&nbsp;void&nbsp;incomingFrame(<a href="../../../../../org/eclipse/jetty/websocket/api/extensions/Frame.html" title="interface in org.eclipse.jetty.websocket.api.extensions">Frame</a>&nbsp;frame)</pre>
<div class="block">Incoming Raw Frames from Parser</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/eclipse/jetty/websocket/api/extensions/IncomingFrames.html#incomingFrame-org.eclipse.jetty.websocket.api.extensions.Frame-">incomingFrame</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/eclipse/jetty/websocket/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 name="isOpen--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isOpen</h4>
<pre>public&nbsp;boolean&nbsp;isOpen()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/eclipse/jetty/websocket/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="../../../../../org/eclipse/jetty/websocket/api/Session.html#isOpen--">isOpen</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/eclipse/jetty/websocket/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 name="isSecure--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isSecure</h4>
<pre>public&nbsp;boolean&nbsp;isSecure()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/eclipse/jetty/websocket/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="../../../../../org/eclipse/jetty/websocket/api/Session.html#isSecure--">isSecure</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/eclipse/jetty/websocket/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 name="notifyClose-int-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>notifyClose</h4>
<pre>public&nbsp;void&nbsp;notifyClose(int&nbsp;statusCode,
java.lang.String&nbsp;reason)</pre>
</li>
</ul>
<a name="notifyError-java.lang.Throwable-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>notifyError</h4>
<pre>public&nbsp;void&nbsp;notifyError(java.lang.Throwable&nbsp;cause)</pre>
</li>
</ul>
<a name="onClosed-org.eclipse.jetty.io.Connection-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>onClosed</h4>
<pre>public&nbsp;void&nbsp;onClosed(<a href="../../../../../org/eclipse/jetty/io/Connection.html" title="interface in org.eclipse.jetty.io">Connection</a>&nbsp;connection)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/eclipse/jetty/io/Connection.Listener.html#onClosed-org.eclipse.jetty.io.Connection-">onClosed</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/eclipse/jetty/io/Connection.Listener.html" title="interface in org.eclipse.jetty.io">Connection.Listener</a></code></dd>
</dl>
</li>
</ul>
<a name="onOpened-org.eclipse.jetty.io.Connection-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>onOpened</h4>
<pre>public&nbsp;void&nbsp;onOpened(<a href="../../../../../org/eclipse/jetty/io/Connection.html" title="interface in org.eclipse.jetty.io">Connection</a>&nbsp;connection)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/eclipse/jetty/io/Connection.Listener.html#onOpened-org.eclipse.jetty.io.Connection-">onOpened</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/eclipse/jetty/io/Connection.Listener.html" title="interface in org.eclipse.jetty.io">Connection.Listener</a></code></dd>
</dl>
</li>
</ul>
<a name="onConnectionStateChange-org.eclipse.jetty.websocket.common.ConnectionState-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>onConnectionStateChange</h4>
<pre>public&nbsp;void&nbsp;onConnectionStateChange(<a href="../../../../../org/eclipse/jetty/websocket/common/ConnectionState.html" title="enum in org.eclipse.jetty.websocket.common">ConnectionState</a>&nbsp;state)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/eclipse/jetty/websocket/common/io/IOState.ConnectionStateListener.html#onConnectionStateChange-org.eclipse.jetty.websocket.common.ConnectionState-">onConnectionStateChange</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/eclipse/jetty/websocket/common/io/IOState.ConnectionStateListener.html" title="interface in org.eclipse.jetty.websocket.common.io">IOState.ConnectionStateListener</a></code></dd>
</dl>
</li>
</ul>
<a name="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>public&nbsp;<a href="../../../../../org/eclipse/jetty/websocket/common/WebSocketRemoteEndpoint.html" title="class in org.eclipse.jetty.websocket.common">WebSocketRemoteEndpoint</a>&nbsp;newRemoteEndpoint(<a href="../../../../../org/eclipse/jetty/websocket/common/LogicalConnection.html" title="interface in org.eclipse.jetty.websocket.common">LogicalConnection</a>&nbsp;connection,
<a href="../../../../../org/eclipse/jetty/websocket/api/extensions/OutgoingFrames.html" title="interface in org.eclipse.jetty.websocket.api.extensions">OutgoingFrames</a>&nbsp;outgoingFrames,
<a href="../../../../../org/eclipse/jetty/websocket/api/BatchMode.html" title="enum in org.eclipse.jetty.websocket.api">BatchMode</a>&nbsp;batchMode)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/eclipse/jetty/websocket/common/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>&nbsp;in interface&nbsp;<code><a href="../../../../../org/eclipse/jetty/websocket/common/RemoteEndpointFactory.html" title="interface in org.eclipse.jetty.websocket.common">RemoteEndpointFactory</a></code></dd>
</dl>
</li>
</ul>
<a name="open--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>open</h4>
<pre>public&nbsp;void&nbsp;open()</pre>
<div class="block">Open/Activate the session</div>
</li>
</ul>
<a name="setExtensionFactory-org.eclipse.jetty.websocket.api.extensions.ExtensionFactory-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setExtensionFactory</h4>
<pre>public&nbsp;void&nbsp;setExtensionFactory(<a href="../../../../../org/eclipse/jetty/websocket/api/extensions/ExtensionFactory.html" title="class in org.eclipse.jetty.websocket.api.extensions">ExtensionFactory</a>&nbsp;extensionFactory)</pre>
</li>
</ul>
<a name="setIdleTimeout-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setIdleTimeout</h4>
<pre>public&nbsp;void&nbsp;setIdleTimeout(long&nbsp;ms)</pre>
<div class="block">Set the timeout in milliseconds</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/eclipse/jetty/websocket/api/Session.html#setIdleTimeout-long-">setIdleTimeout</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/eclipse/jetty/websocket/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 name="setOutgoingHandler-org.eclipse.jetty.websocket.api.extensions.OutgoingFrames-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setOutgoingHandler</h4>
<pre>public&nbsp;void&nbsp;setOutgoingHandler(<a href="../../../../../org/eclipse/jetty/websocket/api/extensions/OutgoingFrames.html" title="interface in org.eclipse.jetty.websocket.api.extensions">OutgoingFrames</a>&nbsp;outgoing)</pre>
</li>
</ul>
<a name="setPolicy-org.eclipse.jetty.websocket.api.WebSocketPolicy-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPolicy</h4>
<pre>public&nbsp;void&nbsp;setPolicy(<a href="../../../../../org/eclipse/jetty/websocket/api/WebSocketPolicy.html" title="class in org.eclipse.jetty.websocket.api">WebSocketPolicy</a>&nbsp;policy)</pre>
</li>
</ul>
<a name="setUpgradeRequest-org.eclipse.jetty.websocket.api.UpgradeRequest-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setUpgradeRequest</h4>
<pre>public&nbsp;void&nbsp;setUpgradeRequest(<a href="../../../../../org/eclipse/jetty/websocket/api/UpgradeRequest.html" title="class in org.eclipse.jetty.websocket.api">UpgradeRequest</a>&nbsp;request)</pre>
</li>
</ul>
<a name="setUpgradeResponse-org.eclipse.jetty.websocket.api.UpgradeResponse-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setUpgradeResponse</h4>
<pre>public&nbsp;void&nbsp;setUpgradeResponse(<a href="../../../../../org/eclipse/jetty/websocket/api/UpgradeResponse.html" title="class in org.eclipse.jetty.websocket.api">UpgradeResponse</a>&nbsp;response)</pre>
</li>
</ul>
<a name="suspend--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>suspend</h4>
<pre>public&nbsp;<a href="../../../../../org/eclipse/jetty/websocket/api/SuspendToken.html" title="interface in org.eclipse.jetty.websocket.api">SuspendToken</a>&nbsp;suspend()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/eclipse/jetty/websocket/api/Session.html#suspend--">Session</a></code></span></div>
<div class="block">Suspend a the incoming read events on the connection.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/eclipse/jetty/websocket/api/Session.html#suspend--">suspend</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/eclipse/jetty/websocket/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 name="getBatchMode--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBatchMode</h4>
<pre>public&nbsp;<a href="../../../../../org/eclipse/jetty/websocket/api/BatchMode.html" title="enum in org.eclipse.jetty.websocket.api">BatchMode</a>&nbsp;getBatchMode()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the default (initial) value for the batching mode.</dd>
</dl>
</li>
</ul>
<a name="toString--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre>public&nbsp;java.lang.String&nbsp;toString()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.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">
<li><a href="../../../../../org/eclipse/jetty/websocket/common/WebSocketRemoteEndpoint.html" title="class in org.eclipse.jetty.websocket.common"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/eclipse/jetty/websocket/common/WebSocketSession.Listener.html" title="interface in org.eclipse.jetty.websocket.common"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/eclipse/jetty/websocket/common/WebSocketSession.html" target="_top">Frames</a></li>
<li><a href="WebSocketSession.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;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>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#fields.inherited.from.class.org.eclipse.jetty.util.component.AbstractLifeCycle">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 1995&#x2013;2018 <a href="http://webtide.com">Webtide</a>. All rights reserved.</small></p>
</body>
</html>