javadoc/current/org/eclipse/jetty/websocket/common/LogicalConnection.html - www.eclipse.org/jetty - Git at Google

 <!DOCTYPE HTML>
 <!-- NewPage -->
 <html lang="en">
 <head>
 <!-- Generated by javadoc (11.0.7) on Fri Jun 12 14:11:40 EDT 2020 -->
 <title>LogicalConnection (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="LogicalConnection (Jetty :: Project 9.4.30.v20200611 API)";
         }
     }
     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,"i20":6,"i21":6,"i22":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 = 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/LogicalConnection.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>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 id="skip.navbar.top">
 <!--   -->
 </a></div>
 <!-- ========= END OF TOP NAVBAR ========= -->
 </div>
 <div class="navPadding">&nbsp;</div>
 <script type="text/javascript"><!--
 $('.navPadding').css('padding-top', $('.fixedNav').css("height"));
 //-->
 </script>
 </nav>
 </header>
 <!-- ======== START OF CLASS DATA ======== -->
 <main role="main">
 <div class="header">
 <div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.eclipse.jetty.websocket.common</a></div>
 <h2 title="Interface LogicalConnection" class="title">Interface LogicalConnection</h2>
 </div>
 <div class="contentContainer">
 <div class="description">
 <ul class="blockList">
 <li class="blockList">
 <dl>
 <dt>All Superinterfaces:</dt>
 <dd><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></dd>
 </dl>
 <dl>
 <dt>All Known Implementing Classes:</dt>
 <dd><code><a href="io/AbstractWebSocketConnection.html" title="class in org.eclipse.jetty.websocket.common.io">AbstractWebSocketConnection</a></code>, <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 interface <span class="typeNameLabel">LogicalConnection</span>
 extends <a href="../api/extensions/OutgoingFrames.html" title="interface in org.eclipse.jetty.websocket.api.extensions">OutgoingFrames</a>, <a href="../api/SuspendToken.html" title="interface in org.eclipse.jetty.websocket.api">SuspendToken</a></pre>
 </li>
 </ul>
 </div>
 <div class="summary">
 <ul class="blockList">
 <li class="blockList">
 <!-- ========== 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>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(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 cause.</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(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;closeInfo,
      <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="i4" class="altColor">
 <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="i5" 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="i6" 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="i7" 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="i8" 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="i9" 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="i10" 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="i11" class="rowColor">
 <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="i12" class="altColor">
 <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="i13" class="rowColor">
 <td class="colFirst"><code>boolean</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isOpen()">isOpen</a></span>()</code></th>
 <td class="colLast">
 <div class="block">Test if logical connection is still open</div>
 </td>
 </tr>
 <tr id="i14" class="altColor">
 <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="i15" 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="i16" 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="i17" class="rowColor">
 <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="i18" class="altColor">
 <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="i19" class="rowColor">
 <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="i20" class="altColor">
 <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="i21" class="rowColor">
 <td class="colFirst"><code><a href="../api/SuspendToken.html" title="interface in org.eclipse.jetty.websocket.api">SuspendToken</a></code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#suspend()">suspend</a></span>()</code></th>
 <td class="colLast">
 <div class="block">Suspend a the incoming read events on the connection.</div>
 </td>
 </tr>
 <tr id="i22" 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.websocket.api.extensions.OutgoingFrames">
 <!--   -->
 </a>
 <h3>Methods inherited from interface&nbsp;org.eclipse.jetty.websocket.api.extensions.<a href="../api/extensions/OutgoingFrames.html" title="interface in org.eclipse.jetty.websocket.api.extensions">OutgoingFrames</a></h3>
 <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></li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a id="methods.inherited.from.class.org.eclipse.jetty.websocket.api.SuspendToken">
 <!--   -->
 </a>
 <h3>Methods inherited from interface&nbsp;org.eclipse.jetty.websocket.api.<a href="../api/SuspendToken.html" title="interface in org.eclipse.jetty.websocket.api">SuspendToken</a></h3>
 <code><a href="../api/SuspendToken.html#resume()">resume</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="canReadWebSocketFrames()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>canReadWebSocketFrames</h4>
 <pre class="methodSignature">boolean&nbsp;canReadWebSocketFrames()</pre>
 <div class="block">Test if Connection State allows for reading of frames.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>true if able to read, false otherwise.</dd>
 </dl>
 </li>
 </ul>
 <a id="canWriteWebSocketFrames()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>canWriteWebSocketFrames</h4>
 <pre class="methodSignature">boolean&nbsp;canWriteWebSocketFrames()</pre>
 <div class="block">Test if Connection State allows for writing frames.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>true if able to write, false otherwise.</dd>
 </dl>
 </li>
 </ul>
 <a id="close(java.lang.Throwable)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>close</h4>
 <pre class="methodSignature">void&nbsp;close&#8203;(java.lang.Throwable&nbsp;cause)</pre>
 <div class="block">Close the connection based on the cause.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>cause</code> - the cause</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">void&nbsp;close&#8203;(<a href="CloseInfo.html" title="class in org.eclipse.jetty.websocket.common">CloseInfo</a>&nbsp;closeInfo,
            <a href="../../util/Callback.html" title="interface in org.eclipse.jetty.util">Callback</a>&nbsp;callback)</pre>
 <div class="block">Request a local close.</div>
 </li>
 </ul>
 <a id="disconnect()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>disconnect</h4>
 <pre class="methodSignature">void&nbsp;disconnect()</pre>
 <div class="block">Terminate the connection (no close frame sent)</div>
 </li>
 </ul>
 <a id="getBufferPool()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getBufferPool</h4>
 <pre class="methodSignature"><a href="../../io/ByteBufferPool.html" title="interface in org.eclipse.jetty.io">ByteBufferPool</a>&nbsp;getBufferPool()</pre>
 <div class="block">Get the ByteBufferPool in use by the connection</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the buffer pool</dd>
 </dl>
 </li>
 </ul>
 <a id="getExecutor()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getExecutor</h4>
 <pre class="methodSignature">java.util.concurrent.Executor&nbsp;getExecutor()</pre>
 <div class="block">Get the Executor used by this connection.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the executor</dd>
 </dl>
 </li>
 </ul>
 <a id="getId()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getId</h4>
 <pre class="methodSignature">java.lang.String&nbsp;getId()</pre>
 <div class="block">Get Unique ID for the Connection</div>
 <dl>
 <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">long&nbsp;getIdleTimeout()</pre>
 <div class="block">Get the read/write idle timeout.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the idle timeout in milliseconds</dd>
 </dl>
 </li>
 </ul>
 <a id="getLocalAddress()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getLocalAddress</h4>
 <pre class="methodSignature">java.net.InetSocketAddress&nbsp;getLocalAddress()</pre>
 <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="returnLabel">Returns:</span></dt>
 <dd>the local address.</dd>
 </dl>
 </li>
 </ul>
 <a id="getMaxIdleTimeout()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getMaxIdleTimeout</h4>
 <pre class="methodSignature">long&nbsp;getMaxIdleTimeout()</pre>
 <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="returnLabel">Returns:</span></dt>
 <dd>the idle timeout in milliseconds</dd>
 </dl>
 </li>
 </ul>
 <a id="setMaxIdleTimeout(long)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>setMaxIdleTimeout</h4>
 <pre class="methodSignature">void&nbsp;setMaxIdleTimeout&#8203;(long&nbsp;ms)</pre>
 <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="paramLabel">Parameters:</span></dt>
 <dd><code>ms</code> - the number of milliseconds of idle timeout</dd>
 </dl>
 </li>
 </ul>
 <a id="getPolicy()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getPolicy</h4>
 <pre class="methodSignature"><a href="../api/WebSocketPolicy.html" title="class in org.eclipse.jetty.websocket.api">WebSocketPolicy</a>&nbsp;getPolicy()</pre>
 <div class="block">The policy that the connection is running under.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the policy for the connection</dd>
 </dl>
 </li>
 </ul>
 <a id="getRemoteAddress()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getRemoteAddress</h4>
 <pre class="methodSignature">java.net.InetSocketAddress&nbsp;getRemoteAddress()</pre>
 <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="returnLabel">Returns:</span></dt>
 <dd>the remote address.</dd>
 </dl>
 </li>
 </ul>
 <a id="isOpen()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>isOpen</h4>
 <pre class="methodSignature">boolean&nbsp;isOpen()</pre>
 <div class="block">Test if logical connection is still open</div>
 <dl>
 <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">boolean&nbsp;isReading()</pre>
 <div class="block">Tests if the connection is actively reading.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>true if connection is actively attempting to read.</dd>
 </dl>
 </li>
 </ul>
 <a id="opened()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>opened</h4>
 <pre class="methodSignature">boolean&nbsp;opened()</pre>
 <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="returnLabel">Returns:</span></dt>
 <dd>true if state is OPENED, false otherwise</dd>
 </dl>
 </li>
 </ul>
 <a id="opening()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>opening</h4>
 <pre class="methodSignature">boolean&nbsp;opening()</pre>
 <div class="block">Set the state to upgrade/opening handshake has completed.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>true if state is OPENING, 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">void&nbsp;remoteClose&#8203;(<a href="CloseInfo.html" title="class in org.eclipse.jetty.websocket.common">CloseInfo</a>&nbsp;close)</pre>
 <div class="block">Report that the Remote Endpoint CLOSE Frame has been received</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>close</code> - the close frame details</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">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">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="paramLabel">Parameters:</span></dt>
 <dd><code>incoming</code> - the incoming frames handler</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">void&nbsp;setSession&#8203;(<a href="WebSocketSession.html" title="class in org.eclipse.jetty.websocket.common">WebSocketSession</a>&nbsp;session)</pre>
 <div class="block">Associate the Active Session with the connection.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>session</code> - the session for this connection</dd>
 </dl>
 </li>
 </ul>
 <a id="suspend()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>suspend</h4>
 <pre class="methodSignature"><a href="../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="returnLabel">Returns:</span></dt>
 <dd>the suspend token</dd>
 </dl>
 </li>
 </ul>
 <a id="toStateString()">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>toStateString</h4>
 <pre class="methodSignature">java.lang.String&nbsp;toStateString()</pre>
 <div class="block">Get the Connection State as a String</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the Connection State string</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/LogicalConnection.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>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 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>