Google Git
Sign in
eclipse / www.eclipse.org / jetty / 244b31480d88c4c2e783a862c86c320807c66eb3 / . / javadoc / 9.2.22.v20170606 / org / eclipse / jetty / websocket / api / Session.html
blob: 6e0be329d43ec97bc3946ea379a7df8aa63b23a5 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_80) on Wed Jun 07 15:10:53 EDT 2017 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Session (Jetty :: Project 9.2.22.v20170606 API)</title>
<meta name="date" content="2017-06-07">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Session (Jetty :: Project 9.2.22.v20170606 API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Session.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 class="aboutLanguage"><em><script type="text/javascript"> var _gaq = _gaq || []; _gaq.push(['_setAccount', 'UA-1149868-7']); _gaq.push(['_trackPageview']); (function() { var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true; ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js'; var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s); })(); </script></em></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/eclipse/jetty/websocket/api/RemoteEndpoint.html" title="interface in org.eclipse.jetty.websocket.api"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/eclipse/jetty/websocket/api/StatusCode.html" title="class in org.eclipse.jetty.websocket.api"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/eclipse/jetty/websocket/api/Session.html" target="_top">Frames</a></li>
<li><a href="Session.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&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 name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.eclipse.jetty.websocket.api</div>
<h2 title="Interface Session" class="title">Interface Session</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/io/Closeable.html?is-external=true" title="class or interface in java.io">Closeable</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../org/eclipse/jetty/websocket/jsr356/JsrSession.html" title="class in org.eclipse.jetty.websocket.jsr356">JsrSession</a>, <a href="../../../../../org/eclipse/jetty/websocket/common/WebSocketSession.html" title="class in org.eclipse.jetty.websocket.common">WebSocketSession</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">Session</span>
extends <a href="http://docs.oracle.com/javase/7/docs/api/java/io/Closeable.html?is-external=true" title="class or interface in java.io">Closeable</a></pre>
<div class="block">Session represents an active link of communications with a Remote WebSocket Endpoint.
<p></div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/jetty/websocket/api/Session.html#close()">close</a></strong>()</code>
<div class="block">Request a close of the current conversation with a normal status code and no reason phrase.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/jetty/websocket/api/Session.html#close(org.eclipse.jetty.websocket.api.CloseStatus)">close</a></strong>(<a href="../../../../../org/eclipse/jetty/websocket/api/CloseStatus.html" title="class in org.eclipse.jetty.websocket.api">CloseStatus</a>&nbsp;closeStatus)</code>
<div class="block">Request Close the current conversation, giving a reason for the closure.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/jetty/websocket/api/Session.html#close(int,%20java.lang.String)">close</a></strong>(int&nbsp;statusCode,
<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;reason)</code>
<div class="block">Send a websocket Close frame, with status code.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/jetty/websocket/api/Session.html#disconnect()">disconnect</a></strong>()</code>
<div class="block">Issue a harsh disconnect of the underlying connection.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/jetty/websocket/api/Session.html#getIdleTimeout()">getIdleTimeout</a></strong>()</code>
<div class="block">Return the number of milliseconds before this conversation will be closed by the container if it is inactive, ie no messages are either sent or received
in that time.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/net/InetSocketAddress.html?is-external=true" title="class or interface in java.net">InetSocketAddress</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/jetty/websocket/api/Session.html#getLocalAddress()">getLocalAddress</a></strong>()</code>
<div class="block">Get the address of the local side.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/eclipse/jetty/websocket/api/WebSocketPolicy.html" title="class in org.eclipse.jetty.websocket.api">WebSocketPolicy</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/jetty/websocket/api/Session.html#getPolicy()">getPolicy</a></strong>()</code>
<div class="block">Access the (now read-only) <a href="../../../../../org/eclipse/jetty/websocket/api/WebSocketPolicy.html" title="class in org.eclipse.jetty.websocket.api"><code>WebSocketPolicy</code></a> in use for this connection.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/jetty/websocket/api/Session.html#getProtocolVersion()">getProtocolVersion</a></strong>()</code>
<div class="block">Returns the version of the websocket protocol currently being used.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/eclipse/jetty/websocket/api/RemoteEndpoint.html" title="interface in org.eclipse.jetty.websocket.api">RemoteEndpoint</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/jetty/websocket/api/Session.html#getRemote()">getRemote</a></strong>()</code>
<div class="block">Return a reference to the RemoteEndpoint object representing the other end of this conversation.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/net/InetSocketAddress.html?is-external=true" title="class or interface in java.net">InetSocketAddress</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/jetty/websocket/api/Session.html#getRemoteAddress()">getRemoteAddress</a></strong>()</code>
<div class="block">Get the address of the remote side.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/eclipse/jetty/websocket/api/UpgradeRequest.html" title="class in org.eclipse.jetty.websocket.api">UpgradeRequest</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/jetty/websocket/api/Session.html#getUpgradeRequest()">getUpgradeRequest</a></strong>()</code>
<div class="block">Get the UpgradeRequest used to create this session</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/eclipse/jetty/websocket/api/UpgradeResponse.html" title="class in org.eclipse.jetty.websocket.api">UpgradeResponse</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/jetty/websocket/api/Session.html#getUpgradeResponse()">getUpgradeResponse</a></strong>()</code>
<div class="block">Get the UpgradeResponse used to create this session</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/jetty/websocket/api/Session.html#isOpen()">isOpen</a></strong>()</code>
<div class="block">Return true if and only if the underlying socket is open.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/jetty/websocket/api/Session.html#isSecure()">isSecure</a></strong>()</code>
<div class="block">Return true if and only if the underlying socket is using a secure transport.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/jetty/websocket/api/Session.html#setIdleTimeout(long)">setIdleTimeout</a></strong>(long&nbsp;ms)</code>
<div class="block">Set the number of milliseconds before this conversation will be closed by the container if it is inactive, ie no messages are either sent or received.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/eclipse/jetty/websocket/api/SuspendToken.html" title="interface in org.eclipse.jetty.websocket.api">SuspendToken</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/jetty/websocket/api/Session.html#suspend()">suspend</a></strong>()</code>
<div class="block">Suspend a the incoming read events on the connection.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="close()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>close</h4>
<pre>void&nbsp;close()</pre>
<div class="block">Request a close of the current conversation with a normal status code and no reason phrase.
<p>
This will enqueue a graceful close to the remote endpoint.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/AutoCloseable.html?is-external=true#close()" title="class or interface in java.lang">close</a></code>&nbsp;in interface&nbsp;<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a></code></dd>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Closeable.html?is-external=true#close()" title="class or interface in java.io">close</a></code>&nbsp;in interface&nbsp;<code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Closeable.html?is-external=true" title="class or interface in java.io">Closeable</a></code></dd>
<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/eclipse/jetty/websocket/api/Session.html#close(org.eclipse.jetty.websocket.api.CloseStatus)"><code>close(CloseStatus)</code></a>,
<a href="../../../../../org/eclipse/jetty/websocket/api/Session.html#close(int,%20java.lang.String)"><code>close(int, String)</code></a>,
<a href="../../../../../org/eclipse/jetty/websocket/api/Session.html#disconnect()"><code>disconnect()</code></a></dd></dl>
</li>
</ul>
<a name="close(org.eclipse.jetty.websocket.api.CloseStatus)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>close</h4>
<pre>void&nbsp;close(<a href="../../../../../org/eclipse/jetty/websocket/api/CloseStatus.html" title="class in org.eclipse.jetty.websocket.api">CloseStatus</a>&nbsp;closeStatus)</pre>
<div class="block">Request Close the current conversation, giving a reason for the closure. Note the websocket spec defines the acceptable uses of status codes and reason
phrases.
<p>
This will enqueue a graceful close to the remote endpoint.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>closeStatus</code> - the reason for the closure</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/eclipse/jetty/websocket/api/Session.html#close()"><code>close()</code></a>,
<a href="../../../../../org/eclipse/jetty/websocket/api/Session.html#close(int,%20java.lang.String)"><code>close(int, String)</code></a>,
<a href="../../../../../org/eclipse/jetty/websocket/api/Session.html#disconnect()"><code>disconnect()</code></a></dd></dl>
</li>
</ul>
<a name="close(int, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>close</h4>
<pre>void&nbsp;close(int&nbsp;statusCode,
<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;reason)</pre>
<div class="block">Send a websocket Close frame, with status code.
<p>
This will enqueue a graceful close to the remote endpoint.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>statusCode</code> - the status code</dd><dd><code>reason</code> - the (optional) reason. (can be null for no reason)</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/eclipse/jetty/websocket/api/StatusCode.html" title="class in org.eclipse.jetty.websocket.api"><code>StatusCode</code></a>,
<a href="../../../../../org/eclipse/jetty/websocket/api/Session.html#close()"><code>close()</code></a>,
<a href="../../../../../org/eclipse/jetty/websocket/api/Session.html#close(org.eclipse.jetty.websocket.api.CloseStatus)"><code>close(CloseStatus)</code></a>,
<a href="../../../../../org/eclipse/jetty/websocket/api/Session.html#disconnect()"><code>disconnect()</code></a></dd></dl>
</li>
</ul>
<a name="disconnect()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>disconnect</h4>
<pre>void&nbsp;disconnect()
throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Issue a harsh disconnect of the underlying connection.
<p>
This will terminate the connection, without sending a websocket close frame.
<p>
Once called, any read/write activity on the websocket from this point will be indeterminate.
<p>
Once the underlying connection has been determined to be closed, the various onClose() events (either
<a href="../../../../../org/eclipse/jetty/websocket/api/WebSocketListener.html#onWebSocketClose(int,%20java.lang.String)"><code>WebSocketListener.onWebSocketClose(int, String)</code></a> or <code>OnWebSocketClose</code>) will be called on your websocket.</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/eclipse/jetty/websocket/api/Session.html#close()"><code>close()</code></a>,
<a href="../../../../../org/eclipse/jetty/websocket/api/Session.html#close(org.eclipse.jetty.websocket.api.CloseStatus)"><code>close(CloseStatus)</code></a>,
<a href="../../../../../org/eclipse/jetty/websocket/api/Session.html#close(int,%20java.lang.String)"><code>close(int, String)</code></a>,
<a href="../../../../../org/eclipse/jetty/websocket/api/Session.html#disconnect()"><code>disconnect()</code></a></dd></dl>
</li>
</ul>
<a name="getIdleTimeout()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getIdleTimeout</h4>
<pre>long&nbsp;getIdleTimeout()</pre>
<div class="block">Return the number of milliseconds before this conversation will be closed by the container if it is inactive, ie no messages are either sent or received
in that time.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the timeout in milliseconds.</dd></dl>
</li>
</ul>
<a name="getLocalAddress()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLocalAddress</h4>
<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/net/InetSocketAddress.html?is-external=true" title="class or interface in java.net">InetSocketAddress</a>&nbsp;getLocalAddress()</pre>
<div class="block">Get the address of the local side.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the local side address</dd></dl>
</li>
</ul>
<a name="getPolicy()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPolicy</h4>
<pre><a href="../../../../../org/eclipse/jetty/websocket/api/WebSocketPolicy.html" title="class in org.eclipse.jetty.websocket.api">WebSocketPolicy</a>&nbsp;getPolicy()</pre>
<div class="block">Access the (now read-only) <a href="../../../../../org/eclipse/jetty/websocket/api/WebSocketPolicy.html" title="class in org.eclipse.jetty.websocket.api"><code>WebSocketPolicy</code></a> in use for this connection.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the policy in use</dd></dl>
</li>
</ul>
<a name="getProtocolVersion()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getProtocolVersion</h4>
<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getProtocolVersion()</pre>
<div class="block">Returns the version of the websocket protocol currently being used. This is taken as the value of the Sec-WebSocket-Version header used in the opening
handshake. i.e. "13".</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the protocol version</dd></dl>
</li>
</ul>
<a name="getRemote()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRemote</h4>
<pre><a href="../../../../../org/eclipse/jetty/websocket/api/RemoteEndpoint.html" title="interface in org.eclipse.jetty.websocket.api">RemoteEndpoint</a>&nbsp;getRemote()</pre>
<div class="block">Return a reference to the RemoteEndpoint object representing the other end of this conversation.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the remote endpoint</dd></dl>
</li>
</ul>
<a name="getRemoteAddress()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRemoteAddress</h4>
<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/net/InetSocketAddress.html?is-external=true" title="class or interface in java.net">InetSocketAddress</a>&nbsp;getRemoteAddress()</pre>
<div class="block">Get the address of the remote side.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the remote side address</dd></dl>
</li>
</ul>
<a name="getUpgradeRequest()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUpgradeRequest</h4>
<pre><a href="../../../../../org/eclipse/jetty/websocket/api/UpgradeRequest.html" title="class in org.eclipse.jetty.websocket.api">UpgradeRequest</a>&nbsp;getUpgradeRequest()</pre>
<div class="block">Get the UpgradeRequest used to create this session</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the UpgradeRequest used to create this session</dd></dl>
</li>
</ul>
<a name="getUpgradeResponse()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUpgradeResponse</h4>
<pre><a href="../../../../../org/eclipse/jetty/websocket/api/UpgradeResponse.html" title="class in org.eclipse.jetty.websocket.api">UpgradeResponse</a>&nbsp;getUpgradeResponse()</pre>
<div class="block">Get the UpgradeResponse used to create this session</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the UpgradeResponse used to create this session</dd></dl>
</li>
</ul>
<a name="isOpen()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isOpen</h4>
<pre>boolean&nbsp;isOpen()</pre>
<div class="block">Return true if and only if the underlying socket is open.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>whether the session is open</dd></dl>
</li>
</ul>
<a name="isSecure()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isSecure</h4>
<pre>boolean&nbsp;isSecure()</pre>
<div class="block">Return true if and only if the underlying socket is using a secure transport.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>whether its using a secure transport</dd></dl>
</li>
</ul>
<a name="setIdleTimeout(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setIdleTimeout</h4>
<pre>void&nbsp;setIdleTimeout(long&nbsp;ms)</pre>
<div class="block">Set the number of milliseconds before this conversation will be closed by the container if it is inactive, ie no messages are either sent or received.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>ms</code> - the number of milliseconds.</dd></dl>
</li>
</ul>
<a name="suspend()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>suspend</h4>
<pre><a href="../../../../../org/eclipse/jetty/websocket/api/SuspendToken.html" title="interface in org.eclipse.jetty.websocket.api">SuspendToken</a>&nbsp;suspend()</pre>
<div class="block">Suspend a the incoming read events on the connection.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the suspend token suitable for resuming the reading of data on the connection.</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Session.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 class="aboutLanguage"><em><script type="text/javascript"> var _gaq = _gaq || []; _gaq.push(['_setAccount', 'UA-1149868-7']); _gaq.push(['_trackPageview']); (function() { var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true; ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js'; var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s); })(); </script></em></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/eclipse/jetty/websocket/api/RemoteEndpoint.html" title="interface in org.eclipse.jetty.websocket.api"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/eclipse/jetty/websocket/api/StatusCode.html" title="class in org.eclipse.jetty.websocket.api"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/eclipse/jetty/websocket/api/Session.html" target="_top">Frames</a></li>
<li><a href="Session.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&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 name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 1995-2017 <a href="http://webtide.com">Webtide</a>. All Rights Reserved.</small></p>
</body>
</html>