blob: ce61e0b29ef9dcc17cd7d4ccba325c66b9518784 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_92) on Thu Jun 07 14:26:36 EDT 2018 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>org.eclipse.jetty.websocket.common (Jetty :: Project 9.3.24.v20180605 API)</title>
<meta name="date" content="2018-06-07">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="org.eclipse.jetty.websocket.common (Jetty :: Project 9.3.24.v20180605 API)";
}
}
catch(err) {
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li class="navBarCell1Rev">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">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/eclipse/jetty/websocket/client/masks/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../org/eclipse/jetty/websocket/common/events/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/eclipse/jetty/websocket/common/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></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>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="Package" class="title">Package&nbsp;org.eclipse.jetty.websocket.common</h1>
<div class="docSummary">
<div class="block">Jetty WebSocket Common : Implementation [<em>Internal Use Only</em>]</div>
</div>
<p>See:&nbsp;<a href="#package.description">Description</a></p>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation">
<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/eclipse/jetty/websocket/common/LogicalConnection.html" title="interface in org.eclipse.jetty.websocket.common">LogicalConnection</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/eclipse/jetty/websocket/common/RemoteEndpointFactory.html" title="interface in org.eclipse.jetty.websocket.common">RemoteEndpointFactory</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/eclipse/jetty/websocket/common/SessionFactory.html" title="interface in org.eclipse.jetty.websocket.common">SessionFactory</a></td>
<td class="colLast">
<div class="block">Interface for creating jetty <a href="../../../../../org/eclipse/jetty/websocket/common/WebSocketSession.html" title="class in org.eclipse.jetty.websocket.common"><code>WebSocketSession</code></a> objects.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/eclipse/jetty/websocket/common/WebSocketSession.Listener.html" title="interface in org.eclipse.jetty.websocket.common">WebSocketSession.Listener</a></td>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/eclipse/jetty/websocket/common/AcceptHash.html" title="class in org.eclipse.jetty.websocket.common">AcceptHash</a></td>
<td class="colLast">
<div class="block">Logic for working with the <code>Sec-WebSocket-Key</code> and <code>Sec-WebSocket-Accept</code> headers.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/eclipse/jetty/websocket/common/BlockingWriteCallback.html" title="class in org.eclipse.jetty.websocket.common">BlockingWriteCallback</a></td>
<td class="colLast">
<div class="block">Extends a <a href="../../../../../org/eclipse/jetty/util/SharedBlockingCallback.html" title="class in org.eclipse.jetty.util"><code>SharedBlockingCallback</code></a> to a WebSocket <a href="../../../../../org/eclipse/jetty/websocket/api/WriteCallback.html" title="interface in org.eclipse.jetty.websocket.api"><code>WriteCallback</code></a></div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/eclipse/jetty/websocket/common/BlockingWriteCallback.WriteBlocker.html" title="class in org.eclipse.jetty.websocket.common">BlockingWriteCallback.WriteBlocker</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/eclipse/jetty/websocket/common/CloseInfo.html" title="class in org.eclipse.jetty.websocket.common">CloseInfo</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/eclipse/jetty/websocket/common/Generator.html" title="class in org.eclipse.jetty.websocket.common">Generator</a></td>
<td class="colLast">
<div class="block">Generating a frame in WebSocket land.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/eclipse/jetty/websocket/common/OpCode.html" title="class in org.eclipse.jetty.websocket.common">OpCode</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/eclipse/jetty/websocket/common/Parser.html" title="class in org.eclipse.jetty.websocket.common">Parser</a></td>
<td class="colLast">
<div class="block">Parsing of a frames in WebSocket land.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/eclipse/jetty/websocket/common/WebSocketFrame.html" title="class in org.eclipse.jetty.websocket.common">WebSocketFrame</a></td>
<td class="colLast">
<div class="block">A Base Frame as seen in <a href="https://tools.ietf.org/html/rfc6455#section-5.2">RFC 6455.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/eclipse/jetty/websocket/common/WebSocketRemoteEndpoint.html" title="class in org.eclipse.jetty.websocket.common">WebSocketRemoteEndpoint</a></td>
<td class="colLast">
<div class="block">Endpoint for Writing messages to the Remote websocket.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/eclipse/jetty/websocket/common/WebSocketSession.html" title="class in org.eclipse.jetty.websocket.common">WebSocketSession</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/eclipse/jetty/websocket/common/WebSocketSessionFactory.html" title="class in org.eclipse.jetty.websocket.common">WebSocketSessionFactory</a></td>
<td class="colLast">
<div class="block">Default Session factory, creating WebSocketSession objects.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation">
<caption><span>Enum Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Enum</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/eclipse/jetty/websocket/common/ConnectionState.html" title="enum in org.eclipse.jetty.websocket.common">ConnectionState</a></td>
<td class="colLast">
<div class="block">Connection states as outlined in <a href="https://tools.ietf.org/html/rfc6455">RFC6455</a>.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
<a name="package.description">
<!-- -->
</a>
<h2 title="Package org.eclipse.jetty.websocket.common Description">Package org.eclipse.jetty.websocket.common Description</h2>
<div class="block">Jetty WebSocket Common : Implementation [<em>Internal Use Only</em>]
<p>
A core set of internal implementation classes for the Jetty WebSocket API.
<p>
Note: do not reference or use classes present in this package space in your code. <br>
Restrict your usage to the Jetty WebSocket API classes, the Jetty WebSocket Client API,
or the Jetty WebSocket Servlet API.</div>
</div>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li class="navBarCell1Rev">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">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/eclipse/jetty/websocket/client/masks/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../org/eclipse/jetty/websocket/common/events/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/eclipse/jetty/websocket/common/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.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>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 1995&#x2013;2018 <a href="http://webtide.com">Webtide</a>. All rights reserved.</small></p>
</body>
</html>