Google Git
Sign in
eclipse / www.eclipse.org / jetty / 244b31480d88c4c2e783a862c86c320807c66eb3 / . / javadoc / 9.4.31.v20200723 / org / eclipse / jetty / websocket / common / Parser.html
blob: 254736d8791b8f822a86889e42e9ccf3b8b1a873 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.7) on Wed Jul 29 16:44:05 EDT 2020 -->
<title>Parser (Jetty :: Project 9.4.31.v20200723 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2020-07-29">
<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.3.1.js"></script>
<script type="text/javascript" src="../../../../../jquery/jquery-migrate-3.0.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="Parser (Jetty :: Project 9.4.31.v20200723 API)";
}
}
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};
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/Parser.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&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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">&nbsp;</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>&nbsp;<a href="package-summary.html">org.eclipse.jetty.websocket.common</a></div>
<h2 title="Class Parser" class="title">Class Parser</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.eclipse.jetty.websocket.common.Parser</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<pre>public class <span class="typeNameLabel">Parser</span>
extends java.lang.Object</pre>
<div class="block">Parsing of a frames in WebSocket land.</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">&nbsp;</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.api.WebSocketPolicy,org.eclipse.jetty.io.ByteBufferPool)">Parser</a></span>&#8203;(<a href="../api/WebSocketPolicy.html" title="class in org.eclipse.jetty.websocket.api">WebSocketPolicy</a>&nbsp;wspolicy,
<a href="../../io/ByteBufferPool.html" title="interface in org.eclipse.jetty.io">ByteBufferPool</a>&nbsp;bufferPool)</code></th>
<td class="colLast">&nbsp;</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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</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>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#configureFromExtensions(java.util.List)">configureFromExtensions</a></span>&#8203;(java.util.List&lt;? extends <a href="../api/extensions/Extension.html" title="interface in org.eclipse.jetty.websocket.api.extensions">Extension</a>&gt;&nbsp;exts)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../api/extensions/IncomingFrames.html" title="interface in org.eclipse.jetty.websocket.api.extensions">IncomingFrames</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getIncomingFramesHandler()">getIncomingFramesHandler</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMessagesIn()">getMessagesIn</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../api/WebSocketPolicy.html" title="class in org.eclipse.jetty.websocket.api">WebSocketPolicy</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPolicy()">getPolicy</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isRsv1InUse()">isRsv1InUse</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isRsv2InUse()">isRsv2InUse</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isRsv3InUse()">isRsv3InUse</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#notifyFrame(org.eclipse.jetty.websocket.api.extensions.Frame)">notifyFrame</a></span>&#8203;(<a href="../api/extensions/Frame.html" title="interface in org.eclipse.jetty.websocket.api.extensions">Frame</a>&nbsp;f)</code></th>
<td class="colLast">&nbsp;</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="#parse(java.nio.ByteBuffer)">parse</a></span>&#8203;(java.nio.ByteBuffer&nbsp;buffer)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#parseSingleFrame(java.nio.ByteBuffer)">parseSingleFrame</a></span>&#8203;(java.nio.ByteBuffer&nbsp;buffer)</code></th>
<td class="colLast">&nbsp;</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="#setIncomingFramesHandler(org.eclipse.jetty.websocket.api.extensions.IncomingFrames)">setIncomingFramesHandler</a></span>&#8203;(<a href="../api/extensions/IncomingFrames.html" title="interface in org.eclipse.jetty.websocket.api.extensions">IncomingFrames</a>&nbsp;incoming)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i11" 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">&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, 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="&lt;init&gt;(org.eclipse.jetty.websocket.api.WebSocketPolicy,org.eclipse.jetty.io.ByteBufferPool)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Parser</h4>
<pre>public&nbsp;Parser&#8203;(<a href="../api/WebSocketPolicy.html" title="class in org.eclipse.jetty.websocket.api">WebSocketPolicy</a>&nbsp;wspolicy,
<a href="../../io/ByteBufferPool.html" title="interface in org.eclipse.jetty.io">ByteBufferPool</a>&nbsp;bufferPool)</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="configureFromExtensions(java.util.List)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>configureFromExtensions</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;configureFromExtensions&#8203;(java.util.List&lt;? extends <a href="../api/extensions/Extension.html" title="interface in org.eclipse.jetty.websocket.api.extensions">Extension</a>&gt;&nbsp;exts)</pre>
</li>
</ul>
<a id="getIncomingFramesHandler()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getIncomingFramesHandler</h4>
<pre class="methodSignature">public&nbsp;<a href="../api/extensions/IncomingFrames.html" title="interface in org.eclipse.jetty.websocket.api.extensions">IncomingFrames</a>&nbsp;getIncomingFramesHandler()</pre>
</li>
</ul>
<a id="getPolicy()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPolicy</h4>
<pre class="methodSignature">public&nbsp;<a href="../api/WebSocketPolicy.html" title="class in org.eclipse.jetty.websocket.api">WebSocketPolicy</a>&nbsp;getPolicy()</pre>
</li>
</ul>
<a id="isRsv1InUse()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isRsv1InUse</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isRsv1InUse()</pre>
</li>
</ul>
<a id="isRsv2InUse()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isRsv2InUse</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isRsv2InUse()</pre>
</li>
</ul>
<a id="isRsv3InUse()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isRsv3InUse</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isRsv3InUse()</pre>
</li>
</ul>
<a id="notifyFrame(org.eclipse.jetty.websocket.api.extensions.Frame)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>notifyFrame</h4>
<pre class="methodSignature">protected&nbsp;void&nbsp;notifyFrame&#8203;(<a href="../api/extensions/Frame.html" title="interface in org.eclipse.jetty.websocket.api.extensions">Frame</a>&nbsp;f)
throws <a href="../api/WebSocketException.html" title="class in org.eclipse.jetty.websocket.api">WebSocketException</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../api/WebSocketException.html" title="class in org.eclipse.jetty.websocket.api">WebSocketException</a></code></dd>
</dl>
</li>
</ul>
<a id="parse(java.nio.ByteBuffer)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>parse</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;parse&#8203;(java.nio.ByteBuffer&nbsp;buffer)
throws <a href="../api/WebSocketException.html" title="class in org.eclipse.jetty.websocket.api">WebSocketException</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../api/WebSocketException.html" title="class in org.eclipse.jetty.websocket.api">WebSocketException</a></code></dd>
</dl>
</li>
</ul>
<a id="parseSingleFrame(java.nio.ByteBuffer)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>parseSingleFrame</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;parseSingleFrame&#8203;(java.nio.ByteBuffer&nbsp;buffer)
throws <a href="../api/WebSocketException.html" title="class in org.eclipse.jetty.websocket.api">WebSocketException</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../api/WebSocketException.html" title="class in org.eclipse.jetty.websocket.api">WebSocketException</a></code></dd>
</dl>
</li>
</ul>
<a id="setIncomingFramesHandler(org.eclipse.jetty.websocket.api.extensions.IncomingFrames)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setIncomingFramesHandler</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setIncomingFramesHandler&#8203;(<a href="../api/extensions/IncomingFrames.html" title="interface in org.eclipse.jetty.websocket.api.extensions">IncomingFrames</a>&nbsp;incoming)</pre>
</li>
</ul>
<a id="getMessagesIn()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMessagesIn</h4>
<pre class="methodSignature">public&nbsp;long&nbsp;getMessagesIn()</pre>
</li>
</ul>
<a id="toString()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre class="methodSignature">public&nbsp;java.lang.String&nbsp;toString()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></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/Parser.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&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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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 &#169; 1995&#x2013;2020 <a href="https://webtide.com">Webtide</a>. All rights reserved.</small></p>
</footer>
</body>
</html>