blob: 18fded9a0cb4f62db0fab6857eb3acc864bfde7b [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.7) on Fri Jun 12 14:11:40 EDT 2020 -->
<title>AbstractWebSocketConnection (Jetty :: Project 9.4.30.v20200611 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2020-06-12">
<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="AbstractWebSocketConnection (Jetty :: Project 9.4.30.v20200611 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":42,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":10,"i32":10,"i33":10,"i34":10,"i35":10,"i36":10,"i37":10,"i38":10,"i39":10,"i40":10,"i41":10,"i42":10,"i43":10,"i44":10,"i45":10,"i46":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../../../";
var useModuleDirectories = false;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/AbstractWebSocketConnection.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.io</a></div>
<h2 title="Class AbstractWebSocketConnection" class="title">Class AbstractWebSocketConnection</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../io/AbstractConnection.html" title="class in org.eclipse.jetty.io">org.eclipse.jetty.io.AbstractConnection</a></li>
<li>
<ul class="inheritance">
<li>org.eclipse.jetty.websocket.common.io.AbstractWebSocketConnection</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code>java.io.Closeable</code>, <code>java.lang.AutoCloseable</code>, <code><a href="../../../io/Connection.html" title="interface in org.eclipse.jetty.io">Connection</a></code>, <code><a href="../../../io/Connection.UpgradeTo.html" title="interface in org.eclipse.jetty.io">Connection.UpgradeTo</a></code>, <code><a href="../../../util/component/Dumpable.html" title="interface in org.eclipse.jetty.util.component">Dumpable</a></code>, <code><a href="../../api/extensions/OutgoingFrames.html" title="interface in org.eclipse.jetty.websocket.api.extensions">OutgoingFrames</a></code>, <code><a href="../../api/SuspendToken.html" title="interface in org.eclipse.jetty.websocket.api">SuspendToken</a></code>, <code><a href="../LogicalConnection.html" title="interface in org.eclipse.jetty.websocket.common">LogicalConnection</a></code></dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><code><a href="../../client/io/WebSocketClientConnection.html" title="class in org.eclipse.jetty.websocket.client.io">WebSocketClientConnection</a></code>, <code><a href="../../server/WebSocketServerConnection.html" title="class in org.eclipse.jetty.websocket.server">WebSocketServerConnection</a></code></dd>
</dl>
<hr>
<pre>public abstract class <span class="typeNameLabel">AbstractWebSocketConnection</span>
extends <a href="../../../io/AbstractConnection.html" title="class in org.eclipse.jetty.io">AbstractConnection</a>
implements <a href="../LogicalConnection.html" title="interface in org.eclipse.jetty.websocket.common">LogicalConnection</a>, <a href="../../../io/Connection.UpgradeTo.html" title="interface in org.eclipse.jetty.io">Connection.UpgradeTo</a>, <a href="../../../util/component/Dumpable.html" title="interface in org.eclipse.jetty.util.component">Dumpable</a></pre>
<div class="block">Provides the implementation of <a href="../LogicalConnection.html" title="interface in org.eclipse.jetty.websocket.common"><code>LogicalConnection</code></a> within the framework of the new <a href="../../../io/Connection.html" title="interface in org.eclipse.jetty.io"><code>Connection</code></a> framework of <code>jetty-io</code>.</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>
<table class="memberSummary">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="AbstractWebSocketConnection.Stats.html" title="class in org.eclipse.jetty.websocket.common.io">AbstractWebSocketConnection.Stats</a></span></code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="nested.classes.inherited.from.class.org.eclipse.jetty.io.Connection">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface&nbsp;org.eclipse.jetty.io.<a href="../../../io/Connection.html" title="interface in org.eclipse.jetty.io">Connection</a></h3>
<code><a href="../../../io/Connection.Listener.html" title="interface in org.eclipse.jetty.io">Connection.Listener</a>, <a href="../../../io/Connection.UpgradeFrom.html" title="interface in org.eclipse.jetty.io">Connection.UpgradeFrom</a>, <a href="../../../io/Connection.UpgradeTo.html" title="interface in org.eclipse.jetty.io">Connection.UpgradeTo</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.io.EndPoint,java.util.concurrent.Executor,org.eclipse.jetty.util.thread.Scheduler,org.eclipse.jetty.websocket.api.WebSocketPolicy,org.eclipse.jetty.io.ByteBufferPool)">AbstractWebSocketConnection</a></span>&#8203;(<a href="../../../io/EndPoint.html" title="interface in org.eclipse.jetty.io">EndPoint</a>&nbsp;endp,
java.util.concurrent.Executor&nbsp;executor,
<a href="../../../util/thread/Scheduler.html" title="interface in org.eclipse.jetty.util.thread">Scheduler</a>&nbsp;scheduler,
<a href="../../api/WebSocketPolicy.html" title="class in org.eclipse.jetty.websocket.api">WebSocketPolicy</a>&nbsp;policy,
<a href="../../../io/ByteBufferPool.html" title="interface in org.eclipse.jetty.io">ByteBufferPool</a>&nbsp;bufferPool)</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><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated 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>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#canReadWebSocketFrames()">canReadWebSocketFrames</a></span>()</code></th>
<td class="colLast">
<div class="block">Test if Connection State allows for reading of frames.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#canWriteWebSocketFrames()">canWriteWebSocketFrames</a></span>()</code></th>
<td class="colLast">
<div class="block">Test if Connection State allows for writing frames.</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()">close</a></span>()</code></th>
<td class="colLast">
<div class="block">Jetty Connection Close</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#close(java.lang.Throwable)">close</a></span>&#8203;(java.lang.Throwable&nbsp;cause)</code></th>
<td class="colLast">
<div class="block">Close the connection based on the throwable</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#close(org.eclipse.jetty.websocket.common.CloseInfo,org.eclipse.jetty.util.Callback)">close</a></span>&#8203;(<a href="../CloseInfo.html" title="class in org.eclipse.jetty.websocket.common">CloseInfo</a>&nbsp;close,
<a href="../../../util/Callback.html" title="interface in org.eclipse.jetty.util">Callback</a>&nbsp;callback)</code></th>
<td class="colLast">
<div class="block">Request a local close.</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="#disconnect()">disconnect</a></span>()</code></th>
<td class="colLast">
<div class="block">Terminate the connection (no close frame sent)</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="#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="i7" 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="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#fillInterested()">fillInterested</a></span>()</code></th>
<td class="colLast">
<div class="block">Utility method to be called to register read interest.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="../../../io/ByteBufferPool.html" title="interface in org.eclipse.jetty.io">ByteBufferPool</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getBufferPool()">getBufferPool</a></span>()</code></th>
<td class="colLast">
<div class="block">Get the ByteBufferPool in use by the connection</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getBytesIn()">getBytesIn</a></span>()</code></th>
<td class="colLast">&nbsp;</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="#getBytesOut()">getBytesOut</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i12" 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">
<div class="block">Get the Executor used by this connection.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>java.util.List&lt;<a href="../../api/extensions/ExtensionConfig.html" title="class in org.eclipse.jetty.websocket.api.extensions">ExtensionConfig</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getExtensions()">getExtensions</a></span>()</code></th>
<td class="colLast">
<div class="block">Get the list of extensions in use.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code><a href="../Generator.html" title="class in org.eclipse.jetty.websocket.common">Generator</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getGenerator()">getGenerator</a></span>()</code></th>
<td class="colLast">&nbsp;</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="#getId()">getId</a></span>()</code></th>
<td class="colLast">
<div class="block">Get Unique ID for the Connection</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getIdleTimeout()">getIdleTimeout</a></span>()</code></th>
<td class="colLast">
<div class="block">Get the read/write idle timeout.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>java.net.InetSocketAddress</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLocalAddress()">getLocalAddress</a></span>()</code></th>
<td class="colLast">
<div class="block">Get the local <code>InetSocketAddress</code> in use for this connection.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMaxIdleTimeout()">getMaxIdleTimeout</a></span>()</code></th>
<td class="colLast">
<div class="block">Set the maximum number of milliseconds of idleness before the connection is closed/disconnected, (ie no frames are either sent or received)</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMessagesIn()">getMessagesIn</a></span>()</code></th>
<td class="colLast">&nbsp;</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="#getMessagesOut()">getMessagesOut</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code><a href="../Parser.html" title="class in org.eclipse.jetty.websocket.common">Parser</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getParser()">getParser</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code><a href="../../api/WebSocketPolicy.html" title="class in org.eclipse.jetty.websocket.api">WebSocketPolicy</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPolicy()">getPolicy</a></span>()</code></th>
<td class="colLast">
<div class="block">The policy that the connection is running under.</div>
</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code>java.net.InetSocketAddress</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRemoteAddress()">getRemoteAddress</a></span>()</code></th>
<td class="colLast">
<div class="block">Get the remote Address in use for this connection.</div>
</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code><a href="../../../util/thread/Scheduler.html" title="interface in org.eclipse.jetty.util.thread">Scheduler</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getScheduler()">getScheduler</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><code><a href="AbstractWebSocketConnection.Stats.html" title="class in org.eclipse.jetty.websocket.common.io">AbstractWebSocketConnection.Stats</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getStats()">getStats</a></span>()</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
</td>
</tr>
<tr id="i26" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isOpen()">isOpen</a></span>()</code></th>
<td class="colLast">
<div class="block">Test if logical connection is still open</div>
</td>
</tr>
<tr id="i27" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isReading()">isReading</a></span>()</code></th>
<td class="colLast">
<div class="block">Tests if the connection is actively reading.</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="#onFillable()">onFillable</a></span>()</code></th>
<td class="colLast">
<div class="block">Callback method invoked when the endpoint is ready to be read.</div>
</td>
</tr>
<tr id="i29" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onFillInterestedFailed(java.lang.Throwable)">onFillInterestedFailed</a></span>&#8203;(java.lang.Throwable&nbsp;cause)</code></th>
<td class="colLast">
<div class="block">Callback method invoked when the endpoint failed to be ready to be read.</div>
</td>
</tr>
<tr id="i30" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onIdleExpired()">onIdleExpired</a></span>()</code></th>
<td class="colLast">
<div class="block">Callback method invoked upon an idle timeout event.</div>
</td>
</tr>
<tr id="i31" class="rowColor">
<td class="colFirst"><code>protected boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onReadTimeout(java.lang.Throwable)">onReadTimeout</a></span>&#8203;(java.lang.Throwable&nbsp;timeout)</code></th>
<td class="colLast">
<div class="block">Event for no activity on connection (read or write)</div>
</td>
</tr>
<tr id="i32" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onUpgradeTo(java.nio.ByteBuffer)">onUpgradeTo</a></span>&#8203;(java.nio.ByteBuffer&nbsp;prefilled)</code></th>
<td class="colLast">
<div class="block">Extra bytes from the initial HTTP upgrade that need to
be processed by the websocket parser before starting
to read bytes from the connection</div>
</td>
</tr>
<tr id="i33" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#opened()">opened</a></span>()</code></th>
<td class="colLast">
<div class="block">Set the state to opened (the application onOpen() method has been called successfully).</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="#opening()">opening</a></span>()</code></th>
<td class="colLast">
<div class="block">Set the state to upgrade/opening handshake has completed.</div>
</td>
</tr>
<tr id="i35" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#outgoingFrame(org.eclipse.jetty.websocket.api.extensions.Frame,org.eclipse.jetty.websocket.api.WriteCallback,org.eclipse.jetty.websocket.api.BatchMode)">outgoingFrame</a></span>&#8203;(<a href="../../api/extensions/Frame.html" title="interface in org.eclipse.jetty.websocket.api.extensions">Frame</a>&nbsp;frame,
<a href="../../api/WriteCallback.html" title="interface in org.eclipse.jetty.websocket.api">WriteCallback</a>&nbsp;callback,
<a href="../../api/BatchMode.html" title="enum in org.eclipse.jetty.websocket.api">BatchMode</a>&nbsp;batchMode)</code></th>
<td class="colLast">
<div class="block">Frame from API, User, or Internal implementation destined for network.</div>
</td>
</tr>
<tr id="i36" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#remoteClose(org.eclipse.jetty.websocket.common.CloseInfo)">remoteClose</a></span>&#8203;(<a href="../CloseInfo.html" title="class in org.eclipse.jetty.websocket.common">CloseInfo</a>&nbsp;close)</code></th>
<td class="colLast">
<div class="block">Report that the Remote Endpoint CLOSE Frame has been received</div>
</td>
</tr>
<tr id="i37" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#resume()">resume</a></span>()</code></th>
<td class="colLast">
<div class="block">Resume a previously suspended connection.</div>
</td>
</tr>
<tr id="i38" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setExtensions(java.util.List)">setExtensions</a></span>&#8203;(java.util.List&lt;<a href="../../api/extensions/ExtensionConfig.html" title="class in org.eclipse.jetty.websocket.api.extensions">ExtensionConfig</a>&gt;&nbsp;extensions)</code></th>
<td class="colLast">
<div class="block">Get the list of extensions in use.</div>
</td>
</tr>
<tr id="i39" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setInitialBuffer(java.nio.ByteBuffer)">setInitialBuffer</a></span>&#8203;(java.nio.ByteBuffer&nbsp;prefilled)</code></th>
<td class="colLast">
<div class="block">Extra bytes from the initial HTTP upgrade that need to
be processed by the websocket parser before starting
to read bytes from the connection</div>
</td>
</tr>
<tr id="i40" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setInputBufferSize(int)">setInputBufferSize</a></span>&#8203;(int&nbsp;inputBufferSize)</code></th>
<td class="colLast">&nbsp;</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="#setMaxIdleTimeout(long)">setMaxIdleTimeout</a></span>&#8203;(long&nbsp;ms)</code></th>
<td class="colLast">
<div class="block">Set the maximum number of milliseconds of idleness before the connection is closed/disconnected, (ie no frames are either sent or received)</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="#setNextIncomingFrames(org.eclipse.jetty.websocket.api.extensions.IncomingFrames)">setNextIncomingFrames</a></span>&#8203;(<a href="../../api/extensions/IncomingFrames.html" title="interface in org.eclipse.jetty.websocket.api.extensions">IncomingFrames</a>&nbsp;incoming)</code></th>
<td class="colLast">
<div class="block">Set where the connection should send the incoming frames to.</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="#setSession(org.eclipse.jetty.websocket.common.WebSocketSession)">setSession</a></span>&#8203;(<a href="../WebSocketSession.html" title="class in org.eclipse.jetty.websocket.common">WebSocketSession</a>&nbsp;session)</code></th>
<td class="colLast">
<div class="block">Associate the Active Session with the connection.</div>
</td>
</tr>
<tr id="i44" class="altColor">
<td class="colFirst"><code><a href="../../api/SuspendToken.html" title="interface in org.eclipse.jetty.websocket.api">SuspendToken</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#suspend()">suspend</a></span>()</code></th>
<td class="colLast">
<div class="block">Suspend a the incoming read events on the connection.</div>
</td>
</tr>
<tr id="i45" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toConnectionString()">toConnectionString</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i46" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toStateString()">toStateString</a></span>()</code></th>
<td class="colLast">
<div class="block">Get the Connection State as a String</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.eclipse.jetty.io.AbstractConnection">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.eclipse.jetty.io.<a href="../../../io/AbstractConnection.html" title="class in org.eclipse.jetty.io">AbstractConnection</a></h3>
<code><a href="../../../io/AbstractConnection.html#addListener(org.eclipse.jetty.io.Connection.Listener)">addListener</a>, <a href="../../../io/AbstractConnection.html#failedCallback(org.eclipse.jetty.util.Callback,java.lang.Throwable)">failedCallback</a>, <a href="../../../io/AbstractConnection.html#getCreatedTimeStamp()">getCreatedTimeStamp</a>, <a href="../../../io/AbstractConnection.html#getEndPoint()">getEndPoint</a>, <a href="../../../io/AbstractConnection.html#getInputBufferSize()">getInputBufferSize</a>, <a href="../../../io/AbstractConnection.html#isFillInterested()">isFillInterested</a>, <a href="../../../io/AbstractConnection.html#onClose()">onClose</a>, <a href="../../../io/AbstractConnection.html#onOpen()">onOpen</a>, <a href="../../../io/AbstractConnection.html#removeListener(org.eclipse.jetty.io.Connection.Listener)">removeListener</a>, <a href="../../../io/AbstractConnection.html#toString()">toString</a>, <a href="../../../io/AbstractConnection.html#tryFillInterested()">tryFillInterested</a>, <a href="../../../io/AbstractConnection.html#tryFillInterested(org.eclipse.jetty.util.Callback)">tryFillInterested</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&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>
</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.io.EndPoint,java.util.concurrent.Executor,org.eclipse.jetty.util.thread.Scheduler,org.eclipse.jetty.websocket.api.WebSocketPolicy,org.eclipse.jetty.io.ByteBufferPool)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>AbstractWebSocketConnection</h4>
<pre>public&nbsp;AbstractWebSocketConnection&#8203;(<a href="../../../io/EndPoint.html" title="interface in org.eclipse.jetty.io">EndPoint</a>&nbsp;endp,
java.util.concurrent.Executor&nbsp;executor,
<a href="../../../util/thread/Scheduler.html" title="interface in org.eclipse.jetty.util.thread">Scheduler</a>&nbsp;scheduler,
<a href="../../api/WebSocketPolicy.html" title="class in org.eclipse.jetty.websocket.api">WebSocketPolicy</a>&nbsp;policy,
<a href="../../../io/ByteBufferPool.html" title="interface in org.eclipse.jetty.io">ByteBufferPool</a>&nbsp;bufferPool)</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="getExecutor()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getExecutor</h4>
<pre class="methodSignature">public&nbsp;java.util.concurrent.Executor&nbsp;getExecutor()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../LogicalConnection.html#getExecutor()">LogicalConnection</a></code></span></div>
<div class="block">Get the Executor used by this connection.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../LogicalConnection.html#getExecutor()">getExecutor</a></code>&nbsp;in interface&nbsp;<code><a href="../LogicalConnection.html" title="interface in org.eclipse.jetty.websocket.common">LogicalConnection</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../io/AbstractConnection.html#getExecutor()">getExecutor</a></code>&nbsp;in class&nbsp;<code><a href="../../../io/AbstractConnection.html" title="class in org.eclipse.jetty.io">AbstractConnection</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the executor</dd>
</dl>
</li>
</ul>
<a id="close(org.eclipse.jetty.websocket.common.CloseInfo,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="../CloseInfo.html" title="class in org.eclipse.jetty.websocket.common">CloseInfo</a>&nbsp;close,
<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="../LogicalConnection.html#close(org.eclipse.jetty.websocket.common.CloseInfo,org.eclipse.jetty.util.Callback)">LogicalConnection</a></code></span></div>
<div class="block">Request a local close.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../LogicalConnection.html#close(org.eclipse.jetty.websocket.common.CloseInfo,org.eclipse.jetty.util.Callback)">close</a></code>&nbsp;in interface&nbsp;<code><a href="../LogicalConnection.html" title="interface in org.eclipse.jetty.websocket.common">LogicalConnection</a></code></dd>
</dl>
</li>
</ul>
<a id="close(java.lang.Throwable)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>close</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;close&#8203;(java.lang.Throwable&nbsp;cause)</pre>
<div class="block">Close the connection based on the throwable</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../LogicalConnection.html#close(java.lang.Throwable)">close</a></code>&nbsp;in interface&nbsp;<code><a href="../LogicalConnection.html" title="interface in org.eclipse.jetty.websocket.common">LogicalConnection</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>cause</code> - the cause</dd>
</dl>
</li>
</ul>
<a id="canWriteWebSocketFrames()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>canWriteWebSocketFrames</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;canWriteWebSocketFrames()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../LogicalConnection.html#canWriteWebSocketFrames()">LogicalConnection</a></code></span></div>
<div class="block">Test if Connection State allows for writing frames.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../LogicalConnection.html#canWriteWebSocketFrames()">canWriteWebSocketFrames</a></code>&nbsp;in interface&nbsp;<code><a href="../LogicalConnection.html" title="interface in org.eclipse.jetty.websocket.common">LogicalConnection</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if able to write, false otherwise.</dd>
</dl>
</li>
</ul>
<a id="canReadWebSocketFrames()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>canReadWebSocketFrames</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;canReadWebSocketFrames()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../LogicalConnection.html#canReadWebSocketFrames()">LogicalConnection</a></code></span></div>
<div class="block">Test if Connection State allows for reading of frames.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../LogicalConnection.html#canReadWebSocketFrames()">canReadWebSocketFrames</a></code>&nbsp;in interface&nbsp;<code><a href="../LogicalConnection.html" title="interface in org.eclipse.jetty.websocket.common">LogicalConnection</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if able to read, false otherwise.</dd>
</dl>
</li>
</ul>
<a id="toStateString()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toStateString</h4>
<pre class="methodSignature">public&nbsp;java.lang.String&nbsp;toStateString()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../LogicalConnection.html#toStateString()">LogicalConnection</a></code></span></div>
<div class="block">Get the Connection State as a String</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../LogicalConnection.html#toStateString()">toStateString</a></code>&nbsp;in interface&nbsp;<code><a href="../LogicalConnection.html" title="interface in org.eclipse.jetty.websocket.common">LogicalConnection</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the Connection State string</dd>
</dl>
</li>
</ul>
<a id="opening()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>opening</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;opening()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../LogicalConnection.html#opening()">LogicalConnection</a></code></span></div>
<div class="block">Set the state to upgrade/opening handshake has completed.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../LogicalConnection.html#opening()">opening</a></code>&nbsp;in interface&nbsp;<code><a href="../LogicalConnection.html" title="interface in org.eclipse.jetty.websocket.common">LogicalConnection</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if state is OPENING, false otherwise</dd>
</dl>
</li>
</ul>
<a id="opened()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>opened</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;opened()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../LogicalConnection.html#opened()">LogicalConnection</a></code></span></div>
<div class="block">Set the state to opened (the application onOpen() method has been called successfully).
<p>
Reads from network begin here.
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../LogicalConnection.html#opened()">opened</a></code>&nbsp;in interface&nbsp;<code><a href="../LogicalConnection.html" title="interface in org.eclipse.jetty.websocket.common">LogicalConnection</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if state is OPENED, false otherwise</dd>
</dl>
</li>
</ul>
<a id="remoteClose(org.eclipse.jetty.websocket.common.CloseInfo)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>remoteClose</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;remoteClose&#8203;(<a href="../CloseInfo.html" title="class in org.eclipse.jetty.websocket.common">CloseInfo</a>&nbsp;close)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../LogicalConnection.html#remoteClose(org.eclipse.jetty.websocket.common.CloseInfo)">LogicalConnection</a></code></span></div>
<div class="block">Report that the Remote Endpoint CLOSE Frame has been received</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../LogicalConnection.html#remoteClose(org.eclipse.jetty.websocket.common.CloseInfo)">remoteClose</a></code>&nbsp;in interface&nbsp;<code><a href="../LogicalConnection.html" title="interface in org.eclipse.jetty.websocket.common">LogicalConnection</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>close</code> - the close frame details</dd>
</dl>
</li>
</ul>
<a id="setSession(org.eclipse.jetty.websocket.common.WebSocketSession)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSession</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setSession&#8203;(<a href="../WebSocketSession.html" title="class in org.eclipse.jetty.websocket.common">WebSocketSession</a>&nbsp;session)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../LogicalConnection.html#setSession(org.eclipse.jetty.websocket.common.WebSocketSession)">LogicalConnection</a></code></span></div>
<div class="block">Associate the Active Session with the connection.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../LogicalConnection.html#setSession(org.eclipse.jetty.websocket.common.WebSocketSession)">setSession</a></code>&nbsp;in interface&nbsp;<code><a href="../LogicalConnection.html" title="interface in org.eclipse.jetty.websocket.common">LogicalConnection</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>session</code> - the session for this connection</dd>
</dl>
</li>
</ul>
<a id="onIdleExpired()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>onIdleExpired</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;onIdleExpired()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../io/Connection.html#onIdleExpired()">Connection</a></code></span></div>
<div class="block"><p>Callback method invoked upon an idle timeout event.</p>
<p>Implementations of this method may return true to indicate that the idle timeout
handling should proceed normally, typically failing the EndPoint and causing it to
be closed.</p>
<p>When false is returned, the handling of the idle timeout event is halted
immediately and the EndPoint left in the state it was before the idle timeout event.</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../io/Connection.html#onIdleExpired()">onIdleExpired</a></code>&nbsp;in interface&nbsp;<code><a href="../../../io/Connection.html" title="interface in org.eclipse.jetty.io">Connection</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../io/AbstractConnection.html#onIdleExpired()">onIdleExpired</a></code>&nbsp;in class&nbsp;<code><a href="../../../io/AbstractConnection.html" title="class in org.eclipse.jetty.io">AbstractConnection</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true to let the EndPoint handle the idle timeout,
false to tell the EndPoint to halt the handling of the idle timeout.</dd>
</dl>
</li>
</ul>
<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">Jetty Connection Close</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="../../../io/Connection.html#close()">close</a></code>&nbsp;in interface&nbsp;<code><a href="../../../io/Connection.html" title="interface in org.eclipse.jetty.io">Connection</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../io/AbstractConnection.html#close()">close</a></code>&nbsp;in class&nbsp;<code><a href="../../../io/AbstractConnection.html" title="class in org.eclipse.jetty.io">AbstractConnection</a></code></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="../LogicalConnection.html#disconnect()">LogicalConnection</a></code></span></div>
<div class="block">Terminate the connection (no close frame sent)</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../LogicalConnection.html#disconnect()">disconnect</a></code>&nbsp;in interface&nbsp;<code><a href="../LogicalConnection.html" title="interface in org.eclipse.jetty.websocket.common">LogicalConnection</a></code></dd>
</dl>
</li>
</ul>
<a id="fillInterested()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fillInterested</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;fillInterested()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../io/AbstractConnection.html#fillInterested()">AbstractConnection</a></code></span></div>
<div class="block"><p>Utility method to be called to register read interest.</p>
<p>After a call to this method, <a href="../../../io/AbstractConnection.html#onFillable()"><code>AbstractConnection.onFillable()</code></a> or <a href="../../../io/AbstractConnection.html#onFillInterestedFailed(java.lang.Throwable)"><code>AbstractConnection.onFillInterestedFailed(Throwable)</code></a>
will be called back as appropriate.</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../io/AbstractConnection.html#fillInterested()">fillInterested</a></code>&nbsp;in class&nbsp;<code><a href="../../../io/AbstractConnection.html" title="class in org.eclipse.jetty.io">AbstractConnection</a></code></dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../io/AbstractConnection.html#onFillable()"><code>AbstractConnection.onFillable()</code></a></dd>
</dl>
</li>
</ul>
<a id="getBufferPool()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBufferPool</h4>
<pre class="methodSignature">public&nbsp;<a href="../../../io/ByteBufferPool.html" title="interface in org.eclipse.jetty.io">ByteBufferPool</a>&nbsp;getBufferPool()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../LogicalConnection.html#getBufferPool()">LogicalConnection</a></code></span></div>
<div class="block">Get the ByteBufferPool in use by the connection</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../LogicalConnection.html#getBufferPool()">getBufferPool</a></code>&nbsp;in interface&nbsp;<code><a href="../LogicalConnection.html" title="interface in org.eclipse.jetty.websocket.common">LogicalConnection</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the buffer pool</dd>
</dl>
</li>
</ul>
<a id="getExtensions()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getExtensions</h4>
<pre class="methodSignature">public&nbsp;java.util.List&lt;<a href="../../api/extensions/ExtensionConfig.html" title="class in org.eclipse.jetty.websocket.api.extensions">ExtensionConfig</a>&gt;&nbsp;getExtensions()</pre>
<div class="block">Get the list of extensions in use.
<p>
This list is negotiated during the WebSocket Upgrade Request/Response handshake.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the list of negotiated extensions in use.</dd>
</dl>
</li>
</ul>
<a id="getGenerator()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getGenerator</h4>
<pre class="methodSignature">public&nbsp;<a href="../Generator.html" title="class in org.eclipse.jetty.websocket.common">Generator</a>&nbsp;getGenerator()</pre>
</li>
</ul>
<a id="getId()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getId</h4>
<pre class="methodSignature">public&nbsp;java.lang.String&nbsp;getId()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../LogicalConnection.html#getId()">LogicalConnection</a></code></span></div>
<div class="block">Get Unique ID for the Connection</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../LogicalConnection.html#getId()">getId</a></code>&nbsp;in interface&nbsp;<code><a href="../LogicalConnection.html" title="interface in org.eclipse.jetty.websocket.common">LogicalConnection</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the unique ID for the connection</dd>
</dl>
</li>
</ul>
<a id="getIdleTimeout()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getIdleTimeout</h4>
<pre class="methodSignature">public&nbsp;long&nbsp;getIdleTimeout()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../LogicalConnection.html#getIdleTimeout()">LogicalConnection</a></code></span></div>
<div class="block">Get the read/write idle timeout.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../LogicalConnection.html#getIdleTimeout()">getIdleTimeout</a></code>&nbsp;in interface&nbsp;<code><a href="../LogicalConnection.html" title="interface in org.eclipse.jetty.websocket.common">LogicalConnection</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the idle timeout in milliseconds</dd>
</dl>
</li>
</ul>
<a id="getMaxIdleTimeout()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMaxIdleTimeout</h4>
<pre class="methodSignature">public&nbsp;long&nbsp;getMaxIdleTimeout()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../LogicalConnection.html#getMaxIdleTimeout()">LogicalConnection</a></code></span></div>
<div class="block">Set the maximum number of milliseconds of idleness before the connection is closed/disconnected, (ie no frames are either sent or received)</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../LogicalConnection.html#getMaxIdleTimeout()">getMaxIdleTimeout</a></code>&nbsp;in interface&nbsp;<code><a href="../LogicalConnection.html" title="interface in org.eclipse.jetty.websocket.common">LogicalConnection</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the idle timeout in milliseconds</dd>
</dl>
</li>
</ul>
<a id="getParser()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getParser</h4>
<pre class="methodSignature">public&nbsp;<a href="../Parser.html" title="class in org.eclipse.jetty.websocket.common">Parser</a>&nbsp;getParser()</pre>
</li>
</ul>
<a id="getPolicy()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPolicy</h4>
<pre class="methodSignature">public&nbsp;<a href="../../api/WebSocketPolicy.html" title="class in org.eclipse.jetty.websocket.api">WebSocketPolicy</a>&nbsp;getPolicy()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../LogicalConnection.html#getPolicy()">LogicalConnection</a></code></span></div>
<div class="block">The policy that the connection is running under.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../LogicalConnection.html#getPolicy()">getPolicy</a></code>&nbsp;in interface&nbsp;<code><a href="../LogicalConnection.html" title="interface in org.eclipse.jetty.websocket.common">LogicalConnection</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the policy for the connection</dd>
</dl>
</li>
</ul>
<a id="getLocalAddress()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLocalAddress</h4>
<pre class="methodSignature">public&nbsp;java.net.InetSocketAddress&nbsp;getLocalAddress()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../LogicalConnection.html#getLocalAddress()">LogicalConnection</a></code></span></div>
<div class="block">Get the local <code>InetSocketAddress</code> in use for this connection.
<p>
Note: Non-physical connections, like during the Mux extensions, or during unit testing can result in a InetSocketAddress on port 0 and/or on localhost.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../LogicalConnection.html#getLocalAddress()">getLocalAddress</a></code>&nbsp;in interface&nbsp;<code><a href="../LogicalConnection.html" title="interface in org.eclipse.jetty.websocket.common">LogicalConnection</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the local address.</dd>
</dl>
</li>
</ul>
<a id="getRemoteAddress()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRemoteAddress</h4>
<pre class="methodSignature">public&nbsp;java.net.InetSocketAddress&nbsp;getRemoteAddress()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../LogicalConnection.html#getRemoteAddress()">LogicalConnection</a></code></span></div>
<div class="block">Get the remote Address in use for this connection.
<p>
Note: Non-physical connections, like during the Mux extensions, or during unit testing can result in a InetSocketAddress on port 0 and/or on localhost.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../LogicalConnection.html#getRemoteAddress()">getRemoteAddress</a></code>&nbsp;in interface&nbsp;<code><a href="../LogicalConnection.html" title="interface in org.eclipse.jetty.websocket.common">LogicalConnection</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the remote address.</dd>
</dl>
</li>
</ul>
<a id="getScheduler()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getScheduler</h4>
<pre class="methodSignature">public&nbsp;<a href="../../../util/thread/Scheduler.html" title="interface in org.eclipse.jetty.util.thread">Scheduler</a>&nbsp;getScheduler()</pre>
</li>
</ul>
<a id="getStats()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStats</h4>
<pre class="methodSignature">@Deprecated
public&nbsp;<a href="AbstractWebSocketConnection.Stats.html" title="class in org.eclipse.jetty.websocket.common.io">AbstractWebSocketConnection.Stats</a>&nbsp;getStats()</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div>
</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="../LogicalConnection.html#isOpen()">LogicalConnection</a></code></span></div>
<div class="block">Test if logical connection is still open</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../LogicalConnection.html#isOpen()">isOpen</a></code>&nbsp;in interface&nbsp;<code><a href="../LogicalConnection.html" title="interface in org.eclipse.jetty.websocket.common">LogicalConnection</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if connection is open</dd>
</dl>
</li>
</ul>
<a id="isReading()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isReading</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isReading()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../LogicalConnection.html#isReading()">LogicalConnection</a></code></span></div>
<div class="block">Tests if the connection is actively reading.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../LogicalConnection.html#isReading()">isReading</a></code>&nbsp;in interface&nbsp;<code><a href="../LogicalConnection.html" title="interface in org.eclipse.jetty.websocket.common">LogicalConnection</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if connection is actively attempting to read.</dd>
</dl>
</li>
</ul>
<a id="onFillable()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>onFillable</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;onFillable()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../io/AbstractConnection.html#onFillable()">AbstractConnection</a></code></span></div>
<div class="block"><p>Callback method invoked when the endpoint is ready to be read.</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../io/AbstractConnection.html#onFillable()">onFillable</a></code>&nbsp;in class&nbsp;<code><a href="../../../io/AbstractConnection.html" title="class in org.eclipse.jetty.io">AbstractConnection</a></code></dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../io/AbstractConnection.html#fillInterested()"><code>AbstractConnection.fillInterested()</code></a></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="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="../LogicalConnection.html#suspend()">LogicalConnection</a></code></span></div>
<div class="block">Suspend a the incoming read events on the connection.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../LogicalConnection.html#suspend()">suspend</a></code>&nbsp;in interface&nbsp;<code><a href="../LogicalConnection.html" title="interface in org.eclipse.jetty.websocket.common">LogicalConnection</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the suspend token</dd>
</dl>
</li>
</ul>
<a id="onFillInterestedFailed(java.lang.Throwable)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>onFillInterestedFailed</h4>
<pre class="methodSignature">protected&nbsp;void&nbsp;onFillInterestedFailed&#8203;(java.lang.Throwable&nbsp;cause)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../io/AbstractConnection.html#onFillInterestedFailed(java.lang.Throwable)">AbstractConnection</a></code></span></div>
<div class="block"><p>Callback method invoked when the endpoint failed to be ready to be read.</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../io/AbstractConnection.html#onFillInterestedFailed(java.lang.Throwable)">onFillInterestedFailed</a></code>&nbsp;in class&nbsp;<code><a href="../../../io/AbstractConnection.html" title="class in org.eclipse.jetty.io">AbstractConnection</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>cause</code> - the exception that caused the failure</dd>
</dl>
</li>
</ul>
<a id="setInitialBuffer(java.nio.ByteBuffer)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setInitialBuffer</h4>
<pre class="methodSignature">protected&nbsp;void&nbsp;setInitialBuffer&#8203;(java.nio.ByteBuffer&nbsp;prefilled)</pre>
<div class="block">Extra bytes from the initial HTTP upgrade that need to
be processed by the websocket parser before starting
to read bytes from the connection</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>prefilled</code> - the bytes of prefilled content encountered during upgrade</dd>
</dl>
</li>
</ul>
<a id="onReadTimeout(java.lang.Throwable)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>onReadTimeout</h4>
<pre class="methodSignature">protected&nbsp;boolean&nbsp;onReadTimeout&#8203;(java.lang.Throwable&nbsp;timeout)</pre>
<div class="block">Event for no activity on connection (read or write)</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../io/AbstractConnection.html#onReadTimeout(java.lang.Throwable)">onReadTimeout</a></code>&nbsp;in class&nbsp;<code><a href="../../../io/AbstractConnection.html" title="class in org.eclipse.jetty.io">AbstractConnection</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>timeout</code> - the cause of the read timeout</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true to signal that the endpoint must be closed, false to keep the endpoint open</dd>
</dl>
</li>
</ul>
<a id="outgoingFrame(org.eclipse.jetty.websocket.api.extensions.Frame,org.eclipse.jetty.websocket.api.WriteCallback,org.eclipse.jetty.websocket.api.BatchMode)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>outgoingFrame</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;outgoingFrame&#8203;(<a href="../../api/extensions/Frame.html" title="interface in org.eclipse.jetty.websocket.api.extensions">Frame</a>&nbsp;frame,
<a href="../../api/WriteCallback.html" title="interface in org.eclipse.jetty.websocket.api">WriteCallback</a>&nbsp;callback,
<a href="../../api/BatchMode.html" title="enum in org.eclipse.jetty.websocket.api">BatchMode</a>&nbsp;batchMode)</pre>
<div class="block">Frame from API, User, or Internal implementation destined for network.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../api/extensions/OutgoingFrames.html#outgoingFrame(org.eclipse.jetty.websocket.api.extensions.Frame,org.eclipse.jetty.websocket.api.WriteCallback,org.eclipse.jetty.websocket.api.BatchMode)">outgoingFrame</a></code>&nbsp;in interface&nbsp;<code><a href="../../api/extensions/OutgoingFrames.html" title="interface in org.eclipse.jetty.websocket.api.extensions">OutgoingFrames</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>frame</code> - the frame to eventually write to the network layer.</dd>
<dd><code>callback</code> - the callback to notify when the frame is written.</dd>
<dd><code>batchMode</code> - the batch mode requested by the sender.</dd>
</dl>
</li>
</ul>
<a id="setExtensions(java.util.List)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setExtensions</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setExtensions&#8203;(java.util.List&lt;<a href="../../api/extensions/ExtensionConfig.html" title="class in org.eclipse.jetty.websocket.api.extensions">ExtensionConfig</a>&gt;&nbsp;extensions)</pre>
<div class="block">Get the list of extensions in use.
<p>
This list is negotiated during the WebSocket Upgrade Request/Response handshake.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>extensions</code> - the list of negotiated extensions in use.</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">Overrides:</span></dt>
<dd><code><a href="../../../io/AbstractConnection.html#setInputBufferSize(int)">setInputBufferSize</a></code>&nbsp;in class&nbsp;<code><a href="../../../io/AbstractConnection.html" title="class in org.eclipse.jetty.io">AbstractConnection</a></code></dd>
</dl>
</li>
</ul>
<a id="setMaxIdleTimeout(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMaxIdleTimeout</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setMaxIdleTimeout&#8203;(long&nbsp;ms)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../LogicalConnection.html#setMaxIdleTimeout(long)">LogicalConnection</a></code></span></div>
<div class="block">Set the maximum number of milliseconds of idleness before the connection is closed/disconnected, (ie no frames are either sent or received)
<p>
This idle timeout cannot be garunteed to take immediate effect for any active read/write actions.
New read/write actions will have this new idle timeout.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../LogicalConnection.html#setMaxIdleTimeout(long)">setMaxIdleTimeout</a></code>&nbsp;in interface&nbsp;<code><a href="../LogicalConnection.html" title="interface in org.eclipse.jetty.websocket.common">LogicalConnection</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>ms</code> - the number of milliseconds of idle timeout</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="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="toConnectionString()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toConnectionString</h4>
<pre class="methodSignature">public&nbsp;java.lang.String&nbsp;toConnectionString()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../io/AbstractConnection.html#toConnectionString()">toConnectionString</a></code>&nbsp;in class&nbsp;<code><a href="../../../io/AbstractConnection.html" title="class in org.eclipse.jetty.io">AbstractConnection</a></code></dd>
</dl>
</li>
</ul>
<a id="onUpgradeTo(java.nio.ByteBuffer)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>onUpgradeTo</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;onUpgradeTo&#8203;(java.nio.ByteBuffer&nbsp;prefilled)</pre>
<div class="block">Extra bytes from the initial HTTP upgrade that need to
be processed by the websocket parser before starting
to read bytes from the connection</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../io/Connection.UpgradeTo.html#onUpgradeTo(java.nio.ByteBuffer)">onUpgradeTo</a></code>&nbsp;in interface&nbsp;<code><a href="../../../io/Connection.UpgradeTo.html" title="interface in org.eclipse.jetty.io">Connection.UpgradeTo</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>prefilled</code> - An optional buffer that can contain prefilled data. Typically this
results from an upgrade of one protocol to the other where the old connection has buffered
data destined for the new connection. The new connection must take ownership of the buffer
and is responsible for returning it to the buffer pool</dd>
</dl>
</li>
</ul>
<a id="setNextIncomingFrames(org.eclipse.jetty.websocket.api.extensions.IncomingFrames)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setNextIncomingFrames</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setNextIncomingFrames&#8203;(<a href="../../api/extensions/IncomingFrames.html" title="interface in org.eclipse.jetty.websocket.api.extensions">IncomingFrames</a>&nbsp;incoming)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../LogicalConnection.html#setNextIncomingFrames(org.eclipse.jetty.websocket.api.extensions.IncomingFrames)">LogicalConnection</a></code></span></div>
<div class="block">Set where the connection should send the incoming frames to.
<p>
Often this is from the Parser to the start of the extension stack, and eventually on to the session.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../LogicalConnection.html#setNextIncomingFrames(org.eclipse.jetty.websocket.api.extensions.IncomingFrames)">setNextIncomingFrames</a></code>&nbsp;in interface&nbsp;<code><a href="../LogicalConnection.html" title="interface in org.eclipse.jetty.websocket.common">LogicalConnection</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>incoming</code> - the incoming frames handler</dd>
</dl>
</li>
</ul>
<a id="getMessagesIn()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMessagesIn</h4>
<pre class="methodSignature">public&nbsp;long&nbsp;getMessagesIn()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../io/Connection.html#getMessagesIn()">getMessagesIn</a></code>&nbsp;in interface&nbsp;<code><a href="../../../io/Connection.html" title="interface in org.eclipse.jetty.io">Connection</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../io/AbstractConnection.html#getMessagesIn()">getMessagesIn</a></code>&nbsp;in class&nbsp;<code><a href="../../../io/AbstractConnection.html" title="class in org.eclipse.jetty.io">AbstractConnection</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of WebSocket frames received over this connection</dd>
</dl>
</li>
</ul>
<a id="getMessagesOut()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMessagesOut</h4>
<pre class="methodSignature">public&nbsp;long&nbsp;getMessagesOut()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../io/Connection.html#getMessagesOut()">getMessagesOut</a></code>&nbsp;in interface&nbsp;<code><a href="../../../io/Connection.html" title="interface in org.eclipse.jetty.io">Connection</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../io/AbstractConnection.html#getMessagesOut()">getMessagesOut</a></code>&nbsp;in class&nbsp;<code><a href="../../../io/AbstractConnection.html" title="class in org.eclipse.jetty.io">AbstractConnection</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of WebSocket frames sent over this connection</dd>
</dl>
</li>
</ul>
<a id="getBytesIn()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBytesIn</h4>
<pre class="methodSignature">public&nbsp;long&nbsp;getBytesIn()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../io/Connection.html#getBytesIn()">getBytesIn</a></code>&nbsp;in interface&nbsp;<code><a href="../../../io/Connection.html" title="interface in org.eclipse.jetty.io">Connection</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../io/AbstractConnection.html#getBytesIn()">getBytesIn</a></code>&nbsp;in class&nbsp;<code><a href="../../../io/AbstractConnection.html" title="class in org.eclipse.jetty.io">AbstractConnection</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of bytes received over this connection</dd>
</dl>
</li>
</ul>
<a id="getBytesOut()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getBytesOut</h4>
<pre class="methodSignature">public&nbsp;long&nbsp;getBytesOut()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../io/Connection.html#getBytesOut()">getBytesOut</a></code>&nbsp;in interface&nbsp;<code><a href="../../../io/Connection.html" title="interface in org.eclipse.jetty.io">Connection</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../io/AbstractConnection.html#getBytesOut()">getBytesOut</a></code>&nbsp;in class&nbsp;<code><a href="../../../io/AbstractConnection.html" title="class in org.eclipse.jetty.io">AbstractConnection</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of bytes frames sent over this connection</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/AbstractWebSocketConnection.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>