Google Git
Sign in
eclipse / www.eclipse.org / jetty / 244b31480d88c4c2e783a862c86c320807c66eb3 / . / javadoc / current / org / eclipse / jetty / websocket / common / WebSocketFrame.html
blob: 1f58f9d6535433d4332fd5e46a9bbeb52c0d25a3 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.9) on Fri Nov 20 15:16:02 CST 2020 -->
<title>WebSocketFrame (Jetty :: Project 9.4.35.v20201120 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2020-11-20">
<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="WebSocketFrame (Jetty :: Project 9.4.35.v20201120 API)";
}
}
catch(err) {
}
//-->
var data = {"i0":6,"i1":9,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":6,"i14":6,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/WebSocketFrame.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><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&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><a href="#field.detail">Field</a>&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 WebSocketFrame" class="title">Class WebSocketFrame</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.eclipse.jetty.websocket.common.WebSocketFrame</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="../api/extensions/Frame.html" title="interface in org.eclipse.jetty.websocket.api.extensions">Frame</a></code></dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><code><a href="frames/ControlFrame.html" title="class in org.eclipse.jetty.websocket.common.frames">ControlFrame</a></code>, <code><a href="frames/DataFrame.html" title="class in org.eclipse.jetty.websocket.common.frames">DataFrame</a></code></dd>
</dl>
<hr>
<pre>public abstract class <span class="typeNameLabel">WebSocketFrame</span>
extends java.lang.Object
implements <a href="../api/extensions/Frame.html" title="interface in org.eclipse.jetty.websocket.api.extensions">Frame</a></pre>
<div class="block">A Base Frame as seen in <a href="https://tools.ietf.org/html/rfc6455#section-5.2">RFC 6455. Sec 5.2</a>
<pre>
0 1 2 3
0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+-+-+-+-+-------+-+-------------+-------------------------------+
|F|R|R|R| opcode|M| Payload len | Extended payload length |
|I|S|S|S| (4) |A| (7) | (16/64) |
|N|V|V|V| |S| | (if payload len==126/127) |
| |1|2|3| |K| | |
+-+-+-+-+-------+-+-------------+ - - - - - - - - - - - - - - - +
| Extended payload length continued, if payload len == 127 |
+ - - - - - - - - - - - - - - - +-------------------------------+
| |Masking-key, if MASK set to 1 |
+-------------------------------+-------------------------------+
| Masking-key (continued) | Payload Data |
+-------------------------------- - - - - - - - - - - - - - - - +
: Payload Data continued ... :
+ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
| Payload Data continued ... |
+---------------------------------------------------------------+
</pre></div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<ul class="blockList">
<li class="blockList"><a id="nested.classes.inherited.from.class.org.eclipse.jetty.websocket.api.extensions.Frame">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface&nbsp;org.eclipse.jetty.websocket.api.extensions.<a href="../api/extensions/Frame.html" title="interface in org.eclipse.jetty.websocket.api.extensions">Frame</a></h3>
<code><a href="../api/extensions/Frame.Type.html" title="enum in org.eclipse.jetty.websocket.api.extensions">Frame.Type</a></code></li>
</ul>
</li>
</ul>
</section>
<!-- =========== 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">&nbsp;</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 java.nio.ByteBuffer</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#data">data</a></span></code></th>
<td class="colLast">
<div class="block">The payload data.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected byte</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#finRsvOp">finRsvOp</a></span></code></th>
<td class="colLast">
<div class="block">Combined FIN + RSV1 + RSV2 + RSV3 + OpCode byte.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected byte[]</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#mask">mask</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#masked">masked</a></span></code></th>
<td class="colLast">&nbsp;</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">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier</th>
<th class="colSecond" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected </code></td>
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(byte)">WebSocketFrame</a></span>&#8203;(byte&nbsp;opcode)</code></th>
<td class="colLast">
<div class="block">Construct form opcode</div>
</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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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>abstract void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#assertValid()">assertValid</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static <a href="WebSocketFrame.html" title="class in org.eclipse.jetty.websocket.common">WebSocketFrame</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#copy(org.eclipse.jetty.websocket.api.extensions.Frame)">copy</a></span>&#8203;(<a href="../api/extensions/Frame.html" title="interface in org.eclipse.jetty.websocket.api.extensions">Frame</a>&nbsp;original)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#copyHeaders(org.eclipse.jetty.websocket.api.extensions.Frame)">copyHeaders</a></span>&#8203;(<a href="../api/extensions/Frame.html" title="interface in org.eclipse.jetty.websocket.api.extensions">Frame</a>&nbsp;frame)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#copyHeaders(org.eclipse.jetty.websocket.common.WebSocketFrame)">copyHeaders</a></span>&#8203;(<a href="WebSocketFrame.html" title="class in org.eclipse.jetty.websocket.common">WebSocketFrame</a>&nbsp;copy)</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="#equals(java.lang.Object)">equals</a></span>&#8203;(java.lang.Object&nbsp;obj)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>byte[]</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMask()">getMask</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>byte</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getOpCode()">getOpCode</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>java.nio.ByteBuffer</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPayload()">getPayload</a></span>()</code></th>
<td class="colLast">
<div class="block">Get the payload ByteBuffer.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPayloadAsUTF8()">getPayloadAsUTF8</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPayloadLength()">getPayloadLength</a></span>()</code></th>
<td class="colLast">
<div class="block">The original payload length (<code>Buffer.remaining()</code>)</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="../api/extensions/Frame.Type.html" title="enum in org.eclipse.jetty.websocket.api.extensions">Frame.Type</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getType()">getType</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hashCode()">hashCode</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hasPayload()">hasPayload</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>abstract boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isControlFrame()">isControlFrame</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>abstract boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isDataFrame()">isDataFrame</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isFin()">isFin</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isLast()">isLast</a></span>()</code></th>
<td class="colLast">
<div class="block">Same as <a href="../api/extensions/Frame.html#isFin()"><code>Frame.isFin()</code></a></div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isMasked()">isMasked</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isRsv1()">isRsv1</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isRsv2()">isRsv2</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isRsv3()">isRsv3</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#reset()">reset</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code><a href="WebSocketFrame.html" title="class in org.eclipse.jetty.websocket.common">WebSocketFrame</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setFin(boolean)">setFin</a></span>&#8203;(boolean&nbsp;fin)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code><a href="../api/extensions/Frame.html" title="interface in org.eclipse.jetty.websocket.api.extensions">Frame</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setMask(byte%5B%5D)">setMask</a></span>&#8203;(byte[]&nbsp;maskingKey)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code><a href="../api/extensions/Frame.html" title="interface in org.eclipse.jetty.websocket.api.extensions">Frame</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setMasked(boolean)">setMasked</a></span>&#8203;(boolean&nbsp;mask)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><code>protected <a href="WebSocketFrame.html" title="class in org.eclipse.jetty.websocket.common">WebSocketFrame</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setOpCode(byte)">setOpCode</a></span>&#8203;(byte&nbsp;op)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i26" class="altColor">
<td class="colFirst"><code><a href="WebSocketFrame.html" title="class in org.eclipse.jetty.websocket.common">WebSocketFrame</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setPayload(java.nio.ByteBuffer)">setPayload</a></span>&#8203;(java.nio.ByteBuffer&nbsp;buf)</code></th>
<td class="colLast">
<div class="block">Set the data payload.</div>
</td>
</tr>
<tr id="i27" class="rowColor">
<td class="colFirst"><code><a href="WebSocketFrame.html" title="class in org.eclipse.jetty.websocket.common">WebSocketFrame</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setRsv1(boolean)">setRsv1</a></span>&#8203;(boolean&nbsp;rsv1)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i28" class="altColor">
<td class="colFirst"><code><a href="WebSocketFrame.html" title="class in org.eclipse.jetty.websocket.common">WebSocketFrame</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setRsv2(boolean)">setRsv2</a></span>&#8203;(boolean&nbsp;rsv2)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i29" class="rowColor">
<td class="colFirst"><code><a href="WebSocketFrame.html" title="class in org.eclipse.jetty.websocket.common">WebSocketFrame</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setRsv3(boolean)">setRsv3</a></span>&#8203;(boolean&nbsp;rsv3)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i30" class="altColor">
<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, finalize, getClass, notify, notifyAll, wait, wait, wait</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="finRsvOp">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>finRsvOp</h4>
<pre>protected&nbsp;byte finRsvOp</pre>
<div class="block">Combined FIN + RSV1 + RSV2 + RSV3 + OpCode byte.
<pre>
1000_0000 (0x80) = fin
0100_0000 (0x40) = rsv1
0010_0000 (0x20) = rsv2
0001_0000 (0x10) = rsv3
0000_1111 (0x0F) = opcode
</pre></div>
</li>
</ul>
<a id="masked">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>masked</h4>
<pre>protected&nbsp;boolean masked</pre>
</li>
</ul>
<a id="mask">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>mask</h4>
<pre>protected&nbsp;byte[] mask</pre>
</li>
</ul>
<a id="data">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>data</h4>
<pre>protected&nbsp;java.nio.ByteBuffer data</pre>
<div class="block">The payload data.
<p>
It is assumed to always be in FLUSH mode (ready to read) in this object.</div>
</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="&lt;init&gt;(byte)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>WebSocketFrame</h4>
<pre>protected&nbsp;WebSocketFrame&#8203;(byte&nbsp;opcode)</pre>
<div class="block">Construct form opcode</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>opcode</code> - the opcode the frame is based on</dd>
</dl>
</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="copy(org.eclipse.jetty.websocket.api.extensions.Frame)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>copy</h4>
<pre class="methodSignature">public static&nbsp;<a href="WebSocketFrame.html" title="class in org.eclipse.jetty.websocket.common">WebSocketFrame</a>&nbsp;copy&#8203;(<a href="../api/extensions/Frame.html" title="interface in org.eclipse.jetty.websocket.api.extensions">Frame</a>&nbsp;original)</pre>
</li>
</ul>
<a id="assertValid()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>assertValid</h4>
<pre class="methodSignature">public abstract&nbsp;void&nbsp;assertValid()</pre>
</li>
</ul>
<a id="copyHeaders(org.eclipse.jetty.websocket.api.extensions.Frame)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>copyHeaders</h4>
<pre class="methodSignature">protected&nbsp;void&nbsp;copyHeaders&#8203;(<a href="../api/extensions/Frame.html" title="interface in org.eclipse.jetty.websocket.api.extensions">Frame</a>&nbsp;frame)</pre>
</li>
</ul>
<a id="copyHeaders(org.eclipse.jetty.websocket.common.WebSocketFrame)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>copyHeaders</h4>
<pre class="methodSignature">protected&nbsp;void&nbsp;copyHeaders&#8203;(<a href="WebSocketFrame.html" title="class in org.eclipse.jetty.websocket.common">WebSocketFrame</a>&nbsp;copy)</pre>
</li>
</ul>
<a id="equals(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>equals</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;equals&#8203;(java.lang.Object&nbsp;obj)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>equals</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
<a id="getMask()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMask</h4>
<pre class="methodSignature">public&nbsp;byte[]&nbsp;getMask()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../api/extensions/Frame.html#getMask()">getMask</a></code>&nbsp;in interface&nbsp;<code><a href="../api/extensions/Frame.html" title="interface in org.eclipse.jetty.websocket.api.extensions">Frame</a></code></dd>
</dl>
</li>
</ul>
<a id="getOpCode()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOpCode</h4>
<pre class="methodSignature">public final&nbsp;byte&nbsp;getOpCode()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../api/extensions/Frame.html#getOpCode()">getOpCode</a></code>&nbsp;in interface&nbsp;<code><a href="../api/extensions/Frame.html" title="interface in org.eclipse.jetty.websocket.api.extensions">Frame</a></code></dd>
</dl>
</li>
</ul>
<a id="getPayload()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPayload</h4>
<pre class="methodSignature">public&nbsp;java.nio.ByteBuffer&nbsp;getPayload()</pre>
<div class="block">Get the payload ByteBuffer. possible null.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../api/extensions/Frame.html#getPayload()">getPayload</a></code>&nbsp;in interface&nbsp;<code><a href="../api/extensions/Frame.html" title="interface in org.eclipse.jetty.websocket.api.extensions">Frame</a></code></dd>
</dl>
</li>
</ul>
<a id="getPayloadAsUTF8()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPayloadAsUTF8</h4>
<pre class="methodSignature">public&nbsp;java.lang.String&nbsp;getPayloadAsUTF8()</pre>
</li>
</ul>
<a id="getPayloadLength()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPayloadLength</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;getPayloadLength()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../api/extensions/Frame.html#getPayloadLength()">Frame</a></code></span></div>
<div class="block">The original payload length (<code>Buffer.remaining()</code>)</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../api/extensions/Frame.html#getPayloadLength()">getPayloadLength</a></code>&nbsp;in interface&nbsp;<code><a href="../api/extensions/Frame.html" title="interface in org.eclipse.jetty.websocket.api.extensions">Frame</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the original payload length (<code>Buffer.remaining()</code>)</dd>
</dl>
</li>
</ul>
<a id="getType()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getType</h4>
<pre class="methodSignature">public&nbsp;<a href="../api/extensions/Frame.Type.html" title="enum in org.eclipse.jetty.websocket.api.extensions">Frame.Type</a>&nbsp;getType()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../api/extensions/Frame.html#getType()">getType</a></code>&nbsp;in interface&nbsp;<code><a href="../api/extensions/Frame.html" title="interface in org.eclipse.jetty.websocket.api.extensions">Frame</a></code></dd>
</dl>
</li>
</ul>
<a id="hashCode()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hashCode</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;hashCode()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>hashCode</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
<a id="hasPayload()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasPayload</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;hasPayload()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../api/extensions/Frame.html#hasPayload()">hasPayload</a></code>&nbsp;in interface&nbsp;<code><a href="../api/extensions/Frame.html" title="interface in org.eclipse.jetty.websocket.api.extensions">Frame</a></code></dd>
</dl>
</li>
</ul>
<a id="isControlFrame()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isControlFrame</h4>
<pre class="methodSignature">public abstract&nbsp;boolean&nbsp;isControlFrame()</pre>
</li>
</ul>
<a id="isDataFrame()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isDataFrame</h4>
<pre class="methodSignature">public abstract&nbsp;boolean&nbsp;isDataFrame()</pre>
</li>
</ul>
<a id="isFin()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isFin</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isFin()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../api/extensions/Frame.html#isFin()">isFin</a></code>&nbsp;in interface&nbsp;<code><a href="../api/extensions/Frame.html" title="interface in org.eclipse.jetty.websocket.api.extensions">Frame</a></code></dd>
</dl>
</li>
</ul>
<a id="isLast()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isLast</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isLast()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../api/extensions/Frame.html#isLast()">Frame</a></code></span></div>
<div class="block">Same as <a href="../api/extensions/Frame.html#isFin()"><code>Frame.isFin()</code></a></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../api/extensions/Frame.html#isLast()">isLast</a></code>&nbsp;in interface&nbsp;<code><a href="../api/extensions/Frame.html" title="interface in org.eclipse.jetty.websocket.api.extensions">Frame</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if final frame.</dd>
</dl>
</li>
</ul>
<a id="isMasked()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isMasked</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isMasked()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../api/extensions/Frame.html#isMasked()">isMasked</a></code>&nbsp;in interface&nbsp;<code><a href="../api/extensions/Frame.html" title="interface in org.eclipse.jetty.websocket.api.extensions">Frame</a></code></dd>
</dl>
</li>
</ul>
<a id="isRsv1()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isRsv1</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isRsv1()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../api/extensions/Frame.html#isRsv1()">isRsv1</a></code>&nbsp;in interface&nbsp;<code><a href="../api/extensions/Frame.html" title="interface in org.eclipse.jetty.websocket.api.extensions">Frame</a></code></dd>
</dl>
</li>
</ul>
<a id="isRsv2()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isRsv2</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isRsv2()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../api/extensions/Frame.html#isRsv2()">isRsv2</a></code>&nbsp;in interface&nbsp;<code><a href="../api/extensions/Frame.html" title="interface in org.eclipse.jetty.websocket.api.extensions">Frame</a></code></dd>
</dl>
</li>
</ul>
<a id="isRsv3()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isRsv3</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isRsv3()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../api/extensions/Frame.html#isRsv3()">isRsv3</a></code>&nbsp;in interface&nbsp;<code><a href="../api/extensions/Frame.html" title="interface in org.eclipse.jetty.websocket.api.extensions">Frame</a></code></dd>
</dl>
</li>
</ul>
<a id="reset()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>reset</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;reset()</pre>
</li>
</ul>
<a id="setFin(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setFin</h4>
<pre class="methodSignature">public&nbsp;<a href="WebSocketFrame.html" title="class in org.eclipse.jetty.websocket.common">WebSocketFrame</a>&nbsp;setFin&#8203;(boolean&nbsp;fin)</pre>
</li>
</ul>
<a id="setMask(byte[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMask</h4>
<pre class="methodSignature">public&nbsp;<a href="../api/extensions/Frame.html" title="interface in org.eclipse.jetty.websocket.api.extensions">Frame</a>&nbsp;setMask&#8203;(byte[]&nbsp;maskingKey)</pre>
</li>
</ul>
<a id="setMasked(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMasked</h4>
<pre class="methodSignature">public&nbsp;<a href="../api/extensions/Frame.html" title="interface in org.eclipse.jetty.websocket.api.extensions">Frame</a>&nbsp;setMasked&#8203;(boolean&nbsp;mask)</pre>
</li>
</ul>
<a id="setOpCode(byte)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setOpCode</h4>
<pre class="methodSignature">protected&nbsp;<a href="WebSocketFrame.html" title="class in org.eclipse.jetty.websocket.common">WebSocketFrame</a>&nbsp;setOpCode&#8203;(byte&nbsp;op)</pre>
</li>
</ul>
<a id="setPayload(java.nio.ByteBuffer)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPayload</h4>
<pre class="methodSignature">public&nbsp;<a href="WebSocketFrame.html" title="class in org.eclipse.jetty.websocket.common">WebSocketFrame</a>&nbsp;setPayload&#8203;(java.nio.ByteBuffer&nbsp;buf)</pre>
<div class="block">Set the data payload.
<p>
The provided buffer will be used as is, no copying of bytes performed.
<p>
The provided buffer should be flipped and ready to READ from.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>buf</code> - the bytebuffer to set</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the frame itself</dd>
</dl>
</li>
</ul>
<a id="setRsv1(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setRsv1</h4>
<pre class="methodSignature">public&nbsp;<a href="WebSocketFrame.html" title="class in org.eclipse.jetty.websocket.common">WebSocketFrame</a>&nbsp;setRsv1&#8203;(boolean&nbsp;rsv1)</pre>
</li>
</ul>
<a id="setRsv2(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setRsv2</h4>
<pre class="methodSignature">public&nbsp;<a href="WebSocketFrame.html" title="class in org.eclipse.jetty.websocket.common">WebSocketFrame</a>&nbsp;setRsv2&#8203;(boolean&nbsp;rsv2)</pre>
</li>
</ul>
<a id="setRsv3(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setRsv3</h4>
<pre class="methodSignature">public&nbsp;<a href="WebSocketFrame.html" title="class in org.eclipse.jetty.websocket.common">WebSocketFrame</a>&nbsp;setRsv3&#8203;(boolean&nbsp;rsv3)</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/WebSocketFrame.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><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&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><a href="#field.detail">Field</a>&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>