| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) on Thu Sep 15 14:12:07 CDT 2022 --> |
| <title>org.eclipse.jetty.websocket.api (Eclipse Jetty API Doc - v10.0.12)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2022-09-15"> |
| <meta name="description" content="declaration: package: org.eclipse.jetty.websocket.api"> |
| <meta name="generator" content="javadoc/PackageWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-3.5.1.min.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="package-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| var pathtoroot = "../../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li class="nav-bar-cell1-rev">Package</li> |
| <li>Class</li> |
| <li><a href="package-use.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#package">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Package: </li> |
| <li><a href="#package-description">Description</a> | </li> |
| <li><a href="#related-package-summary">Related Packages</a> | </li> |
| <li><a href="#class-summary">Classes and Interfaces</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search-input">SEARCH:</label> |
| <input type="text" id="search-input" value="search" disabled="disabled"> |
| <input type="reset" id="reset-button" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <div class="header"> |
| <h1 title="Package org.eclipse.jetty.websocket.api" class="title">Package org.eclipse.jetty.websocket.api</h1> |
| </div> |
| <hr> |
| <div class="package-signature">package <span class="element-name">org.eclipse.jetty.websocket.api</span></div> |
| <section class="package-description" id="package-description"> |
| <div class="block">Jetty WebSocket API</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <li> |
| <div id="related-package-summary"> |
| <div class="caption"><span>Related Packages</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Package</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><a href="annotations/package-summary.html">org.eclipse.jetty.websocket.api.annotations</a></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Jetty WebSocket API : WebSocket POJO Annotations</div> |
| </div> |
| <div class="col-first odd-row-color"><a href="exceptions/package-summary.html">org.eclipse.jetty.websocket.api.exceptions</a></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Jetty WebSocket API : Exception Types</div> |
| </div> |
| <div class="col-first even-row-color"><a href="util/package-summary.html">org.eclipse.jetty.websocket.api.util</a></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Jetty WebSocket API : Utility Classes</div> |
| </div> |
| </div> |
| </div> |
| </li> |
| <li> |
| <div id="class-summary"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="class-summary-tab0" role="tab" aria-selected="true" aria-controls="class-summary.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary', 2)" class="active-table-tab">All Classes and Interfaces</button><button id="class-summary-tab1" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab1', 2)" class="table-tab">Interfaces</button><button id="class-summary-tab2" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab2', 2)" class="table-tab">Classes</button><button id="class-summary-tab3" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab3', 2)" class="table-tab">Enums</button></div> |
| <div id="class-summary.tabpanel" role="tabpanel"> |
| <div class="summary-table two-column-summary" aria-labelledby="class-summary-tab0"> |
| <div class="table-header col-first">Class</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color class-summary class-summary-tab3"><a href="BatchMode.html" title="enum in org.eclipse.jetty.websocket.api">BatchMode</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab3"> |
| <div class="block">The possible batch modes when enqueuing outgoing frames.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="CloseStatus.html" title="class in org.eclipse.jetty.websocket.api">CloseStatus</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="ExtensionConfig.html" title="interface in org.eclipse.jetty.websocket.api">ExtensionConfig</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">Represents an Extension Configuration, as seen during the connection Handshake process.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab1"><a href="ExtensionConfig.Parser.html" title="interface in org.eclipse.jetty.websocket.api">ExtensionConfig.Parser</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab1"> </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="Frame.html" title="interface in org.eclipse.jetty.websocket.api">Frame</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">An immutable websocket frame.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab3"><a href="Frame.Type.html" title="enum in org.eclipse.jetty.websocket.api">Frame.Type</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab3"> </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="RemoteEndpoint.html" title="interface in org.eclipse.jetty.websocket.api">RemoteEndpoint</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab1"><a href="Session.html" title="interface in org.eclipse.jetty.websocket.api">Session</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab1"> |
| <div class="block">Session represents an active link of communications with a Remote WebSocket Endpoint.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="StatusCode.html" title="class in org.eclipse.jetty.websocket.api">StatusCode</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">The <a href="https://tools.ietf.org/html/rfc6455#section-7.4">RFC 6455 specified status codes</a> and <a href="https://www.iana.org/assignments/websocket/websocket.xml#close-code-number-rules">IANA: WebSocket Close Code Number Registry</a></div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab1"><a href="SuspendToken.html" title="interface in org.eclipse.jetty.websocket.api">SuspendToken</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab1"> |
| <div class="block">Connection suspend token</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="UpgradeRequest.html" title="interface in org.eclipse.jetty.websocket.api">UpgradeRequest</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">The HTTP Upgrade to WebSocket Request</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab1"><a href="UpgradeResponse.html" title="interface in org.eclipse.jetty.websocket.api">UpgradeResponse</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab1"> |
| <div class="block">The HTTP Upgrade to WebSocket Response</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="WebSocketAdapter.html" title="class in org.eclipse.jetty.websocket.api">WebSocketAdapter</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Default implementation of the <a href="WebSocketListener.html" title="interface in org.eclipse.jetty.websocket.api"><code>WebSocketListener</code></a>.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab3"><a href="WebSocketBehavior.html" title="enum in org.eclipse.jetty.websocket.api">WebSocketBehavior</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab3"> |
| <div class="block">Behavior for how the WebSocket should operate.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="WebSocketConnectionListener.html" title="interface in org.eclipse.jetty.websocket.api">WebSocketConnectionListener</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">Core WebSocket Connection Listener</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab1"><a href="WebSocketContainer.html" title="interface in org.eclipse.jetty.websocket.api">WebSocketContainer</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab1"> |
| <div class="block">Generic interface to the Container (server or client)</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="WebSocketFrameListener.html" title="interface in org.eclipse.jetty.websocket.api">WebSocketFrameListener</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">WebSocket Frame Listener interface for incoming WebSocket frames.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab1"><a href="WebSocketListener.html" title="interface in org.eclipse.jetty.websocket.api">WebSocketListener</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab1"> |
| <div class="block">Basic WebSocket Listener interface for incoming WebSocket message events.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="WebSocketPartialListener.html" title="interface in org.eclipse.jetty.websocket.api">WebSocketPartialListener</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">WebSocket Partial Message Listener interface for incoming WebSocket TEXT/BINARY/CONTINUATION frames.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab1"><a href="WebSocketPingPongListener.html" title="interface in org.eclipse.jetty.websocket.api">WebSocketPingPongListener</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab1"> |
| <div class="block">WebSocket PING/PONG Listener interface for incoming WebSocket PING/PONG frames.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="WebSocketPolicy.html" title="interface in org.eclipse.jetty.websocket.api">WebSocketPolicy</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">Settings for WebSocket operations.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab1"><a href="WebSocketSessionListener.html" title="interface in org.eclipse.jetty.websocket.api">WebSocketSessionListener</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab1"> |
| <div class="block">Interface for Listeners that are interested in knowing about the Session history.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="WriteCallback.html" title="interface in org.eclipse.jetty.websocket.api">WriteCallback</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">Callback for Write events.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="WriteCallback.Adaptor.html" title="class in org.eclipse.jetty.websocket.api">WriteCallback.Adaptor</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2">Deprecated.</div> |
| </div> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </section> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 1995–2022 <a href="https://webtide.com">Webtide</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
