blob: f10935a4ecc8926b32c4de8f8ba94fd341c0839f [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Thu Sep 15 14:12:07 CDT 2022 -->
<title>org.eclipse.jetty.websocket.core (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.core">
<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:&nbsp;</li>
<li>Description&nbsp;|&nbsp;</li>
<li><a href="#related-package-summary">Related Packages</a>&nbsp;|&nbsp;</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.core" class="title">Package org.eclipse.jetty.websocket.core</h1>
</div>
<hr>
<div class="package-signature">package <span class="element-name">org.eclipse.jetty.websocket.core</span></div>
<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="client/package-summary.html">org.eclipse.jetty.websocket.core.client</a></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><a href="exception/package-summary.html">org.eclipse.jetty.websocket.core.exception</a></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><a href="internal/package-summary.html">org.eclipse.jetty.websocket.core.internal</a></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><a href="server/package-summary.html">org.eclipse.jetty.websocket.core.server</a></div>
<div class="col-last odd-row-color">&nbsp;</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-tab2"><a href="AbstractExtension.html" title="class in org.eclipse.jetty.websocket.core">AbstractExtension</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">&nbsp;</div>
<div class="col-first odd-row-color class-summary class-summary-tab3"><a href="Behavior.html" title="enum in org.eclipse.jetty.websocket.core">Behavior</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-tab2"><a href="CloseStatus.html" title="class in org.eclipse.jetty.websocket.core">CloseStatus</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Representation of a WebSocket Close (status code &amp; reason)</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="CloseStatus.Supplier.html" title="interface in org.eclipse.jetty.websocket.core">CloseStatus.Supplier</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab1">&nbsp;</div>
<div class="col-first even-row-color class-summary class-summary-tab1"><a href="Configuration.html" title="interface in org.eclipse.jetty.websocket.core">Configuration</a></div>
<div class="col-last even-row-color class-summary class-summary-tab1">&nbsp;</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="Configuration.ConfigurationCustomizer.html" title="class in org.eclipse.jetty.websocket.core">Configuration.ConfigurationCustomizer</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">&nbsp;</div>
<div class="col-first even-row-color class-summary class-summary-tab1"><a href="Configuration.Customizer.html" title="interface in org.eclipse.jetty.websocket.core">Configuration.Customizer</a></div>
<div class="col-last even-row-color class-summary class-summary-tab1">&nbsp;</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="CoreSession.html" title="interface in org.eclipse.jetty.websocket.core">CoreSession</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab1">
<div class="block">Represents the outgoing Frames.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="CoreSession.Empty.html" title="class in org.eclipse.jetty.websocket.core">CoreSession.Empty</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">&nbsp;</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="Extension.html" title="interface in org.eclipse.jetty.websocket.core">Extension</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab1">
<div class="block">Interface for WebSocket Extensions.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="ExtensionConfig.html" title="class in org.eclipse.jetty.websocket.core">ExtensionConfig</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<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-tab2"><a href="Frame.html" title="class in org.eclipse.jetty.websocket.core">Frame</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">A Base Frame as seen in <a href="https://tools.ietf.org/html/rfc6455#section-5.2">RFC 6455.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab1"><a href="FrameHandler.html" title="interface in org.eclipse.jetty.websocket.core">FrameHandler</a></div>
<div class="col-last even-row-color class-summary class-summary-tab1">
<div class="block">Interface for local WebSocket Endpoint Frame handling.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="IncomingFrames.html" title="interface in org.eclipse.jetty.websocket.core">IncomingFrames</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab1">
<div class="block">Interface for dealing with Incoming Frames.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="OpCode.html" title="class in org.eclipse.jetty.websocket.core">OpCode</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">&nbsp;</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="OutgoingFrames.html" title="interface in org.eclipse.jetty.websocket.core">OutgoingFrames</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab1">
<div class="block">Interface for dealing with frames outgoing to (eventually) the network layer.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="WebSocketComponents.html" title="class in org.eclipse.jetty.websocket.core">WebSocketComponents</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">A collection of components which are the resources needed for websockets such as
<a href="../../io/ByteBufferPool.html" title="interface in org.eclipse.jetty.io"><code>ByteBufferPool</code></a>, <a href="WebSocketExtensionRegistry.html" title="class in org.eclipse.jetty.websocket.core"><code>WebSocketExtensionRegistry</code></a>, and <a href="../../util/DecoratedObjectFactory.html" title="class in org.eclipse.jetty.util"><code>DecoratedObjectFactory</code></a>.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="WebSocketConstants.html" title="class in org.eclipse.jetty.websocket.core">WebSocketConstants</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">&nbsp;</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="WebSocketExtensionRegistry.html" title="class in org.eclipse.jetty.websocket.core">WebSocketExtensionRegistry</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">&nbsp;</div>
</div>
</div>
</div>
</li>
</ul>
</section>
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &#169; 1995&#x2013;2022 <a href="https://webtide.com">Webtide</a>. All rights reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>