| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.11) on Mon Jun 14 16:40:44 EDT 2021 --> |
| <title>JavaxWebSocketFrameHandler (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="JavaxWebSocketFrameHandler (Eclipse Jetty API Doc - v10.0.5)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10}; |
| 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 = 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/JavaxWebSocketFrameHandler.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><a href="#field.summary">Field</a> | </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><a href="#field.detail">Field</a> | </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.javax.common</a></div> |
| <h2 title="Class JavaxWebSocketFrameHandler" class="title">Class JavaxWebSocketFrameHandler</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.eclipse.jetty.websocket.javax.common.JavaxWebSocketFrameHandler</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="../../core/FrameHandler.html" title="interface in org.eclipse.jetty.websocket.core">FrameHandler</a></code>, <code><a href="../../core/IncomingFrames.html" title="interface in org.eclipse.jetty.websocket.core">IncomingFrames</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public class <span class="typeNameLabel">JavaxWebSocketFrameHandler</span> |
| extends java.lang.Object |
| implements <a href="../../core/FrameHandler.html" title="interface in org.eclipse.jetty.websocket.core">FrameHandler</a></pre> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Field</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected byte</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#dataType">dataType</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Constructor</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.eclipse.jetty.websocket.javax.common.JavaxWebSocketContainer,org.eclipse.jetty.websocket.javax.common.UpgradeRequest,java.lang.Object,java.lang.invoke.MethodHandle,java.lang.invoke.MethodHandle,java.lang.invoke.MethodHandle,org.eclipse.jetty.websocket.javax.common.JavaxWebSocketMessageMetadata,org.eclipse.jetty.websocket.javax.common.JavaxWebSocketMessageMetadata,java.lang.invoke.MethodHandle,javax.websocket.EndpointConfig)">JavaxWebSocketFrameHandler</a></span>​(<a href="JavaxWebSocketContainer.html" title="class in org.eclipse.jetty.websocket.javax.common">JavaxWebSocketContainer</a> container, |
| <a href="UpgradeRequest.html" title="interface in org.eclipse.jetty.websocket.javax.common">UpgradeRequest</a> upgradeRequest, |
| java.lang.Object endpointInstance, |
| java.lang.invoke.MethodHandle openHandle, |
| java.lang.invoke.MethodHandle closeHandle, |
| java.lang.invoke.MethodHandle errorHandle, |
| <a href="JavaxWebSocketMessageMetadata.html" title="class in org.eclipse.jetty.websocket.javax.common">JavaxWebSocketMessageMetadata</a> textMetadata, |
| <a href="JavaxWebSocketMessageMetadata.html" title="class in org.eclipse.jetty.websocket.javax.common">JavaxWebSocketMessageMetadata</a> binaryMetadata, |
| java.lang.invoke.MethodHandle pongHandle, |
| javax.websocket.EndpointConfig endpointConfig)</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><T> void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addMessageHandler(java.lang.Class,javax.websocket.MessageHandler.Partial)">addMessageHandler</a></span>​(java.lang.Class<T> clazz, |
| javax.websocket.MessageHandler.Partial<T> handler)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><T> void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addMessageHandler(java.lang.Class,javax.websocket.MessageHandler.Whole)">addMessageHandler</a></span>​(java.lang.Class<T> clazz, |
| javax.websocket.MessageHandler.Whole<T> handler)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="JavaxWebSocketMessageMetadata.html" title="class in org.eclipse.jetty.websocket.javax.common">JavaxWebSocketMessageMetadata</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getBinaryMetadata()">getBinaryMetadata</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>java.lang.Object</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getEndpoint()">getEndpoint</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>javax.websocket.EndpointConfig</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getEndpointConfig()">getEndpointConfig</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>java.util.Map<java.lang.Byte,​<a href="RegisteredMessageHandler.html" title="class in org.eclipse.jetty.websocket.javax.common">RegisteredMessageHandler</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMessageHandlerMap()">getMessageHandlerMap</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>java.util.Set<javax.websocket.MessageHandler></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMessageHandlers()">getMessageHandlers</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="JavaxWebSocketSession.html" title="class in org.eclipse.jetty.websocket.javax.common">JavaxWebSocketSession</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="i8" class="altColor"> |
| <td class="colFirst"><code><a href="JavaxWebSocketMessageMetadata.html" title="class in org.eclipse.jetty.websocket.javax.common">JavaxWebSocketMessageMetadata</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTextMetadata()">getTextMetadata</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="UpgradeRequest.html" title="interface in org.eclipse.jetty.websocket.javax.common">UpgradeRequest</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getUpgradeRequest()">getUpgradeRequest</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onBinary(org.eclipse.jetty.websocket.core.Frame,org.eclipse.jetty.util.Callback)">onBinary</a></span>​(<a href="../../core/Frame.html" title="class in org.eclipse.jetty.websocket.core">Frame</a> frame, |
| <a href="../../../util/Callback.html" title="interface in org.eclipse.jetty.util">Callback</a> callback)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onClose(org.eclipse.jetty.websocket.core.Frame,org.eclipse.jetty.util.Callback)">onClose</a></span>​(<a href="../../core/Frame.html" title="class in org.eclipse.jetty.websocket.core">Frame</a> frame, |
| <a href="../../../util/Callback.html" title="interface in org.eclipse.jetty.util">Callback</a> callback)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onClosed(org.eclipse.jetty.websocket.core.CloseStatus,org.eclipse.jetty.util.Callback)">onClosed</a></span>​(<a href="../../core/CloseStatus.html" title="class in org.eclipse.jetty.websocket.core">CloseStatus</a> closeStatus, |
| <a href="../../../util/Callback.html" title="interface in org.eclipse.jetty.util">Callback</a> callback)</code></th> |
| <td class="colLast"> |
| <div class="block">This is the Close Handshake Complete event.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onContinuation(org.eclipse.jetty.websocket.core.Frame,org.eclipse.jetty.util.Callback)">onContinuation</a></span>​(<a href="../../core/Frame.html" title="class in org.eclipse.jetty.websocket.core">Frame</a> frame, |
| <a href="../../../util/Callback.html" title="interface in org.eclipse.jetty.util">Callback</a> callback)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onError(java.lang.Throwable,org.eclipse.jetty.util.Callback)">onError</a></span>​(java.lang.Throwable cause, |
| <a href="../../../util/Callback.html" title="interface in org.eclipse.jetty.util">Callback</a> callback)</code></th> |
| <td class="colLast"> |
| <div class="block">An error has occurred or been detected in websocket-core and being reported to FrameHandler.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onFrame(org.eclipse.jetty.websocket.core.Frame,org.eclipse.jetty.util.Callback)">onFrame</a></span>​(<a href="../../core/Frame.html" title="class in org.eclipse.jetty.websocket.core">Frame</a> frame, |
| <a href="../../../util/Callback.html" title="interface in org.eclipse.jetty.util">Callback</a> callback)</code></th> |
| <td class="colLast"> |
| <div class="block">Receiver of all Frames.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onOpen(org.eclipse.jetty.websocket.core.CoreSession,org.eclipse.jetty.util.Callback)">onOpen</a></span>​(<a href="../../core/CoreSession.html" title="interface in org.eclipse.jetty.websocket.core">CoreSession</a> coreSession, |
| <a href="../../../util/Callback.html" title="interface in org.eclipse.jetty.util">Callback</a> callback)</code></th> |
| <td class="colLast"> |
| <div class="block">Async notification that Connection is being opened.</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="#onPing(org.eclipse.jetty.websocket.core.Frame,org.eclipse.jetty.util.Callback)">onPing</a></span>​(<a href="../../core/Frame.html" title="class in org.eclipse.jetty.websocket.core">Frame</a> frame, |
| <a href="../../../util/Callback.html" title="interface in org.eclipse.jetty.util">Callback</a> callback)</code></th> |
| <td class="colLast"> </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="#onPong(org.eclipse.jetty.websocket.core.Frame,org.eclipse.jetty.util.Callback)">onPong</a></span>​(<a href="../../core/Frame.html" title="class in org.eclipse.jetty.websocket.core">Frame</a> frame, |
| <a href="../../../util/Callback.html" title="interface in org.eclipse.jetty.util">Callback</a> callback)</code></th> |
| <td class="colLast"> </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="#onText(org.eclipse.jetty.websocket.core.Frame,org.eclipse.jetty.util.Callback)">onText</a></span>​(<a href="../../core/Frame.html" title="class in org.eclipse.jetty.websocket.core">Frame</a> frame, |
| <a href="../../../util/Callback.html" title="interface in org.eclipse.jetty.util">Callback</a> callback)</code></th> |
| <td class="colLast"> </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="#removeMessageHandler(javax.websocket.MessageHandler)">removeMessageHandler</a></span>​(javax.websocket.MessageHandler handler)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toString()">toString</a></span>()</code></th> |
| <td class="colLast"> </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, wait, wait, wait</code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.eclipse.jetty.websocket.core.FrameHandler"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.eclipse.jetty.websocket.core.<a href="../../core/FrameHandler.html" title="interface in org.eclipse.jetty.websocket.core">FrameHandler</a></h3> |
| <code><a href="../../core/FrameHandler.html#isDemanding()">isDemanding</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a id="dataType"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>dataType</h4> |
| <pre>protected byte dataType</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a id="<init>(org.eclipse.jetty.websocket.javax.common.JavaxWebSocketContainer,org.eclipse.jetty.websocket.javax.common.UpgradeRequest,java.lang.Object,java.lang.invoke.MethodHandle,java.lang.invoke.MethodHandle,java.lang.invoke.MethodHandle,org.eclipse.jetty.websocket.javax.common.JavaxWebSocketMessageMetadata,org.eclipse.jetty.websocket.javax.common.JavaxWebSocketMessageMetadata,java.lang.invoke.MethodHandle,javax.websocket.EndpointConfig)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>JavaxWebSocketFrameHandler</h4> |
| <pre>public JavaxWebSocketFrameHandler​(<a href="JavaxWebSocketContainer.html" title="class in org.eclipse.jetty.websocket.javax.common">JavaxWebSocketContainer</a> container, |
| <a href="UpgradeRequest.html" title="interface in org.eclipse.jetty.websocket.javax.common">UpgradeRequest</a> upgradeRequest, |
| java.lang.Object endpointInstance, |
| java.lang.invoke.MethodHandle openHandle, |
| java.lang.invoke.MethodHandle closeHandle, |
| java.lang.invoke.MethodHandle errorHandle, |
| <a href="JavaxWebSocketMessageMetadata.html" title="class in org.eclipse.jetty.websocket.javax.common">JavaxWebSocketMessageMetadata</a> textMetadata, |
| <a href="JavaxWebSocketMessageMetadata.html" title="class in org.eclipse.jetty.websocket.javax.common">JavaxWebSocketMessageMetadata</a> binaryMetadata, |
| java.lang.invoke.MethodHandle pongHandle, |
| javax.websocket.EndpointConfig endpointConfig)</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="getEndpoint()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEndpoint</h4> |
| <pre class="methodSignature">public java.lang.Object getEndpoint()</pre> |
| </li> |
| </ul> |
| <a id="getEndpointConfig()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEndpointConfig</h4> |
| <pre class="methodSignature">public javax.websocket.EndpointConfig getEndpointConfig()</pre> |
| </li> |
| </ul> |
| <a id="getSession()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSession</h4> |
| <pre class="methodSignature">public <a href="JavaxWebSocketSession.html" title="class in org.eclipse.jetty.websocket.javax.common">JavaxWebSocketSession</a> getSession()</pre> |
| </li> |
| </ul> |
| <a id="onOpen(org.eclipse.jetty.websocket.core.CoreSession,org.eclipse.jetty.util.Callback)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>onOpen</h4> |
| <pre class="methodSignature">public void onOpen​(<a href="../../core/CoreSession.html" title="interface in org.eclipse.jetty.websocket.core">CoreSession</a> coreSession, |
| <a href="../../../util/Callback.html" title="interface in org.eclipse.jetty.util">Callback</a> callback)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../core/FrameHandler.html#onOpen(org.eclipse.jetty.websocket.core.CoreSession,org.eclipse.jetty.util.Callback)">FrameHandler</a></code></span></div> |
| <div class="block">Async notification that Connection is being opened. |
| <p> |
| FrameHandler can write during this call, but can not receive frames until the callback is succeeded. |
| </p> |
| <p> |
| If the FrameHandler succeeds the callback we transition to OPEN state and can now receive frames if |
| not demanding, or can now call <a href="../../core/CoreSession.html#demand(long)"><code>CoreSession.demand(long)</code></a> to receive frames if demanding. |
| If the FrameHandler fails the callback a close frame will be sent with <a href="../../core/CloseStatus.html#SERVER_ERROR"><code>CloseStatus.SERVER_ERROR</code></a> and |
| the connection will be closed. <br> |
| </p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../core/FrameHandler.html#onOpen(org.eclipse.jetty.websocket.core.CoreSession,org.eclipse.jetty.util.Callback)">onOpen</a></code> in interface <code><a href="../../core/FrameHandler.html" title="interface in org.eclipse.jetty.websocket.core">FrameHandler</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>coreSession</code> - the session associated with this connection.</dd> |
| <dd><code>callback</code> - the callback to indicate success in processing (or failure)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="onFrame(org.eclipse.jetty.websocket.core.Frame,org.eclipse.jetty.util.Callback)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>onFrame</h4> |
| <pre class="methodSignature">public void onFrame​(<a href="../../core/Frame.html" title="class in org.eclipse.jetty.websocket.core">Frame</a> frame, |
| <a href="../../../util/Callback.html" title="interface in org.eclipse.jetty.util">Callback</a> callback)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../core/FrameHandler.html#onFrame(org.eclipse.jetty.websocket.core.Frame,org.eclipse.jetty.util.Callback)">FrameHandler</a></code></span></div> |
| <div class="block">Receiver of all Frames. |
| This method will never be called in parallel for the same session and will be called |
| sequentially to satisfy all outstanding demand signaled by calls to |
| <a href="../../core/CoreSession.html#demand(long)"><code>CoreSession.demand(long)</code></a>. |
| Control and Data frames are passed to this method. |
| Close frames may be responded to by the handler, but if an appropriate close response is not |
| sent once the callback is succeeded, then a response close will be generated and sent.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../core/FrameHandler.html#onFrame(org.eclipse.jetty.websocket.core.Frame,org.eclipse.jetty.util.Callback)">onFrame</a></code> in interface <code><a href="../../core/FrameHandler.html" title="interface in org.eclipse.jetty.websocket.core">FrameHandler</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../core/IncomingFrames.html#onFrame(org.eclipse.jetty.websocket.core.Frame,org.eclipse.jetty.util.Callback)">onFrame</a></code> in interface <code><a href="../../core/IncomingFrames.html" title="interface in org.eclipse.jetty.websocket.core">IncomingFrames</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>frame</code> - the raw frame</dd> |
| <dd><code>callback</code> - the callback to indicate success in processing frame (or failure)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="onClose(org.eclipse.jetty.websocket.core.Frame,org.eclipse.jetty.util.Callback)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>onClose</h4> |
| <pre class="methodSignature">public void onClose​(<a href="../../core/Frame.html" title="class in org.eclipse.jetty.websocket.core">Frame</a> frame, |
| <a href="../../../util/Callback.html" title="interface in org.eclipse.jetty.util">Callback</a> callback)</pre> |
| </li> |
| </ul> |
| <a id="onClosed(org.eclipse.jetty.websocket.core.CloseStatus,org.eclipse.jetty.util.Callback)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>onClosed</h4> |
| <pre class="methodSignature">public void onClosed​(<a href="../../core/CloseStatus.html" title="class in org.eclipse.jetty.websocket.core">CloseStatus</a> closeStatus, |
| <a href="../../../util/Callback.html" title="interface in org.eclipse.jetty.util">Callback</a> callback)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../core/FrameHandler.html#onClosed(org.eclipse.jetty.websocket.core.CloseStatus,org.eclipse.jetty.util.Callback)">FrameHandler</a></code></span></div> |
| <div class="block">This is the Close Handshake Complete event. |
| <p> |
| The connection is now closed, no reading or writing is possible anymore. |
| Implementations of FrameHandler can cleanup their resources for this connection now. |
| This method will be called only once. |
| </p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../core/FrameHandler.html#onClosed(org.eclipse.jetty.websocket.core.CloseStatus,org.eclipse.jetty.util.Callback)">onClosed</a></code> in interface <code><a href="../../core/FrameHandler.html" title="interface in org.eclipse.jetty.websocket.core">FrameHandler</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>closeStatus</code> - the close status received from remote, or in the case of abnormal closure from local.</dd> |
| <dd><code>callback</code> - the callback to indicate success in processing (or failure)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="onError(java.lang.Throwable,org.eclipse.jetty.util.Callback)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>onError</h4> |
| <pre class="methodSignature">public void onError​(java.lang.Throwable cause, |
| <a href="../../../util/Callback.html" title="interface in org.eclipse.jetty.util">Callback</a> callback)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../core/FrameHandler.html#onError(java.lang.Throwable,org.eclipse.jetty.util.Callback)">FrameHandler</a></code></span></div> |
| <div class="block">An error has occurred or been detected in websocket-core and being reported to FrameHandler. |
| A call to onError will be followed by a call to <a href="../../core/FrameHandler.html#onClosed(org.eclipse.jetty.websocket.core.CloseStatus,org.eclipse.jetty.util.Callback)"><code>FrameHandler.onClosed(CloseStatus, Callback)</code></a> giving the close status |
| derived from the error. This will not be called more than once, <a href="../../core/FrameHandler.html#onClosed(org.eclipse.jetty.websocket.core.CloseStatus,org.eclipse.jetty.util.Callback)"><code>FrameHandler.onClosed(CloseStatus, Callback)</code></a> |
| will be called on the callback completion.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../core/FrameHandler.html#onError(java.lang.Throwable,org.eclipse.jetty.util.Callback)">onError</a></code> in interface <code><a href="../../core/FrameHandler.html" title="interface in org.eclipse.jetty.websocket.core">FrameHandler</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>cause</code> - the reason for the error</dd> |
| <dd><code>callback</code> - the callback to indicate success in processing (or failure)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getMessageHandlers()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMessageHandlers</h4> |
| <pre class="methodSignature">public java.util.Set<javax.websocket.MessageHandler> getMessageHandlers()</pre> |
| </li> |
| </ul> |
| <a id="getMessageHandlerMap()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMessageHandlerMap</h4> |
| <pre class="methodSignature">public java.util.Map<java.lang.Byte,​<a href="RegisteredMessageHandler.html" title="class in org.eclipse.jetty.websocket.javax.common">RegisteredMessageHandler</a>> getMessageHandlerMap()</pre> |
| </li> |
| </ul> |
| <a id="getBinaryMetadata()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBinaryMetadata</h4> |
| <pre class="methodSignature">public <a href="JavaxWebSocketMessageMetadata.html" title="class in org.eclipse.jetty.websocket.javax.common">JavaxWebSocketMessageMetadata</a> getBinaryMetadata()</pre> |
| </li> |
| </ul> |
| <a id="getTextMetadata()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTextMetadata</h4> |
| <pre class="methodSignature">public <a href="JavaxWebSocketMessageMetadata.html" title="class in org.eclipse.jetty.websocket.javax.common">JavaxWebSocketMessageMetadata</a> getTextMetadata()</pre> |
| </li> |
| </ul> |
| <a id="addMessageHandler(java.lang.Class,javax.websocket.MessageHandler.Partial)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addMessageHandler</h4> |
| <pre class="methodSignature">public <T> void addMessageHandler​(java.lang.Class<T> clazz, |
| javax.websocket.MessageHandler.Partial<T> handler)</pre> |
| </li> |
| </ul> |
| <a id="addMessageHandler(java.lang.Class,javax.websocket.MessageHandler.Whole)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addMessageHandler</h4> |
| <pre class="methodSignature">public <T> void addMessageHandler​(java.lang.Class<T> clazz, |
| javax.websocket.MessageHandler.Whole<T> handler)</pre> |
| </li> |
| </ul> |
| <a id="removeMessageHandler(javax.websocket.MessageHandler)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeMessageHandler</h4> |
| <pre class="methodSignature">public void removeMessageHandler​(javax.websocket.MessageHandler handler)</pre> |
| </li> |
| </ul> |
| <a id="toString()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toString</h4> |
| <pre class="methodSignature">public java.lang.String toString()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code>toString</code> in class <code>java.lang.Object</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="onPing(org.eclipse.jetty.websocket.core.Frame,org.eclipse.jetty.util.Callback)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>onPing</h4> |
| <pre class="methodSignature">public void onPing​(<a href="../../core/Frame.html" title="class in org.eclipse.jetty.websocket.core">Frame</a> frame, |
| <a href="../../../util/Callback.html" title="interface in org.eclipse.jetty.util">Callback</a> callback)</pre> |
| </li> |
| </ul> |
| <a id="onPong(org.eclipse.jetty.websocket.core.Frame,org.eclipse.jetty.util.Callback)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>onPong</h4> |
| <pre class="methodSignature">public void onPong​(<a href="../../core/Frame.html" title="class in org.eclipse.jetty.websocket.core">Frame</a> frame, |
| <a href="../../../util/Callback.html" title="interface in org.eclipse.jetty.util">Callback</a> callback)</pre> |
| </li> |
| </ul> |
| <a id="onText(org.eclipse.jetty.websocket.core.Frame,org.eclipse.jetty.util.Callback)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>onText</h4> |
| <pre class="methodSignature">public void onText​(<a href="../../core/Frame.html" title="class in org.eclipse.jetty.websocket.core">Frame</a> frame, |
| <a href="../../../util/Callback.html" title="interface in org.eclipse.jetty.util">Callback</a> callback)</pre> |
| </li> |
| </ul> |
| <a id="onBinary(org.eclipse.jetty.websocket.core.Frame,org.eclipse.jetty.util.Callback)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>onBinary</h4> |
| <pre class="methodSignature">public void onBinary​(<a href="../../core/Frame.html" title="class in org.eclipse.jetty.websocket.core">Frame</a> frame, |
| <a href="../../../util/Callback.html" title="interface in org.eclipse.jetty.util">Callback</a> callback)</pre> |
| </li> |
| </ul> |
| <a id="onContinuation(org.eclipse.jetty.websocket.core.Frame,org.eclipse.jetty.util.Callback)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>onContinuation</h4> |
| <pre class="methodSignature">public void onContinuation​(<a href="../../core/Frame.html" title="class in org.eclipse.jetty.websocket.core">Frame</a> frame, |
| <a href="../../../util/Callback.html" title="interface in org.eclipse.jetty.util">Callback</a> callback)</pre> |
| </li> |
| </ul> |
| <a id="getUpgradeRequest()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getUpgradeRequest</h4> |
| <pre class="methodSignature">public <a href="UpgradeRequest.html" title="interface in org.eclipse.jetty.websocket.javax.common">UpgradeRequest</a> getUpgradeRequest()</pre> |
| </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/JavaxWebSocketFrameHandler.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><a href="#field.summary">Field</a> | </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><a href="#field.detail">Field</a> | </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> |
