blob: a736653501191760cb50bf217115f7332edfbc41 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.8) on Thu Oct 22 13:32:16 CDT 2020 -->
<title>WebSocketCoreSession (Jetty :: Javadoc Build 10.0.0.beta3 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2020-10-22">
<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.3.1.js"></script>
<script type="text/javascript" src="../../../../../../jquery/jquery-migrate-3.0.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="WebSocketCoreSession (Jetty :: Javadoc Build 10.0.0.beta3 API)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":10,"i32":10,"i33":10,"i34":10,"i35":10,"i36":10,"i37":10,"i38":10,"i39":10,"i40":10,"i41":10,"i42":10,"i43":10,"i44":10,"i45":10,"i46":10,"i47":10,"i48":10,"i49":10,"i50":10,"i51":10,"i52":10,"i53":10,"i54":10,"i55":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/WebSocketCoreSession.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.core.internal</a></div>
<h2 title="Class WebSocketCoreSession" class="title">Class WebSocketCoreSession</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.eclipse.jetty.websocket.core.internal.WebSocketCoreSession</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="../../../util/component/Dumpable.html" title="interface in org.eclipse.jetty.util.component">Dumpable</a></code>, <code><a href="../Configuration.html" title="interface in org.eclipse.jetty.websocket.core">Configuration</a></code>, <code><a href="../CoreSession.html" title="interface in org.eclipse.jetty.websocket.core">CoreSession</a></code>, <code><a href="../IncomingFrames.html" title="interface in org.eclipse.jetty.websocket.core">IncomingFrames</a></code>, <code><a href="../OutgoingFrames.html" title="interface in org.eclipse.jetty.websocket.core">OutgoingFrames</a></code></dd>
</dl>
<hr>
<pre>public class <span class="typeNameLabel">WebSocketCoreSession</span>
extends java.lang.Object
implements <a href="../IncomingFrames.html" title="interface in org.eclipse.jetty.websocket.core">IncomingFrames</a>, <a href="../CoreSession.html" title="interface in org.eclipse.jetty.websocket.core">CoreSession</a>, <a href="../../../util/component/Dumpable.html" title="interface in org.eclipse.jetty.util.component">Dumpable</a></pre>
<div class="block">The Core WebSocket Session.</div>
</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.websocket.core.Configuration">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface&nbsp;org.eclipse.jetty.websocket.core.<a href="../Configuration.html" title="interface in org.eclipse.jetty.websocket.core">Configuration</a></h3>
<code><a href="../Configuration.ConfigurationCustomizer.html" title="class in org.eclipse.jetty.websocket.core">Configuration.ConfigurationCustomizer</a>, <a href="../Configuration.Customizer.html" title="interface in org.eclipse.jetty.websocket.core">Configuration.Customizer</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="nested.classes.inherited.from.class.org.eclipse.jetty.websocket.core.CoreSession">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface&nbsp;org.eclipse.jetty.websocket.core.<a href="../CoreSession.html" title="interface in org.eclipse.jetty.websocket.core">CoreSession</a></h3>
<code><a href="../CoreSession.Empty.html" title="class in org.eclipse.jetty.websocket.core">CoreSession.Empty</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="nested.classes.inherited.from.class.org.eclipse.jetty.util.component.Dumpable">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface&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.core.FrameHandler,org.eclipse.jetty.websocket.core.Behavior,org.eclipse.jetty.websocket.core.internal.Negotiated,org.eclipse.jetty.websocket.core.WebSocketComponents)">WebSocketCoreSession</a></span>&#8203;(<a href="../FrameHandler.html" title="interface in org.eclipse.jetty.websocket.core">FrameHandler</a>&nbsp;handler,
<a href="../Behavior.html" title="enum in org.eclipse.jetty.websocket.core">Behavior</a>&nbsp;behavior,
<a href="Negotiated.html" title="class in org.eclipse.jetty.websocket.core.internal">Negotiated</a>&nbsp;negotiated,
<a href="../WebSocketComponents.html" title="class in org.eclipse.jetty.websocket.core">WebSocketComponents</a>&nbsp;components)</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="#abort()">abort</a></span>()</code></th>
<td class="colLast">
<div class="block">Issue a harsh abort of the underlying connection.</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="#assertValidFrame(org.eclipse.jetty.websocket.core.Frame)">assertValidFrame</a></span>&#8203;(<a href="../Frame.html" title="class in org.eclipse.jetty.websocket.core">Frame</a>&nbsp;frame)</code></th>
<td class="colLast">&nbsp;</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="#assertValidIncoming(org.eclipse.jetty.websocket.core.Frame)">assertValidIncoming</a></span>&#8203;(<a href="../Frame.html" title="class in org.eclipse.jetty.websocket.core">Frame</a>&nbsp;frame)</code></th>
<td class="colLast">&nbsp;</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="#assertValidOutgoing(org.eclipse.jetty.websocket.core.Frame)">assertValidOutgoing</a></span>&#8203;(<a href="../Frame.html" title="class in org.eclipse.jetty.websocket.core">Frame</a>&nbsp;frame)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#close(int,java.lang.String,org.eclipse.jetty.util.Callback)">close</a></span>&#8203;(int&nbsp;statusCode,
java.lang.String&nbsp;reason,
<a href="../../../util/Callback.html" title="interface in org.eclipse.jetty.util">Callback</a>&nbsp;callback)</code></th>
<td class="colLast">
<div class="block">Send Close Frame with specified Status Code and optional Reason</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#close(org.eclipse.jetty.util.Callback)">close</a></span>&#8203;(<a href="../../../util/Callback.html" title="interface in org.eclipse.jetty.util">Callback</a>&nbsp;callback)</code></th>
<td class="colLast">
<div class="block">Send Close Frame with no payload.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#closeConnection(org.eclipse.jetty.websocket.core.CloseStatus,org.eclipse.jetty.util.Callback)">closeConnection</a></span>&#8203;(<a href="../CloseStatus.html" title="class in org.eclipse.jetty.websocket.core">CloseStatus</a>&nbsp;closeStatus,
<a href="../../../util/Callback.html" title="interface in org.eclipse.jetty.util">Callback</a>&nbsp;callback)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#demand(long)">demand</a></span>&#8203;(long&nbsp;n)</code></th>
<td class="colLast">
<div class="block">Manage flow control by indicating demand for handling Frames.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#dump()">dump</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#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="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#flush(org.eclipse.jetty.util.Callback)">flush</a></span>&#8203;(<a href="../../../util/Callback.html" title="interface in org.eclipse.jetty.util">Callback</a>&nbsp;callback)</code></th>
<td class="colLast">
<div class="block">If using BatchMode.ON or BatchMode.AUTO, trigger a flush of enqueued / batched frames.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code><a href="../Behavior.html" title="enum in org.eclipse.jetty.websocket.core">Behavior</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="i12" class="altColor">
<td class="colFirst"><code><a href="../../../io/ByteBufferPool.html" title="interface in org.eclipse.jetty.io">ByteBufferPool</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getByteBufferPool()">getByteBufferPool</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code><a href="WebSocketConnection.html" title="class in org.eclipse.jetty.websocket.core.internal">WebSocketConnection</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getConnection()">getConnection</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>java.util.concurrent.Executor</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getExecutor()">getExecutor</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code><a href="ExtensionStack.html" title="class in org.eclipse.jetty.websocket.core.internal">ExtensionStack</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getExtensionStack()">getExtensionStack</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code><a href="../FrameHandler.html" title="interface in org.eclipse.jetty.websocket.core">FrameHandler</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getHandler()">getHandler</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i17" class="rowColor">
<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">Get the Idle Timeout</div>
</td>
</tr>
<tr id="i18" class="altColor">
<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">&nbsp;</td>
</tr>
<tr id="i19" class="rowColor">
<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 connection</div>
</td>
</tr>
<tr id="i20" class="altColor">
<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">&nbsp;</td>
</tr>
<tr id="i21" class="rowColor">
<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">&nbsp;</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMaxOutgoingFrames()">getMaxOutgoingFrames</a></span>()</code></th>
<td class="colLast">
<div class="block">Get the maximum number of data frames allowed to be waiting to be sent at any one time.</div>
</td>
</tr>
<tr id="i23" 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">&nbsp;</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code>java.util.List&lt;<a href="../ExtensionConfig.html" title="class in org.eclipse.jetty.websocket.core">ExtensionConfig</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getNegotiatedExtensions()">getNegotiatedExtensions</a></span>()</code></th>
<td class="colLast">
<div class="block">The negotiated WebSocket Extension Configurations for this session.</div>
</td>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getNegotiatedSubProtocol()">getNegotiatedSubProtocol</a></span>()</code></th>
<td class="colLast">
<div class="block">The negotiated WebSocket Sub-Protocol for this session.</div>
</td>
</tr>
<tr id="i26" 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">&nbsp;</td>
</tr>
<tr id="i27" class="rowColor">
<td class="colFirst"><code>java.util.Map&lt;java.lang.String,&#8203;java.util.List&lt;java.lang.String&gt;&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getParameterMap()">getParameterMap</a></span>()</code></th>
<td class="colLast">
<div class="block">The parameter map (from URI Query) for the active session.</div>
</td>
</tr>
<tr id="i28" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getProtocolVersion()">getProtocolVersion</a></span>()</code></th>
<td class="colLast">
<div class="block">The active <code>Sec-WebSocket-Version</code> (protocol version) in use.</div>
</td>
</tr>
<tr id="i29" 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 connection</div>
</td>
</tr>
<tr id="i30" class="altColor">
<td class="colFirst"><code>java.net.URI</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRequestURI()">getRequestURI</a></span>()</code></th>
<td class="colLast">
<div class="block">The active connection's Request URI.</div>
</td>
</tr>
<tr id="i31" class="rowColor">
<td class="colFirst"><code><a href="../WebSocketComponents.html" title="class in org.eclipse.jetty.websocket.core">WebSocketComponents</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getWebSocketComponents()">getWebSocketComponents</a></span>()</code></th>
<td class="colLast">
<div class="block">TODO</div>
</td>
</tr>
<tr id="i32" class="altColor">
<td class="colFirst"><code>java.time.Duration</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getWriteTimeout()">getWriteTimeout</a></span>()</code></th>
<td class="colLast">
<div class="block">Get the Write Timeout</div>
</td>
</tr>
<tr id="i33" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#handle(java.lang.Runnable)">handle</a></span>&#8203;(java.lang.Runnable&nbsp;runnable)</code></th>
<td class="colLast">
<div class="block">Can be overridden to scope into the correct classloader before calling application code.</div>
</td>
</tr>
<tr id="i34" 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">&nbsp;</td>
</tr>
<tr id="i35" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isClosed()">isClosed</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i36" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isDemanding()">isDemanding</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i37" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isOutputOpen()">isOutputOpen</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i38" 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">The active connection's Secure status indicator.</div>
</td>
</tr>
<tr id="i39" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onEof()">onEof</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i40" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onFrame(org.eclipse.jetty.websocket.core.Frame,org.eclipse.jetty.util.Callback)">onFrame</a></span>&#8203;(<a href="../Frame.html" title="class in org.eclipse.jetty.websocket.core">Frame</a>&nbsp;frame,
<a href="../../../util/Callback.html" title="interface in org.eclipse.jetty.util">Callback</a>&nbsp;callback)</code></th>
<td class="colLast">
<div class="block">Process the incoming frame.</div>
</td>
</tr>
<tr id="i41" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onOpen()">onOpen</a></span>()</code></th>
<td class="colLast">
<div class="block">Open/Activate the session.</div>
</td>
</tr>
<tr id="i42" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#processConnectionError(java.lang.Throwable,org.eclipse.jetty.util.Callback)">processConnectionError</a></span>&#8203;(java.lang.Throwable&nbsp;cause,
<a href="../../../util/Callback.html" title="interface in org.eclipse.jetty.util">Callback</a>&nbsp;callback)</code></th>
<td class="colLast">
<div class="block">Process an Error that originated from the connection.</div>
</td>
</tr>
<tr id="i43" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#processHandlerError(java.lang.Throwable,org.eclipse.jetty.util.Callback)">processHandlerError</a></span>&#8203;(java.lang.Throwable&nbsp;cause,
<a href="../../../util/Callback.html" title="interface in org.eclipse.jetty.util">Callback</a>&nbsp;callback)</code></th>
<td class="colLast">
<div class="block">Process an Error that originated from the handler.</div>
</td>
</tr>
<tr id="i44" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sendFrame(org.eclipse.jetty.websocket.core.Frame,org.eclipse.jetty.util.Callback,boolean)">sendFrame</a></span>&#8203;(<a href="../Frame.html" title="class in org.eclipse.jetty.websocket.core">Frame</a>&nbsp;frame,
<a href="../../../util/Callback.html" title="interface in org.eclipse.jetty.util">Callback</a>&nbsp;callback,
boolean&nbsp;batch)</code></th>
<td class="colLast">
<div class="block">A frame, and optional callback, intended for the network layer.</div>
</td>
</tr>
<tr id="i45" class="rowColor">
<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">&nbsp;</td>
</tr>
<tr id="i46" class="altColor">
<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;timeout)</code></th>
<td class="colLast">
<div class="block">Set the Idle Timeout.</div>
</td>
</tr>
<tr id="i47" class="rowColor">
<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;inputBufferSize)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i48" class="altColor">
<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;maxSize)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i49" class="rowColor">
<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">&nbsp;</td>
</tr>
<tr id="i50" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setMaxOutgoingFrames(int)">setMaxOutgoingFrames</a></span>&#8203;(int&nbsp;maxOutgoingFrames)</code></th>
<td class="colLast">
<div class="block">Set the maximum number of data frames allowed to be waiting to be sent at any one time.</div>
</td>
</tr>
<tr id="i51" 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;maxSize)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i52" 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;outputBufferSize)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i53" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setWebSocketConnection(org.eclipse.jetty.websocket.core.internal.WebSocketConnection)">setWebSocketConnection</a></span>&#8203;(<a href="WebSocketConnection.html" title="class in org.eclipse.jetty.websocket.core.internal">WebSocketConnection</a>&nbsp;connection)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i54" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setWriteTimeout(java.time.Duration)">setWriteTimeout</a></span>&#8203;(java.time.Duration&nbsp;timeout)</code></th>
<td class="colLast">
<div class="block">Set the Write Timeout.</div>
</td>
</tr>
<tr id="i55" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toString()">toString</a></span>()</code></th>
<td class="colLast">&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#dumpSelf()">dumpSelf</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.core.FrameHandler,org.eclipse.jetty.websocket.core.Behavior,org.eclipse.jetty.websocket.core.internal.Negotiated,org.eclipse.jetty.websocket.core.WebSocketComponents)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>WebSocketCoreSession</h4>
<pre>public&nbsp;WebSocketCoreSession&#8203;(<a href="../FrameHandler.html" title="interface in org.eclipse.jetty.websocket.core">FrameHandler</a>&nbsp;handler,
<a href="../Behavior.html" title="enum in org.eclipse.jetty.websocket.core">Behavior</a>&nbsp;behavior,
<a href="Negotiated.html" title="class in org.eclipse.jetty.websocket.core.internal">Negotiated</a>&nbsp;negotiated,
<a href="../WebSocketComponents.html" title="class in org.eclipse.jetty.websocket.core">WebSocketComponents</a>&nbsp;components)</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="handle(java.lang.Runnable)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>handle</h4>
<pre class="methodSignature">protected&nbsp;void&nbsp;handle&#8203;(java.lang.Runnable&nbsp;runnable)</pre>
<div class="block">Can be overridden to scope into the correct classloader before calling application code.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>runnable</code> - the runnable to execute.</dd>
</dl>
</li>
</ul>
<a id="isDemanding()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isDemanding</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isDemanding()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>True if the sessions handling is demanding.</dd>
</dl>
</li>
</ul>
<a id="assertValidIncoming(org.eclipse.jetty.websocket.core.Frame)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>assertValidIncoming</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;assertValidIncoming&#8203;(<a href="../Frame.html" title="class in org.eclipse.jetty.websocket.core">Frame</a>&nbsp;frame)</pre>
</li>
</ul>
<a id="assertValidOutgoing(org.eclipse.jetty.websocket.core.Frame)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>assertValidOutgoing</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;assertValidOutgoing&#8203;(<a href="../Frame.html" title="class in org.eclipse.jetty.websocket.core">Frame</a>&nbsp;frame)
throws <a href="../exception/CloseException.html" title="class in org.eclipse.jetty.websocket.core.exception">CloseException</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../exception/CloseException.html" title="class in org.eclipse.jetty.websocket.core.exception">CloseException</a></code></dd>
</dl>
</li>
</ul>
<a id="assertValidFrame(org.eclipse.jetty.websocket.core.Frame)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>assertValidFrame</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;assertValidFrame&#8203;(<a href="../Frame.html" title="class in org.eclipse.jetty.websocket.core">Frame</a>&nbsp;frame)</pre>
</li>
</ul>
<a id="getExtensionStack()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getExtensionStack</h4>
<pre class="methodSignature">public&nbsp;<a href="ExtensionStack.html" title="class in org.eclipse.jetty.websocket.core.internal">ExtensionStack</a>&nbsp;getExtensionStack()</pre>
</li>
</ul>
<a id="getHandler()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHandler</h4>
<pre class="methodSignature">public&nbsp;<a href="../FrameHandler.html" title="interface in org.eclipse.jetty.websocket.core">FrameHandler</a>&nbsp;getHandler()</pre>
</li>
</ul>
<a id="getNegotiatedSubProtocol()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNegotiatedSubProtocol</h4>
<pre class="methodSignature">public&nbsp;java.lang.String&nbsp;getNegotiatedSubProtocol()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../CoreSession.html#getNegotiatedSubProtocol()">CoreSession</a></code></span></div>
<div class="block">The negotiated WebSocket Sub-Protocol for this session.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../CoreSession.html#getNegotiatedSubProtocol()">getNegotiatedSubProtocol</a></code>&nbsp;in interface&nbsp;<code><a href="../CoreSession.html" title="interface in org.eclipse.jetty.websocket.core">CoreSession</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the negotiated WebSocket Sub-Protocol for this session.</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="../Configuration.html#getIdleTimeout()">Configuration</a></code></span></div>
<div class="block">Get the Idle Timeout</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../Configuration.html#getIdleTimeout()">getIdleTimeout</a></code>&nbsp;in interface&nbsp;<code><a href="../Configuration.html" title="interface in org.eclipse.jetty.websocket.core">Configuration</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the idle timeout</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;timeout)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../Configuration.html#setIdleTimeout(java.time.Duration)">Configuration</a></code></span></div>
<div class="block">Set the Idle Timeout.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../Configuration.html#setIdleTimeout(java.time.Duration)">setIdleTimeout</a></code>&nbsp;in interface&nbsp;<code><a href="../Configuration.html" title="interface in org.eclipse.jetty.websocket.core">Configuration</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>timeout</code> - the timeout duration (timeout &lt;= 0 implies an infinite timeout)</dd>
</dl>
</li>
</ul>
<a id="getWriteTimeout()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getWriteTimeout</h4>
<pre class="methodSignature">public&nbsp;java.time.Duration&nbsp;getWriteTimeout()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../Configuration.html#getWriteTimeout()">Configuration</a></code></span></div>
<div class="block">Get the Write Timeout</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../Configuration.html#getWriteTimeout()">getWriteTimeout</a></code>&nbsp;in interface&nbsp;<code><a href="../Configuration.html" title="interface in org.eclipse.jetty.websocket.core">Configuration</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the write timeout</dd>
</dl>
</li>
</ul>
<a id="setWriteTimeout(java.time.Duration)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setWriteTimeout</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setWriteTimeout&#8203;(java.time.Duration&nbsp;timeout)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../Configuration.html#setWriteTimeout(java.time.Duration)">Configuration</a></code></span></div>
<div class="block">Set the Write Timeout.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../Configuration.html#setWriteTimeout(java.time.Duration)">setWriteTimeout</a></code>&nbsp;in interface&nbsp;<code><a href="../Configuration.html" title="interface in org.eclipse.jetty.websocket.core">Configuration</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>timeout</code> - the timeout duration (timeout &lt;= 0 implies an infinite timeout)</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="../CoreSession.html#getLocalAddress()">CoreSession</a></code></span></div>
<div class="block">The Local Socket Address for the connection
<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="../CoreSession.html#getLocalAddress()">getLocalAddress</a></code>&nbsp;in interface&nbsp;<code><a href="../CoreSession.html" title="interface in org.eclipse.jetty.websocket.core">CoreSession</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="../CoreSession.html#getRemoteAddress()">CoreSession</a></code></span></div>
<div class="block">The Remote Socket Address for the connection
<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="../CoreSession.html#getRemoteAddress()">getRemoteAddress</a></code>&nbsp;in interface&nbsp;<code><a href="../CoreSession.html" title="interface in org.eclipse.jetty.websocket.core">CoreSession</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="isOutputOpen()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isOutputOpen</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isOutputOpen()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../CoreSession.html#isOutputOpen()">isOutputOpen</a></code>&nbsp;in interface&nbsp;<code><a href="../CoreSession.html" title="interface in org.eclipse.jetty.websocket.core">CoreSession</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>True if the websocket is open outbound</dd>
</dl>
</li>
</ul>
<a id="isClosed()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isClosed</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isClosed()</pre>
</li>
</ul>
<a id="setWebSocketConnection(org.eclipse.jetty.websocket.core.internal.WebSocketConnection)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setWebSocketConnection</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setWebSocketConnection&#8203;(<a href="WebSocketConnection.html" title="class in org.eclipse.jetty.websocket.core.internal">WebSocketConnection</a>&nbsp;connection)</pre>
</li>
</ul>
<a id="close(org.eclipse.jetty.util.Callback)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>close</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;close&#8203;(<a href="../../../util/Callback.html" title="interface in org.eclipse.jetty.util">Callback</a>&nbsp;callback)</pre>
<div class="block">Send Close Frame with no payload.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../CoreSession.html#close(org.eclipse.jetty.util.Callback)">close</a></code>&nbsp;in interface&nbsp;<code><a href="../CoreSession.html" title="interface in org.eclipse.jetty.websocket.core">CoreSession</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>callback</code> - the callback on successful send of close frame</dd>
</dl>
</li>
</ul>
<a id="close(int,java.lang.String,org.eclipse.jetty.util.Callback)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>close</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;close&#8203;(int&nbsp;statusCode,
java.lang.String&nbsp;reason,
<a href="../../../util/Callback.html" title="interface in org.eclipse.jetty.util">Callback</a>&nbsp;callback)</pre>
<div class="block">Send Close Frame with specified Status Code and optional Reason</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../CoreSession.html#close(int,java.lang.String,org.eclipse.jetty.util.Callback)">close</a></code>&nbsp;in interface&nbsp;<code><a href="../CoreSession.html" title="interface in org.eclipse.jetty.websocket.core">CoreSession</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>statusCode</code> - a valid WebSocket status code</dd>
<dd><code>reason</code> - an optional reason phrase</dd>
<dd><code>callback</code> - the callback on successful send of close frame</dd>
</dl>
</li>
</ul>
<a id="getByteBufferPool()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getByteBufferPool</h4>
<pre class="methodSignature">public&nbsp;<a href="../../../io/ByteBufferPool.html" title="interface in org.eclipse.jetty.io">ByteBufferPool</a>&nbsp;getByteBufferPool()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../CoreSession.html#getByteBufferPool()">getByteBufferPool</a></code>&nbsp;in interface&nbsp;<code><a href="../CoreSession.html" title="interface in org.eclipse.jetty.websocket.core">CoreSession</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The shared ByteBufferPool</dd>
</dl>
</li>
</ul>
<a id="onEof()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>onEof</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;onEof()</pre>
</li>
</ul>
<a id="closeConnection(org.eclipse.jetty.websocket.core.CloseStatus,org.eclipse.jetty.util.Callback)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>closeConnection</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;closeConnection&#8203;(<a href="../CloseStatus.html" title="class in org.eclipse.jetty.websocket.core">CloseStatus</a>&nbsp;closeStatus,
<a href="../../../util/Callback.html" title="interface in org.eclipse.jetty.util">Callback</a>&nbsp;callback)</pre>
</li>
</ul>
<a id="processConnectionError(java.lang.Throwable,org.eclipse.jetty.util.Callback)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>processConnectionError</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;processConnectionError&#8203;(java.lang.Throwable&nbsp;cause,
<a href="../../../util/Callback.html" title="interface in org.eclipse.jetty.util">Callback</a>&nbsp;callback)</pre>
<div class="block">Process an Error that originated from the connection.
For protocol causes, send and abnormal close frame
otherwise just close the connection.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>cause</code> - the cause</dd>
<dd><code>callback</code> - the callback on completion of error handling</dd>
</dl>
</li>
</ul>
<a id="processHandlerError(java.lang.Throwable,org.eclipse.jetty.util.Callback)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>processHandlerError</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;processHandlerError&#8203;(java.lang.Throwable&nbsp;cause,
<a href="../../../util/Callback.html" title="interface in org.eclipse.jetty.util">Callback</a>&nbsp;callback)</pre>
<div class="block">Process an Error that originated from the handler.
Send an abnormal close frame to ensure connection is closed.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>cause</code> - the cause</dd>
<dd><code>callback</code> - the callback on completion of error handling</dd>
</dl>
</li>
</ul>
<a id="onOpen()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>onOpen</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;onOpen()</pre>
<div class="block">Open/Activate the session.</div>
</li>
</ul>
<a id="demand(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>demand</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;demand&#8203;(long&nbsp;n)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../CoreSession.html#demand(long)">CoreSession</a></code></span></div>
<div class="block">Manage flow control by indicating demand for handling Frames. A call to
<a href="../FrameHandler.html#onFrame(org.eclipse.jetty.websocket.core.Frame,org.eclipse.jetty.util.Callback)"><code>FrameHandler.onFrame(Frame, Callback)</code></a> will only be made if a
corresponding demand has been signaled. It is an error to call this method
if <a href="../FrameHandler.html#isDemanding()"><code>FrameHandler.isDemanding()</code></a> returns false.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../CoreSession.html#demand(long)">demand</a></code>&nbsp;in interface&nbsp;<code><a href="../CoreSession.html" title="interface in org.eclipse.jetty.websocket.core">CoreSession</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>n</code> - The number of frames that can be handled (in sequential calls to
<a href="../FrameHandler.html#onFrame(org.eclipse.jetty.websocket.core.Frame,org.eclipse.jetty.util.Callback)"><code>FrameHandler.onFrame(Frame, Callback)</code></a>). May not be negative.</dd>
</dl>
</li>
</ul>
<a id="getConnection()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConnection</h4>
<pre class="methodSignature">public&nbsp;<a href="WebSocketConnection.html" title="class in org.eclipse.jetty.websocket.core.internal">WebSocketConnection</a>&nbsp;getConnection()</pre>
</li>
</ul>
<a id="getExecutor()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getExecutor</h4>
<pre class="methodSignature">public&nbsp;java.util.concurrent.Executor&nbsp;getExecutor()</pre>
</li>
</ul>
<a id="onFrame(org.eclipse.jetty.websocket.core.Frame,org.eclipse.jetty.util.Callback)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>onFrame</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;onFrame&#8203;(<a href="../Frame.html" title="class in org.eclipse.jetty.websocket.core">Frame</a>&nbsp;frame,
<a href="../../../util/Callback.html" title="interface in org.eclipse.jetty.util">Callback</a>&nbsp;callback)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../IncomingFrames.html#onFrame(org.eclipse.jetty.websocket.core.Frame,org.eclipse.jetty.util.Callback)">IncomingFrames</a></code></span></div>
<div class="block">Process the incoming frame.
<p>
Note: if you need to hang onto any information from the frame, be sure
to copy it, as the information contained in the Frame will be released
and/or reused by the implementation.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../IncomingFrames.html#onFrame(org.eclipse.jetty.websocket.core.Frame,org.eclipse.jetty.util.Callback)">onFrame</a></code>&nbsp;in interface&nbsp;<code><a href="../IncomingFrames.html" title="interface in org.eclipse.jetty.websocket.core">IncomingFrames</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>frame</code> - the frame to process</dd>
<dd><code>callback</code> - the read completion</dd>
</dl>
</li>
</ul>
<a id="sendFrame(org.eclipse.jetty.websocket.core.Frame,org.eclipse.jetty.util.Callback,boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sendFrame</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;sendFrame&#8203;(<a href="../Frame.html" title="class in org.eclipse.jetty.websocket.core">Frame</a>&nbsp;frame,
<a href="../../../util/Callback.html" title="interface in org.eclipse.jetty.util">Callback</a>&nbsp;callback,
boolean&nbsp;batch)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../OutgoingFrames.html#sendFrame(org.eclipse.jetty.websocket.core.Frame,org.eclipse.jetty.util.Callback,boolean)">OutgoingFrames</a></code></span></div>
<div class="block">A frame, and optional callback, intended for the network layer.
<p>
Note: the frame can undergo many transformations in the various
layers and extensions present in the implementation.
<p>
If you are implementing a mutation, you are obliged to handle
the incoming WriteCallback appropriately.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../OutgoingFrames.html#sendFrame(org.eclipse.jetty.websocket.core.Frame,org.eclipse.jetty.util.Callback,boolean)">sendFrame</a></code>&nbsp;in interface&nbsp;<code><a href="../OutgoingFrames.html" title="interface in org.eclipse.jetty.websocket.core">OutgoingFrames</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>frame</code> - the frame to eventually write to the network layer.</dd>
<dd><code>callback</code> - the callback to notify when the frame is written.</dd>
<dd><code>batch</code> - the batch mode requested by the sender.</dd>
</dl>
</li>
</ul>
<a id="flush(org.eclipse.jetty.util.Callback)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>flush</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;flush&#8203;(<a href="../../../util/Callback.html" title="interface in org.eclipse.jetty.util">Callback</a>&nbsp;callback)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../CoreSession.html#flush(org.eclipse.jetty.util.Callback)">CoreSession</a></code></span></div>
<div class="block">If using BatchMode.ON or BatchMode.AUTO, trigger a flush of enqueued / batched frames.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../CoreSession.html#flush(org.eclipse.jetty.util.Callback)">flush</a></code>&nbsp;in interface&nbsp;<code><a href="../CoreSession.html" title="interface in org.eclipse.jetty.websocket.core">CoreSession</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>callback</code> - the callback to track close frame sent (or failed)</dd>
</dl>
</li>
</ul>
<a id="abort()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>abort</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;abort()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../CoreSession.html#abort()">CoreSession</a></code></span></div>
<div class="block">Issue a harsh abort of the underlying connection.
<p>
This will terminate the connection, without sending a websocket close frame.
No WebSocket Protocol close handshake will be performed.
</p>
<p>
Once called, any read/write activity on the websocket from this point will be indeterminate.
This can result in the <a href="../FrameHandler.html#onError(java.lang.Throwable,org.eclipse.jetty.util.Callback)"><code>FrameHandler.onError(Throwable, Callback)</code></a> event being called indicating any issue that arises.
</p>
<p>
Once the underlying connection has been determined to be closed, the <a href="../FrameHandler.html#onClosed(org.eclipse.jetty.websocket.core.CloseStatus,org.eclipse.jetty.util.Callback)"><code>FrameHandler.onClosed(CloseStatus, Callback)</code></a> event will be called.
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../CoreSession.html#abort()">abort</a></code>&nbsp;in interface&nbsp;<code><a href="../CoreSession.html" title="interface in org.eclipse.jetty.websocket.core">CoreSession</a></code></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>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../Configuration.html#isAutoFragment()">isAutoFragment</a></code>&nbsp;in interface&nbsp;<code><a href="../Configuration.html" title="interface in org.eclipse.jetty.websocket.core">Configuration</a></code></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>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../Configuration.html#setAutoFragment(boolean)">setAutoFragment</a></code>&nbsp;in interface&nbsp;<code><a href="../Configuration.html" title="interface in org.eclipse.jetty.websocket.core">Configuration</a></code></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>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../Configuration.html#getMaxFrameSize()">getMaxFrameSize</a></code>&nbsp;in interface&nbsp;<code><a href="../Configuration.html" title="interface in org.eclipse.jetty.websocket.core">Configuration</a></code></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>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../Configuration.html#setMaxFrameSize(long)">setMaxFrameSize</a></code>&nbsp;in interface&nbsp;<code><a href="../Configuration.html" title="interface in org.eclipse.jetty.websocket.core">Configuration</a></code></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>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../Configuration.html#getOutputBufferSize()">getOutputBufferSize</a></code>&nbsp;in interface&nbsp;<code><a href="../Configuration.html" title="interface in org.eclipse.jetty.websocket.core">Configuration</a></code></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;outputBufferSize)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../Configuration.html#setOutputBufferSize(int)">setOutputBufferSize</a></code>&nbsp;in interface&nbsp;<code><a href="../Configuration.html" title="interface in org.eclipse.jetty.websocket.core">Configuration</a></code></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>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../Configuration.html#getInputBufferSize()">getInputBufferSize</a></code>&nbsp;in interface&nbsp;<code><a href="../Configuration.html" title="interface in org.eclipse.jetty.websocket.core">Configuration</a></code></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;inputBufferSize)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../Configuration.html#setInputBufferSize(int)">setInputBufferSize</a></code>&nbsp;in interface&nbsp;<code><a href="../Configuration.html" title="interface in org.eclipse.jetty.websocket.core">Configuration</a></code></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>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../Configuration.html#getMaxBinaryMessageSize()">getMaxBinaryMessageSize</a></code>&nbsp;in interface&nbsp;<code><a href="../Configuration.html" title="interface in org.eclipse.jetty.websocket.core">Configuration</a></code></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;maxSize)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../Configuration.html#setMaxBinaryMessageSize(long)">setMaxBinaryMessageSize</a></code>&nbsp;in interface&nbsp;<code><a href="../Configuration.html" title="interface in org.eclipse.jetty.websocket.core">Configuration</a></code></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>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../Configuration.html#getMaxTextMessageSize()">getMaxTextMessageSize</a></code>&nbsp;in interface&nbsp;<code><a href="../Configuration.html" title="interface in org.eclipse.jetty.websocket.core">Configuration</a></code></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;maxSize)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../Configuration.html#setMaxTextMessageSize(long)">setMaxTextMessageSize</a></code>&nbsp;in interface&nbsp;<code><a href="../Configuration.html" title="interface in org.eclipse.jetty.websocket.core">Configuration</a></code></dd>
</dl>
</li>
</ul>
<a id="getMaxOutgoingFrames()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMaxOutgoingFrames</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;getMaxOutgoingFrames()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../Configuration.html#getMaxOutgoingFrames()">Configuration</a></code></span></div>
<div class="block">Get the maximum number of data frames allowed to be waiting to be sent at any one time.
The default value is -1, this indicates there is no limit on how many frames can be
queued to be sent by the implementation. If the limit is exceeded, subsequent frames
sent are failed with a <code>WritePendingException</code> but
the connection is not failed and will remain open.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../Configuration.html#getMaxOutgoingFrames()">getMaxOutgoingFrames</a></code>&nbsp;in interface&nbsp;<code><a href="../Configuration.html" title="interface in org.eclipse.jetty.websocket.core">Configuration</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the max number of frames.</dd>
</dl>
</li>
</ul>
<a id="setMaxOutgoingFrames(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMaxOutgoingFrames</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setMaxOutgoingFrames&#8203;(int&nbsp;maxOutgoingFrames)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../Configuration.html#setMaxOutgoingFrames(int)">Configuration</a></code></span></div>
<div class="block">Set the maximum number of data frames allowed to be waiting to be sent at any one time.
The default value is -1, this indicates there is no limit on how many frames can be
queued to be sent by the implementation. If the limit is exceeded, subsequent frames
sent are failed with a <code>WritePendingException</code> but
the connection is not failed and will remain open.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../Configuration.html#setMaxOutgoingFrames(int)">setMaxOutgoingFrames</a></code>&nbsp;in interface&nbsp;<code><a href="../Configuration.html" title="interface in org.eclipse.jetty.websocket.core">Configuration</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>maxOutgoingFrames</code> - the max number of frames.</dd>
</dl>
</li>
</ul>
<a id="dump()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>dump</h4>
<pre class="methodSignature">public&nbsp;java.lang.String&nbsp;dump()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../util/component/Dumpable.html#dump()">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>
</dl>
</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="getNegotiatedExtensions()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNegotiatedExtensions</h4>
<pre class="methodSignature">public&nbsp;java.util.List&lt;<a href="../ExtensionConfig.html" title="class in org.eclipse.jetty.websocket.core">ExtensionConfig</a>&gt;&nbsp;getNegotiatedExtensions()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../CoreSession.html#getNegotiatedExtensions()">CoreSession</a></code></span></div>
<div class="block">The negotiated WebSocket Extension Configurations for this session.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../CoreSession.html#getNegotiatedExtensions()">getNegotiatedExtensions</a></code>&nbsp;in interface&nbsp;<code><a href="../CoreSession.html" title="interface in org.eclipse.jetty.websocket.core">CoreSession</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the list of Negotiated Extension Configurations for this session.</dd>
</dl>
</li>
</ul>
<a id="getParameterMap()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getParameterMap</h4>
<pre class="methodSignature">public&nbsp;java.util.Map&lt;java.lang.String,&#8203;java.util.List&lt;java.lang.String&gt;&gt;&nbsp;getParameterMap()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../CoreSession.html#getParameterMap()">CoreSession</a></code></span></div>
<div class="block">The parameter map (from URI Query) for the active session.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../CoreSession.html#getParameterMap()">getParameterMap</a></code>&nbsp;in interface&nbsp;<code><a href="../CoreSession.html" title="interface in org.eclipse.jetty.websocket.core">CoreSession</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the immutable map of parameters</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="../CoreSession.html#getProtocolVersion()">CoreSession</a></code></span></div>
<div class="block">The active <code>Sec-WebSocket-Version</code> (protocol version) in use.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../CoreSession.html#getProtocolVersion()">getProtocolVersion</a></code>&nbsp;in interface&nbsp;<code><a href="../CoreSession.html" title="interface in org.eclipse.jetty.websocket.core">CoreSession</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the protocol version in use.</dd>
</dl>
</li>
</ul>
<a id="getRequestURI()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRequestURI</h4>
<pre class="methodSignature">public&nbsp;java.net.URI&nbsp;getRequestURI()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../CoreSession.html#getRequestURI()">CoreSession</a></code></span></div>
<div class="block">The active connection's Request URI.
This is the URI of the upgrade request and is typically http: or https: rather than
the ws: or wss: scheme.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../CoreSession.html#getRequestURI()">getRequestURI</a></code>&nbsp;in interface&nbsp;<code><a href="../CoreSession.html" title="interface in org.eclipse.jetty.websocket.core">CoreSession</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the absolute URI (including Query string)</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="../CoreSession.html#isSecure()">CoreSession</a></code></span></div>
<div class="block">The active connection's Secure status indicator.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../CoreSession.html#isSecure()">isSecure</a></code>&nbsp;in interface&nbsp;<code><a href="../CoreSession.html" title="interface in org.eclipse.jetty.websocket.core">CoreSession</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if connection is secure (similar in role to <code>HttpServletRequest.isSecure()</code>)</dd>
</dl>
</li>
</ul>
<a id="getBehavior()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBehavior</h4>
<pre class="methodSignature">public&nbsp;<a href="../Behavior.html" title="enum in org.eclipse.jetty.websocket.core">Behavior</a>&nbsp;getBehavior()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../CoreSession.html#getBehavior()">getBehavior</a></code>&nbsp;in interface&nbsp;<code><a href="../CoreSession.html" title="interface in org.eclipse.jetty.websocket.core">CoreSession</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Client or Server behaviour</dd>
</dl>
</li>
</ul>
<a id="getWebSocketComponents()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getWebSocketComponents</h4>
<pre class="methodSignature">public&nbsp;<a href="../WebSocketComponents.html" title="class in org.eclipse.jetty.websocket.core">WebSocketComponents</a>&nbsp;getWebSocketComponents()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../CoreSession.html#getWebSocketComponents()">CoreSession</a></code></span></div>
<div class="block">TODO</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../CoreSession.html#getWebSocketComponents()">getWebSocketComponents</a></code>&nbsp;in interface&nbsp;<code><a href="../CoreSession.html" title="interface in org.eclipse.jetty.websocket.core">CoreSession</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
</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/WebSocketCoreSession.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;2020 <a href="https://webtide.com">Webtide</a>. All rights reserved.</small></p>
</footer>
</body>
</html>