Google Git
Sign in
eclipse / www.eclipse.org / jetty / a3b2b46b70ed9bbe40e975355658f1bbe73bbc32 / . / javadoc / jetty-10 / org / eclipse / jetty / websocket / core / CoreSession.html
blob: 016da0cf597a8143e2ada8804b1860511ed08afa [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.11) on Mon Jun 14 16:40:44 EDT 2021 -->
<title>CoreSession (Eclipse Jetty API Doc - v10.0.5)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2021-06-14">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../../jquery/jquery-3.5.1.js"></script>
<script type="text/javascript" src="../../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CoreSession (Eclipse Jetty API Doc - v10.0.5)";
}
}
catch(err) {
}
//-->
var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6,"i19":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/CoreSession.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>Field&nbsp;|&nbsp;</li>
<li>Constr&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>Constr&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</a></div>
<h2 title="Interface CoreSession" class="title">Interface CoreSession</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><code><a href="Configuration.html" title="interface in org.eclipse.jetty.websocket.core">Configuration</a></code>, <code><a href="OutgoingFrames.html" title="interface in org.eclipse.jetty.websocket.core">OutgoingFrames</a></code></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="CoreSession.Empty.html" title="class in org.eclipse.jetty.websocket.core">CoreSession.Empty</a></code>, <code><a href="internal/WebSocketCoreSession.html" title="class in org.eclipse.jetty.websocket.core.internal">WebSocketCoreSession</a></code></dd>
</dl>
<hr>
<pre>public interface <span class="typeNameLabel">CoreSession</span>
extends <a href="OutgoingFrames.html" title="interface in org.eclipse.jetty.websocket.core">OutgoingFrames</a>, <a href="Configuration.html" title="interface in org.eclipse.jetty.websocket.core">Configuration</a></pre>
<div class="block">Represents the outgoing Frames.</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">Interface</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="CoreSession.Empty.html" title="class in org.eclipse.jetty.websocket.core">CoreSession.Empty</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
<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>
</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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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="#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">Initiate close handshake with provide status code and optional reason phrase.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#close(org.eclipse.jetty.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">Initiate close handshake, no payload (no declared status code or reason phrase)</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#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="i4" 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="i5" 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="i6" 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="i7" 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="i8" 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="i9" 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="i10" class="altColor">
<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="i11" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getProtocolVersion()">getProtocolVersion</a></span>()</code></th>
<td class="colLast">
<div class="block">The active <code>Sec-WebSocket-Version</code> (protocol version) in use.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<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="i13" class="rowColor">
<td class="colFirst"><code>java.net.URI</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRequestURI()">getRequestURI</a></span>()</code></th>
<td class="colLast">
<div class="block">The active connection's Request URI.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<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">&nbsp;</td>
</tr>
<tr id="i15" 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="i16" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isRsv1Used()">isRsv1Used</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isRsv2Used()">isRsv2Used</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isRsv3Used()">isRsv3Used</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isSecure()">isSecure</a></span>()</code></th>
<td class="colLast">
<div class="block">The active connection's Secure status indicator.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.eclipse.jetty.websocket.core.Configuration">
<!-- -->
</a>
<h3>Methods 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.html#getIdleTimeout()">getIdleTimeout</a>, <a href="Configuration.html#getInputBufferSize()">getInputBufferSize</a>, <a href="Configuration.html#getMaxBinaryMessageSize()">getMaxBinaryMessageSize</a>, <a href="Configuration.html#getMaxFrameSize()">getMaxFrameSize</a>, <a href="Configuration.html#getMaxOutgoingFrames()">getMaxOutgoingFrames</a>, <a href="Configuration.html#getMaxTextMessageSize()">getMaxTextMessageSize</a>, <a href="Configuration.html#getOutputBufferSize()">getOutputBufferSize</a>, <a href="Configuration.html#getWriteTimeout()">getWriteTimeout</a>, <a href="Configuration.html#isAutoFragment()">isAutoFragment</a>, <a href="Configuration.html#setAutoFragment(boolean)">setAutoFragment</a>, <a href="Configuration.html#setIdleTimeout(java.time.Duration)">setIdleTimeout</a>, <a href="Configuration.html#setInputBufferSize(int)">setInputBufferSize</a>, <a href="Configuration.html#setMaxBinaryMessageSize(long)">setMaxBinaryMessageSize</a>, <a href="Configuration.html#setMaxFrameSize(long)">setMaxFrameSize</a>, <a href="Configuration.html#setMaxOutgoingFrames(int)">setMaxOutgoingFrames</a>, <a href="Configuration.html#setMaxTextMessageSize(long)">setMaxTextMessageSize</a>, <a href="Configuration.html#setOutputBufferSize(int)">setOutputBufferSize</a>, <a href="Configuration.html#setWriteTimeout(java.time.Duration)">setWriteTimeout</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.eclipse.jetty.websocket.core.OutgoingFrames">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.eclipse.jetty.websocket.core.<a href="OutgoingFrames.html" title="interface in org.eclipse.jetty.websocket.core">OutgoingFrames</a></h3>
<code><a href="OutgoingFrames.html#sendFrame(org.eclipse.jetty.websocket.core.Frame,org.eclipse.jetty.util.Callback,boolean)">sendFrame</a></code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="getNegotiatedSubProtocol()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNegotiatedSubProtocol</h4>
<pre class="methodSignature">java.lang.String&nbsp;getNegotiatedSubProtocol()</pre>
<div class="block">The negotiated WebSocket Sub-Protocol for this session.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the negotiated WebSocket Sub-Protocol for this session.</dd>
</dl>
</li>
</ul>
<a id="getNegotiatedExtensions()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNegotiatedExtensions</h4>
<pre class="methodSignature">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">The negotiated WebSocket Extension Configurations for this session.</div>
<dl>
<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">java.util.Map&lt;java.lang.String,&#8203;java.util.List&lt;java.lang.String&gt;&gt;&nbsp;getParameterMap()</pre>
<div class="block">The parameter map (from URI Query) for the active session.</div>
<dl>
<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">java.lang.String&nbsp;getProtocolVersion()</pre>
<div class="block">The active <code>Sec-WebSocket-Version</code> (protocol version) in use.</div>
<dl>
<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">java.net.URI&nbsp;getRequestURI()</pre>
<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="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">boolean&nbsp;isSecure()</pre>
<div class="block">The active connection's Secure status indicator.</div>
<dl>
<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"><a href="Behavior.html" title="enum in org.eclipse.jetty.websocket.core">Behavior</a>&nbsp;getBehavior()</pre>
<dl>
<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"><a href="WebSocketComponents.html" title="class in org.eclipse.jetty.websocket.core">WebSocketComponents</a>&nbsp;getWebSocketComponents()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the WebSocketComponents instance in use for this Connection.</dd>
</dl>
</li>
</ul>
<a id="getByteBufferPool()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getByteBufferPool</h4>
<pre class="methodSignature"><a href="../../io/ByteBufferPool.html" title="interface in org.eclipse.jetty.io">ByteBufferPool</a>&nbsp;getByteBufferPool()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The shared ByteBufferPool</dd>
</dl>
</li>
</ul>
<a id="getLocalAddress()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLocalAddress</h4>
<pre class="methodSignature">java.net.SocketAddress&nbsp;getLocalAddress()</pre>
<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="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">java.net.SocketAddress&nbsp;getRemoteAddress()</pre>
<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="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">boolean&nbsp;isOutputOpen()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>True if the websocket is open outbound</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">void&nbsp;flush&#8203;(<a href="../../util/Callback.html" title="interface in org.eclipse.jetty.util">Callback</a>&nbsp;callback)</pre>
<div class="block">If using BatchMode.ON or BatchMode.AUTO, trigger a flush of enqueued / batched frames.</div>
<dl>
<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="close(org.eclipse.jetty.util.Callback)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>close</h4>
<pre class="methodSignature">void&nbsp;close&#8203;(<a href="../../util/Callback.html" title="interface in org.eclipse.jetty.util">Callback</a>&nbsp;callback)</pre>
<div class="block">Initiate close handshake, no payload (no declared status code or reason phrase)</div>
<dl>
<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="close(int,java.lang.String,org.eclipse.jetty.util.Callback)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>close</h4>
<pre class="methodSignature">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">Initiate close handshake with provide status code and optional reason phrase.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>statusCode</code> - the status code (should be a valid status code that can be sent)</dd>
<dd><code>reason</code> - optional reason phrase (will be truncated automatically by implementation to fit within limits of protocol)</dd>
<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">void&nbsp;abort()</pre>
<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>
</li>
</ul>
<a id="demand(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>demand</h4>
<pre class="methodSignature">void&nbsp;demand&#8203;(long&nbsp;n)</pre>
<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="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="isRsv1Used()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isRsv1Used</h4>
<pre class="methodSignature">boolean&nbsp;isRsv1Used()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if an extension has been negotiated which uses the RSV1 bit.</dd>
</dl>
</li>
</ul>
<a id="isRsv2Used()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isRsv2Used</h4>
<pre class="methodSignature">boolean&nbsp;isRsv2Used()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if an extension has been negotiated which uses the RSV2 bit.</dd>
</dl>
</li>
</ul>
<a id="isRsv3Used()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>isRsv3Used</h4>
<pre class="methodSignature">boolean&nbsp;isRsv3Used()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if an extension has been negotiated which uses the RSV3 bit.</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/CoreSession.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>Field&nbsp;|&nbsp;</li>
<li>Constr&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>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 1995&#x2013;2021 <a href="https://webtide.com">Webtide</a>. All rights reserved.</small></p>
</footer>
</body>
</html>