Google Git
Sign in
eclipse / www.eclipse.org / jetty / a3b2b46b70ed9bbe40e975355658f1bbe73bbc32 / . / javadoc / jetty-10 / org / eclipse / jetty / websocket / common / WebSocketSession.html
blob: 731e23d48c484031efae2bb741e0c01f125d8295 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.11) on Mon Jun 14 16:40:44 EDT 2021 -->
<title>WebSocketSession (Eclipse Jetty API Doc - v10.0.5)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2021-06-14">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../../jquery/jquery-3.5.1.js"></script>
<script type="text/javascript" src="../../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="WebSocketSession (Eclipse Jetty API Doc - v10.0.5)";
}
}
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};
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";
var pathtoroot = "../../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/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&nbsp;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:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">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 id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</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>&nbsp;<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>org.eclipse.jetty.websocket.common.WebSocketSession</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="../../util/component/Dumpable.html" title="interface in org.eclipse.jetty.util.component">Dumpable</a></code>, <code><a href="../api/Session.html" title="interface in org.eclipse.jetty.websocket.api">Session</a></code>, <code><a href="../api/SuspendToken.html" title="interface in org.eclipse.jetty.websocket.api">SuspendToken</a></code>, <code><a href="../api/WebSocketPolicy.html" title="interface in org.eclipse.jetty.websocket.api">WebSocketPolicy</a></code></dd>
</dl>
<hr>
<pre>public class <span class="typeNameLabel">WebSocketSession</span>
extends java.lang.Object
implements <a href="../api/Session.html" title="interface in org.eclipse.jetty.websocket.api">Session</a>, <a href="../api/SuspendToken.html" title="interface in org.eclipse.jetty.websocket.api">SuspendToken</a>, <a href="../../util/component/Dumpable.html" title="interface in org.eclipse.jetty.util.component">Dumpable</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.Dumpable">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface&nbsp;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>
</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.Dumpable">
<!-- -->
</a>
<h3>Fields inherited from interface&nbsp;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">&nbsp;</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.api.WebSocketContainer,org.eclipse.jetty.websocket.core.CoreSession,org.eclipse.jetty.websocket.common.JettyWebSocketFrameHandler)">WebSocketSession</a></span>&#8203;(<a href="../api/WebSocketContainer.html" title="interface in org.eclipse.jetty.websocket.api">WebSocketContainer</a>&nbsp;container,
<a href="../core/CoreSession.html" title="interface in org.eclipse.jetty.websocket.core">CoreSession</a>&nbsp;coreSession,
<a href="JettyWebSocketFrameHandler.html" title="class in org.eclipse.jetty.websocket.common">JettyWebSocketFrameHandler</a>&nbsp;frameHandler)</code></th>
<td class="colLast">&nbsp;</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">&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="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#close()">close</a></span>()</code></th>
<td class="colLast">
<div class="block">Request a close of the current conversation with a normal status code and no reason phrase.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#close(int,java.lang.String)">close</a></span>&#8203;(int&nbsp;statusCode,
java.lang.String&nbsp;reason)</code></th>
<td class="colLast">
<div class="block">Send a websocket Close frame, with status code.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#close(org.eclipse.jetty.websocket.api.CloseStatus)">close</a></span>&#8203;(<a href="../api/CloseStatus.html" title="class in org.eclipse.jetty.websocket.api">CloseStatus</a>&nbsp;closeStatus)</code></th>
<td class="colLast">
<div class="block">Request Close the current conversation, giving a reason for the closure.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#disconnect()">disconnect</a></span>()</code></th>
<td class="colLast">
<div class="block">Issue a harsh disconnect of the underlying connection.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#dump(java.lang.Appendable,java.lang.String)">dump</a></span>&#8203;(java.lang.Appendable&nbsp;out,
java.lang.String&nbsp;indent)</code></th>
<td class="colLast">
<div class="block">Dump this object (and children) into an Appendable using the provided indent after any new lines.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<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="i6" class="altColor">
<td class="colFirst"><code><a href="../api/WebSocketBehavior.html" title="enum in org.eclipse.jetty.websocket.api">WebSocketBehavior</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getBehavior()">getBehavior</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="../core/CoreSession.html" title="interface in org.eclipse.jetty.websocket.core">CoreSession</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCoreSession()">getCoreSession</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>java.time.Duration</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 duration that a websocket may be idle before being closed by the implementation</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getInputBufferSize()">getInputBufferSize</a></span>()</code></th>
<td class="colLast">
<div class="block">The input (read from network layer) buffer size.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>java.net.SocketAddress</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLocalAddress()">getLocalAddress</a></span>()</code></th>
<td class="colLast">
<div class="block">The Local Socket Address for the active Session</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMaxBinaryMessageSize()">getMaxBinaryMessageSize</a></span>()</code></th>
<td class="colLast">
<div class="block">Get the maximum size of a binary message during parsing.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMaxFrameSize()">getMaxFrameSize</a></span>()</code></th>
<td class="colLast">
<div class="block">The maximum payload size of any WebSocket Frame which can be received.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMaxTextMessageSize()">getMaxTextMessageSize</a></span>()</code></th>
<td class="colLast">
<div class="block">Get the maximum size of a text message during parsing.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getOutputBufferSize()">getOutputBufferSize</a></span>()</code></th>
<td class="colLast">
<div class="block">The output (write to network layer) buffer size.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<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="i16" class="altColor">
<td class="colFirst"><code><a href="JettyWebSocketRemoteEndpoint.html" title="class in org.eclipse.jetty.websocket.common">JettyWebSocketRemoteEndpoint</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="i17" class="rowColor">
<td class="colFirst"><code>java.net.SocketAddress</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRemoteAddress()">getRemoteAddress</a></span>()</code></th>
<td class="colLast">
<div class="block">The Remote Socket Address for the active Session</div>
</td>
</tr>
<tr id="i18" 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="i19" 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="i20" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isAutoFragment()">isAutoFragment</a></span>()</code></th>
<td class="colLast">
<div class="block">If true, frames are automatically fragmented to respect the maximum frame size.</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isOpen()">isOpen</a></span>()</code></th>
<td class="colLast">
<div class="block">Return true if and only if the underlying socket is open.</div>
</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isSecure()">isSecure</a></span>()</code></th>
<td class="colLast">
<div class="block">Return true if and only if the underlying socket is using a secure transport.</div>
</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#resume()">resume</a></span>()</code></th>
<td class="colLast">
<div class="block">Resume a previously suspended connection.</div>
</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setAutoFragment(boolean)">setAutoFragment</a></span>&#8203;(boolean&nbsp;autoFragment)</code></th>
<td class="colLast">
<div class="block">If set to true, frames are automatically fragmented to respect the maximum frame size.</div>
</td>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setIdleTimeout(java.time.Duration)">setIdleTimeout</a></span>&#8203;(java.time.Duration&nbsp;duration)</code></th>
<td class="colLast">
<div class="block">The duration that a websocket may be idle before being closed by the implementation</div>
</td>
</tr>
<tr id="i26" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setInputBufferSize(int)">setInputBufferSize</a></span>&#8203;(int&nbsp;size)</code></th>
<td class="colLast">
<div class="block">The input (read from network layer) buffer size.</div>
</td>
</tr>
<tr id="i27" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setMaxBinaryMessageSize(long)">setMaxBinaryMessageSize</a></span>&#8203;(long&nbsp;size)</code></th>
<td class="colLast">
<div class="block">The maximum size of a binary message during parsing/generating.</div>
</td>
</tr>
<tr id="i28" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setMaxFrameSize(long)">setMaxFrameSize</a></span>&#8203;(long&nbsp;maxFrameSize)</code></th>
<td class="colLast">
<div class="block">The maximum payload size of any WebSocket Frame which can be received.</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="#setMaxTextMessageSize(long)">setMaxTextMessageSize</a></span>&#8203;(long&nbsp;size)</code></th>
<td class="colLast">
<div class="block">The maximum size of a text message during parsing/generating.</div>
</td>
</tr>
<tr id="i30" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setOutputBufferSize(int)">setOutputBufferSize</a></span>&#8203;(int&nbsp;size)</code></th>
<td class="colLast">
<div class="block">The output (write to network layer) buffer size.</div>
</td>
</tr>
<tr id="i31" class="rowColor">
<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 delivery of incoming WebSocket frames.</div>
</td>
</tr>
<tr id="i32" class="altColor">
<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">&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;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">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;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#dump()">dump</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.eclipse.jetty.websocket.api.Session">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.eclipse.jetty.websocket.api.<a href="../api/Session.html" title="interface in org.eclipse.jetty.websocket.api">Session</a></h3>
<code><a href="../api/Session.html#getPolicy()">getPolicy</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="&lt;init&gt;(org.eclipse.jetty.websocket.api.WebSocketContainer,org.eclipse.jetty.websocket.core.CoreSession,org.eclipse.jetty.websocket.common.JettyWebSocketFrameHandler)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>WebSocketSession</h4>
<pre>public&nbsp;WebSocketSession&#8203;(<a href="../api/WebSocketContainer.html" title="interface in org.eclipse.jetty.websocket.api">WebSocketContainer</a>&nbsp;container,
<a href="../core/CoreSession.html" title="interface in org.eclipse.jetty.websocket.core">CoreSession</a>&nbsp;coreSession,
<a href="JettyWebSocketFrameHandler.html" title="class in org.eclipse.jetty.websocket.common">JettyWebSocketFrameHandler</a>&nbsp;frameHandler)</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()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>close</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;close()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<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>&nbsp;in interface&nbsp;<code>java.lang.AutoCloseable</code></dd>
<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><a href="../api/Session.html#close()">close</a></code>&nbsp;in interface&nbsp;<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&nbsp;void&nbsp;close&#8203;(<a href="../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="../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>&nbsp;in interface&nbsp;<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&nbsp;void&nbsp;close&#8203;(int&nbsp;statusCode,
java.lang.String&nbsp;reason)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<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>&nbsp;in interface&nbsp;<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="getBehavior()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBehavior</h4>
<pre class="methodSignature">public&nbsp;<a href="../api/WebSocketBehavior.html" title="enum in org.eclipse.jetty.websocket.api">WebSocketBehavior</a>&nbsp;getBehavior()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../api/WebSocketPolicy.html#getBehavior()">getBehavior</a></code>&nbsp;in interface&nbsp;<code><a href="../api/WebSocketPolicy.html" title="interface in org.eclipse.jetty.websocket.api">WebSocketPolicy</a></code></dd>
</dl>
</li>
</ul>
<a id="getIdleTimeout()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getIdleTimeout</h4>
<pre class="methodSignature">public&nbsp;java.time.Duration&nbsp;getIdleTimeout()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../api/WebSocketPolicy.html#getIdleTimeout()">WebSocketPolicy</a></code></span></div>
<div class="block">The duration that a websocket may be idle before being closed by the implementation</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../api/WebSocketPolicy.html#getIdleTimeout()">getIdleTimeout</a></code>&nbsp;in interface&nbsp;<code><a href="../api/WebSocketPolicy.html" title="interface in org.eclipse.jetty.websocket.api">WebSocketPolicy</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the timeout duration</dd>
</dl>
</li>
</ul>
<a id="getInputBufferSize()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInputBufferSize</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;getInputBufferSize()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../api/WebSocketPolicy.html#getInputBufferSize()">WebSocketPolicy</a></code></span></div>
<div class="block">The input (read from network layer) buffer size.
<p>
This is the raw read operation buffer size, before the parsing of the websocket frames.
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../api/WebSocketPolicy.html#getInputBufferSize()">getInputBufferSize</a></code>&nbsp;in interface&nbsp;<code><a href="../api/WebSocketPolicy.html" title="interface in org.eclipse.jetty.websocket.api">WebSocketPolicy</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the raw network buffer input size.</dd>
</dl>
</li>
</ul>
<a id="getOutputBufferSize()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOutputBufferSize</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;getOutputBufferSize()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../api/WebSocketPolicy.html#getOutputBufferSize()">WebSocketPolicy</a></code></span></div>
<div class="block">The output (write to network layer) buffer size.
<p>
This is the raw write operation buffer size and has no relationship to the websocket frame.
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../api/WebSocketPolicy.html#getOutputBufferSize()">getOutputBufferSize</a></code>&nbsp;in interface&nbsp;<code><a href="../api/WebSocketPolicy.html" title="interface in org.eclipse.jetty.websocket.api">WebSocketPolicy</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the raw network buffer output size.</dd>
</dl>
</li>
</ul>
<a id="getMaxBinaryMessageSize()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMaxBinaryMessageSize</h4>
<pre class="methodSignature">public&nbsp;long&nbsp;getMaxBinaryMessageSize()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../api/WebSocketPolicy.html#getMaxBinaryMessageSize()">WebSocketPolicy</a></code></span></div>
<div class="block">Get the maximum size of a binary message during parsing.
<p>
This is a memory conservation option, memory over this limit will not be
allocated by Jetty for handling binary messages. This applies to individual frames,
whole message handling, and partial message handling.
</p>
<p>
Binary messages over this maximum will result in a close code 1009 <a href="../api/StatusCode.html#MESSAGE_TOO_LARGE"><code>StatusCode.MESSAGE_TOO_LARGE</code></a>
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../api/WebSocketPolicy.html#getMaxBinaryMessageSize()">getMaxBinaryMessageSize</a></code>&nbsp;in interface&nbsp;<code><a href="../api/WebSocketPolicy.html" title="interface in org.eclipse.jetty.websocket.api">WebSocketPolicy</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the maximum size of a binary message</dd>
</dl>
</li>
</ul>
<a id="getMaxTextMessageSize()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMaxTextMessageSize</h4>
<pre class="methodSignature">public&nbsp;long&nbsp;getMaxTextMessageSize()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../api/WebSocketPolicy.html#getMaxTextMessageSize()">WebSocketPolicy</a></code></span></div>
<div class="block">Get the maximum size of a text message during parsing.
<p>
This is a memory conservation option, memory over this limit will not be
allocated by Jetty for handling text messages. This applies to individual frames,
whole message handling, and partial message handling.
</p>
<p>
Text messages over this maximum will result in a close code 1009 <a href="../api/StatusCode.html#MESSAGE_TOO_LARGE"><code>StatusCode.MESSAGE_TOO_LARGE</code></a>
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../api/WebSocketPolicy.html#getMaxTextMessageSize()">getMaxTextMessageSize</a></code>&nbsp;in interface&nbsp;<code><a href="../api/WebSocketPolicy.html" title="interface in org.eclipse.jetty.websocket.api">WebSocketPolicy</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the maximum size of a text message.</dd>
</dl>
</li>
</ul>
<a id="getMaxFrameSize()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMaxFrameSize</h4>
<pre class="methodSignature">public&nbsp;long&nbsp;getMaxFrameSize()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../api/WebSocketPolicy.html#getMaxFrameSize()">WebSocketPolicy</a></code></span></div>
<div class="block">The maximum payload size of any WebSocket Frame which can be received.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../api/WebSocketPolicy.html#getMaxFrameSize()">getMaxFrameSize</a></code>&nbsp;in interface&nbsp;<code><a href="../api/WebSocketPolicy.html" title="interface in org.eclipse.jetty.websocket.api">WebSocketPolicy</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the maximum size of a WebSocket Frame.</dd>
</dl>
</li>
</ul>
<a id="isAutoFragment()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isAutoFragment</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isAutoFragment()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../api/WebSocketPolicy.html#isAutoFragment()">WebSocketPolicy</a></code></span></div>
<div class="block">If true, frames are automatically fragmented to respect the maximum frame size.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../api/WebSocketPolicy.html#isAutoFragment()">isAutoFragment</a></code>&nbsp;in interface&nbsp;<code><a href="../api/WebSocketPolicy.html" title="interface in org.eclipse.jetty.websocket.api">WebSocketPolicy</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether to automatically fragment incoming WebSocket Frames.</dd>
</dl>
</li>
</ul>
<a id="setIdleTimeout(java.time.Duration)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setIdleTimeout</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setIdleTimeout&#8203;(java.time.Duration&nbsp;duration)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../api/WebSocketPolicy.html#setIdleTimeout(java.time.Duration)">WebSocketPolicy</a></code></span></div>
<div class="block">The duration that a websocket may be idle before being closed by the implementation</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../api/WebSocketPolicy.html#setIdleTimeout(java.time.Duration)">setIdleTimeout</a></code>&nbsp;in interface&nbsp;<code><a href="../api/WebSocketPolicy.html" title="interface in org.eclipse.jetty.websocket.api">WebSocketPolicy</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>duration</code> - the timeout duration (may not be null or negative)</dd>
</dl>
</li>
</ul>
<a id="setInputBufferSize(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setInputBufferSize</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setInputBufferSize&#8203;(int&nbsp;size)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../api/WebSocketPolicy.html#setInputBufferSize(int)">WebSocketPolicy</a></code></span></div>
<div class="block">The input (read from network layer) buffer size.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../api/WebSocketPolicy.html#setInputBufferSize(int)">setInputBufferSize</a></code>&nbsp;in interface&nbsp;<code><a href="../api/WebSocketPolicy.html" title="interface in org.eclipse.jetty.websocket.api">WebSocketPolicy</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>size</code> - the size in bytes</dd>
</dl>
</li>
</ul>
<a id="setOutputBufferSize(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setOutputBufferSize</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setOutputBufferSize&#8203;(int&nbsp;size)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../api/WebSocketPolicy.html#setOutputBufferSize(int)">WebSocketPolicy</a></code></span></div>
<div class="block">The output (write to network layer) buffer size.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../api/WebSocketPolicy.html#setOutputBufferSize(int)">setOutputBufferSize</a></code>&nbsp;in interface&nbsp;<code><a href="../api/WebSocketPolicy.html" title="interface in org.eclipse.jetty.websocket.api">WebSocketPolicy</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>size</code> - the size in bytes</dd>
</dl>
</li>
</ul>
<a id="setMaxBinaryMessageSize(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMaxBinaryMessageSize</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setMaxBinaryMessageSize&#8203;(long&nbsp;size)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../api/WebSocketPolicy.html#setMaxBinaryMessageSize(long)">WebSocketPolicy</a></code></span></div>
<div class="block">The maximum size of a binary message during parsing/generating.
<p>
Binary messages over this maximum will result in a close code 1009 <a href="../api/StatusCode.html#MESSAGE_TOO_LARGE"><code>StatusCode.MESSAGE_TOO_LARGE</code></a>
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../api/WebSocketPolicy.html#setMaxBinaryMessageSize(long)">setMaxBinaryMessageSize</a></code>&nbsp;in interface&nbsp;<code><a href="../api/WebSocketPolicy.html" title="interface in org.eclipse.jetty.websocket.api">WebSocketPolicy</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>size</code> - the maximum allowed size of a binary message.</dd>
</dl>
</li>
</ul>
<a id="setMaxTextMessageSize(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMaxTextMessageSize</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setMaxTextMessageSize&#8203;(long&nbsp;size)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../api/WebSocketPolicy.html#setMaxTextMessageSize(long)">WebSocketPolicy</a></code></span></div>
<div class="block">The maximum size of a text message during parsing/generating.
<p>
Text messages over this maximum will result in a close code 1009 <a href="../api/StatusCode.html#MESSAGE_TOO_LARGE"><code>StatusCode.MESSAGE_TOO_LARGE</code></a></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../api/WebSocketPolicy.html#setMaxTextMessageSize(long)">setMaxTextMessageSize</a></code>&nbsp;in interface&nbsp;<code><a href="../api/WebSocketPolicy.html" title="interface in org.eclipse.jetty.websocket.api">WebSocketPolicy</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>size</code> - the maximum allowed size of a text message.</dd>
</dl>
</li>
</ul>
<a id="setMaxFrameSize(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMaxFrameSize</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setMaxFrameSize&#8203;(long&nbsp;maxFrameSize)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../api/WebSocketPolicy.html#setMaxFrameSize(long)">WebSocketPolicy</a></code></span></div>
<div class="block">The maximum payload size of any WebSocket Frame which can be received.
<p>
WebSocket Frames over this maximum will result in a close code 1009 <a href="../api/StatusCode.html#MESSAGE_TOO_LARGE"><code>StatusCode.MESSAGE_TOO_LARGE</code></a>
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../api/WebSocketPolicy.html#setMaxFrameSize(long)">setMaxFrameSize</a></code>&nbsp;in interface&nbsp;<code><a href="../api/WebSocketPolicy.html" title="interface in org.eclipse.jetty.websocket.api">WebSocketPolicy</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>maxFrameSize</code> - the maximum allowed size of a WebSocket Frame.</dd>
</dl>
</li>
</ul>
<a id="setAutoFragment(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setAutoFragment</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setAutoFragment&#8203;(boolean&nbsp;autoFragment)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../api/WebSocketPolicy.html#setAutoFragment(boolean)">WebSocketPolicy</a></code></span></div>
<div class="block">If set to true, frames are automatically fragmented to respect the maximum frame size.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../api/WebSocketPolicy.html#setAutoFragment(boolean)">setAutoFragment</a></code>&nbsp;in interface&nbsp;<code><a href="../api/WebSocketPolicy.html" title="interface in org.eclipse.jetty.websocket.api">WebSocketPolicy</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>autoFragment</code> - whether to automatically fragment incoming WebSocket Frames.</dd>
</dl>
</li>
</ul>
<a id="getProtocolVersion()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getProtocolVersion</h4>
<pre class="methodSignature">public&nbsp;java.lang.String&nbsp;getProtocolVersion()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<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>&nbsp;in interface&nbsp;<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&nbsp;<a href="JettyWebSocketRemoteEndpoint.html" title="class in org.eclipse.jetty.websocket.common">JettyWebSocketRemoteEndpoint</a>&nbsp;getRemote()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<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>&nbsp;in interface&nbsp;<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="isOpen()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isOpen</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isOpen()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<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>&nbsp;in interface&nbsp;<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&nbsp;boolean&nbsp;isSecure()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<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>&nbsp;in interface&nbsp;<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="disconnect()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>disconnect</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;disconnect()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../api/Session.html#disconnect()">Session</a></code></span></div>
<div class="block">Issue a harsh disconnect of the underlying connection.
<p>
This will terminate the connection, without sending a websocket close frame.
<p>
Once called, any read/write activity on the websocket from this point will be indeterminate.
<p>
Once the underlying connection has been determined to be closed, the various onClose() events (either
<a href="../api/WebSocketConnectionListener.html#onWebSocketClose(int,java.lang.String)"><code>WebSocketConnectionListener.onWebSocketClose(int, String)</code></a> or <a href="../api/annotations/OnWebSocketClose.html" title="annotation in org.eclipse.jetty.websocket.api.annotations"><code>OnWebSocketClose</code></a>) will be called on your
websocket.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../api/Session.html#disconnect()">disconnect</a></code>&nbsp;in interface&nbsp;<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></dd>
</dl>
</li>
</ul>
<a id="getLocalAddress()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLocalAddress</h4>
<pre class="methodSignature">public&nbsp;java.net.SocketAddress&nbsp;getLocalAddress()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../api/Session.html#getLocalAddress()">Session</a></code></span></div>
<div class="block">The Local Socket Address for the active Session
<p>
Do not assume that this will return a <code>InetSocketAddress</code> in all cases.
Use of various proxies, and even UnixSockets can result a SocketAddress being returned
without supporting <code>InetSocketAddress</code>
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../api/Session.html#getLocalAddress()">getLocalAddress</a></code>&nbsp;in interface&nbsp;<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 SocketAddress for the local connection, or null if not supported by Session</dd>
</dl>
</li>
</ul>
<a id="getRemoteAddress()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRemoteAddress</h4>
<pre class="methodSignature">public&nbsp;java.net.SocketAddress&nbsp;getRemoteAddress()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../api/Session.html#getRemoteAddress()">Session</a></code></span></div>
<div class="block">The Remote Socket Address for the active Session
<p>
Do not assume that this will return a <code>InetSocketAddress</code> in all cases.
Use of various proxies, and even UnixSockets can result a SocketAddress being returned
without supporting <code>InetSocketAddress</code>
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../api/Session.html#getRemoteAddress()">getRemoteAddress</a></code>&nbsp;in interface&nbsp;<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 SocketAddress for the remote connection, or null if not supported by Session</dd>
</dl>
</li>
</ul>
<a id="getUpgradeRequest()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUpgradeRequest</h4>
<pre class="methodSignature">public&nbsp;<a href="../api/UpgradeRequest.html" title="interface 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="../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>&nbsp;in interface&nbsp;<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&nbsp;<a href="../api/UpgradeResponse.html" title="interface 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="../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>&nbsp;in interface&nbsp;<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="suspend()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>suspend</h4>
<pre class="methodSignature">public&nbsp;<a href="../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="../api/Session.html#suspend()">Session</a></code></span></div>
<div class="block">Suspend the delivery of incoming WebSocket frames.
<p>
If this is called from inside the scope of the message handler the suspend takes effect immediately.
If suspend is called outside the scope of the message handler then the call may take effect
after 1 more frame is delivered.
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../api/Session.html#suspend()">suspend</a></code>&nbsp;in interface&nbsp;<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="resume()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>resume</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;resume()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../api/SuspendToken.html#resume()">SuspendToken</a></code></span></div>
<div class="block">Resume a previously suspended connection.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../api/SuspendToken.html#resume()">resume</a></code>&nbsp;in interface&nbsp;<code><a href="../api/SuspendToken.html" title="interface in org.eclipse.jetty.websocket.api">SuspendToken</a></code></dd>
</dl>
</li>
</ul>
<a id="getCoreSession()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCoreSession</h4>
<pre class="methodSignature">public&nbsp;<a href="../core/CoreSession.html" title="interface in org.eclipse.jetty.websocket.core">CoreSession</a>&nbsp;getCoreSession()</pre>
</li>
</ul>
<a id="dump(java.lang.Appendable,java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>dump</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;dump&#8203;(java.lang.Appendable&nbsp;out,
java.lang.String&nbsp;indent)
throws java.io.IOException</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../util/component/Dumpable.html#dump(java.lang.Appendable,java.lang.String)">Dumpable</a></code></span></div>
<div class="block">Dump this object (and children) into an Appendable using the provided indent after any new lines.
The indent should not be applied to the first object dumped.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../util/component/Dumpable.html#dump(java.lang.Appendable,java.lang.String)">dump</a></code>&nbsp;in interface&nbsp;<code><a href="../../util/component/Dumpable.html" title="interface in org.eclipse.jetty.util.component">Dumpable</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>out</code> - The appendable to dump to</dd>
<dd><code>indent</code> - The indent to apply after any new lines.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code> - if unable to write to Appendable</dd>
</dl>
</li>
</ul>
<a id="dumpSelf()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>dumpSelf</h4>
<pre class="methodSignature">public&nbsp;java.lang.String&nbsp;dumpSelf()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<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>&nbsp;in interface&nbsp;<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="toString()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre class="methodSignature">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>
</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&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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">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 id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 1995&#x2013;2021 <a href="https://webtide.com">Webtide</a>. All rights reserved.</small></p>
</footer>
</body>
</html>