| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.11) on Mon Jun 14 16:37:38 EDT 2021 --> |
| <title>WebSocketAdapter (Jetty :: Project 9.4.42.v20210604 API)</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="WebSocketAdapter (Jetty :: Project 9.4.42.v20210604 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| var pathtoroot = "../../../../../"; |
| var useModuleDirectories = 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/WebSocketAdapter.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 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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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"> </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> <a href="package-summary.html">org.eclipse.jetty.websocket.api</a></div> |
| <h2 title="Class WebSocketAdapter" class="title">Class WebSocketAdapter</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.eclipse.jetty.websocket.api.WebSocketAdapter</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="WebSocketConnectionListener.html" title="interface in org.eclipse.jetty.websocket.api">WebSocketConnectionListener</a></code>, <code><a href="WebSocketListener.html" title="interface in org.eclipse.jetty.websocket.api">WebSocketListener</a></code></dd> |
| </dl> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><code><a href="../client/NoOpEndpoint.html" title="class in org.eclipse.jetty.websocket.client">NoOpEndpoint</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public class <span class="typeNameLabel">WebSocketAdapter</span> |
| extends java.lang.Object |
| implements <a href="WebSocketListener.html" title="interface in org.eclipse.jetty.websocket.api">WebSocketListener</a></pre> |
| <div class="block">Default implementation of the <a href="WebSocketListener.html" title="interface in org.eclipse.jetty.websocket.api"><code>WebSocketListener</code></a>. |
| <p> |
| Convenient abstract class to base standard WebSocket implementations off of.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== 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"> </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()">WebSocketAdapter</a></span>()</code></th> |
| <td class="colLast"> </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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </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><a href="RemoteEndpoint.html" title="interface in org.eclipse.jetty.websocket.api">RemoteEndpoint</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRemote()">getRemote</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="Session.html" title="interface in org.eclipse.jetty.websocket.api">Session</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSession()">getSession</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isConnected()">isConnected</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isNotConnected()">isNotConnected</a></span>()</code></th> |
| <td class="colLast"> </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="#onWebSocketBinary(byte%5B%5D,int,int)">onWebSocketBinary</a></span>​(byte[] payload, |
| int offset, |
| int len)</code></th> |
| <td class="colLast"> |
| <div class="block">A WebSocket binary frame has been received.</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="#onWebSocketClose(int,java.lang.String)">onWebSocketClose</a></span>​(int statusCode, |
| java.lang.String reason)</code></th> |
| <td class="colLast"> |
| <div class="block">A Close Event was received.</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="#onWebSocketConnect(org.eclipse.jetty.websocket.api.Session)">onWebSocketConnect</a></span>​(<a href="Session.html" title="interface in org.eclipse.jetty.websocket.api">Session</a> sess)</code></th> |
| <td class="colLast"> |
| <div class="block">A WebSocket <a href="Session.html" title="interface in org.eclipse.jetty.websocket.api"><code>Session</code></a> has connected successfully and is ready to be used.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onWebSocketError(java.lang.Throwable)">onWebSocketError</a></span>​(java.lang.Throwable cause)</code></th> |
| <td class="colLast"> |
| <div class="block">A WebSocket exception has occurred.</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="#onWebSocketText(java.lang.String)">onWebSocketText</a></span>​(java.lang.String message)</code></th> |
| <td class="colLast"> |
| <div class="block">A WebSocket Text frame was received.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.Object</h3> |
| <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</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="<init>()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>WebSocketAdapter</h4> |
| <pre>public WebSocketAdapter()</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="getRemote()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRemote</h4> |
| <pre class="methodSignature">public <a href="RemoteEndpoint.html" title="interface in org.eclipse.jetty.websocket.api">RemoteEndpoint</a> getRemote()</pre> |
| </li> |
| </ul> |
| <a id="getSession()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSession</h4> |
| <pre class="methodSignature">public <a href="Session.html" title="interface in org.eclipse.jetty.websocket.api">Session</a> getSession()</pre> |
| </li> |
| </ul> |
| <a id="isConnected()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isConnected</h4> |
| <pre class="methodSignature">public boolean isConnected()</pre> |
| </li> |
| </ul> |
| <a id="isNotConnected()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isNotConnected</h4> |
| <pre class="methodSignature">public boolean isNotConnected()</pre> |
| </li> |
| </ul> |
| <a id="onWebSocketBinary(byte[],int,int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>onWebSocketBinary</h4> |
| <pre class="methodSignature">public void onWebSocketBinary​(byte[] payload, |
| int offset, |
| int len)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="WebSocketListener.html#onWebSocketBinary(byte%5B%5D,int,int)">WebSocketListener</a></code></span></div> |
| <div class="block">A WebSocket binary frame has been received.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="WebSocketListener.html#onWebSocketBinary(byte%5B%5D,int,int)">onWebSocketBinary</a></code> in interface <code><a href="WebSocketListener.html" title="interface in org.eclipse.jetty.websocket.api">WebSocketListener</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>payload</code> - the raw payload array received</dd> |
| <dd><code>offset</code> - the offset in the payload array where the data starts</dd> |
| <dd><code>len</code> - the length of bytes in the payload</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="onWebSocketClose(int,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>onWebSocketClose</h4> |
| <pre class="methodSignature">public void onWebSocketClose​(int statusCode, |
| java.lang.String reason)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="WebSocketConnectionListener.html#onWebSocketClose(int,java.lang.String)">WebSocketConnectionListener</a></code></span></div> |
| <div class="block">A Close Event was received. |
| <p> |
| The underlying Connection will be considered closed at this point.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="WebSocketConnectionListener.html#onWebSocketClose(int,java.lang.String)">onWebSocketClose</a></code> in interface <code><a href="WebSocketConnectionListener.html" title="interface in org.eclipse.jetty.websocket.api">WebSocketConnectionListener</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>statusCode</code> - the close status code. (See <a href="StatusCode.html" title="class in org.eclipse.jetty.websocket.api"><code>StatusCode</code></a>)</dd> |
| <dd><code>reason</code> - the optional reason for the close.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="onWebSocketConnect(org.eclipse.jetty.websocket.api.Session)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>onWebSocketConnect</h4> |
| <pre class="methodSignature">public void onWebSocketConnect​(<a href="Session.html" title="interface in org.eclipse.jetty.websocket.api">Session</a> sess)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="WebSocketConnectionListener.html#onWebSocketConnect(org.eclipse.jetty.websocket.api.Session)">WebSocketConnectionListener</a></code></span></div> |
| <div class="block">A WebSocket <a href="Session.html" title="interface in org.eclipse.jetty.websocket.api"><code>Session</code></a> has connected successfully and is ready to be used. |
| <p> |
| Note: It is a good idea to track this session as a field in your object so that you can write messages back via the <a href="RemoteEndpoint.html" title="interface in org.eclipse.jetty.websocket.api"><code>RemoteEndpoint</code></a></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="WebSocketConnectionListener.html#onWebSocketConnect(org.eclipse.jetty.websocket.api.Session)">onWebSocketConnect</a></code> in interface <code><a href="WebSocketConnectionListener.html" title="interface in org.eclipse.jetty.websocket.api">WebSocketConnectionListener</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>sess</code> - the websocket session.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="onWebSocketError(java.lang.Throwable)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>onWebSocketError</h4> |
| <pre class="methodSignature">public void onWebSocketError​(java.lang.Throwable cause)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="WebSocketConnectionListener.html#onWebSocketError(java.lang.Throwable)">WebSocketConnectionListener</a></code></span></div> |
| <div class="block">A WebSocket exception has occurred. |
| <p> |
| This is a way for the internal implementation to notify of exceptions occurred during the processing of websocket. |
| <p> |
| Usually this occurs from bad / malformed incoming packets. (example: bad UTF8 data, frames that are too big, violations of the spec) |
| <p> |
| This will result in the <a href="Session.html" title="interface in org.eclipse.jetty.websocket.api"><code>Session</code></a> being closed by the implementing side.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="WebSocketConnectionListener.html#onWebSocketError(java.lang.Throwable)">onWebSocketError</a></code> in interface <code><a href="WebSocketConnectionListener.html" title="interface in org.eclipse.jetty.websocket.api">WebSocketConnectionListener</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>cause</code> - the error that occurred.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="onWebSocketText(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>onWebSocketText</h4> |
| <pre class="methodSignature">public void onWebSocketText​(java.lang.String message)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="WebSocketListener.html#onWebSocketText(java.lang.String)">WebSocketListener</a></code></span></div> |
| <div class="block">A WebSocket Text frame was received.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="WebSocketListener.html#onWebSocketText(java.lang.String)">onWebSocketText</a></code> in interface <code><a href="WebSocketListener.html" title="interface in org.eclipse.jetty.websocket.api">WebSocketListener</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>message</code> - the message</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/WebSocketAdapter.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 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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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 © 1995–2021 <a href="https://webtide.com">Webtide</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |
