| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.10) on Tue Mar 30 10:45:41 CDT 2021 --> |
| <title>Frame (Eclipse Jetty API Doc - v10.0.2)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2021-03-30"> |
| <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="Frame (Eclipse Jetty API Doc - v10.0.2)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":10,"i1":9,"i2":10,"i3":9,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"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,"i31":10}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static 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 = true; |
| 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/Frame.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 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: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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"> </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> <a href="package-summary.html">org.eclipse.jetty.websocket.core</a></div> |
| <h2 title="Class Frame" class="title">Class Frame</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.eclipse.jetty.websocket.core.Frame</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><code><a href="internal/Parser.ParsedFrame.html" title="class in org.eclipse.jetty.websocket.core.internal">Parser.ParsedFrame</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public class <span class="typeNameLabel">Frame</span> |
| extends java.lang.Object</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"> |
| <!-- =========== 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"> </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 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="rowColor"> |
| <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"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#MAX_CONTROL_PAYLOAD">MAX_CONTROL_PAYLOAD</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Maximum size of Control frame, per RFC 6455</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected java.nio.ByteBuffer</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#payload">payload</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">The payload data.</div> |
| </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"> </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()">Frame</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code> </code></td> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(byte)">Frame</a></span>​(byte opcode)</code></th> |
| <td class="colLast"> |
| <div class="block">Construct form opcode</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code> </code></td> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(byte,boolean,java.lang.String)">Frame</a></span>​(byte opCode, |
| boolean fin, |
| java.lang.String payload)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code> </code></td> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(byte,boolean,java.nio.ByteBuffer)">Frame</a></span>​(byte opCode, |
| boolean fin, |
| java.nio.ByteBuffer payload)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code> </code></td> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(byte,byte%5B%5D,java.nio.ByteBuffer)">Frame</a></span>​(byte finRsvOp, |
| byte[] mask, |
| java.nio.ByteBuffer payload)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code> </code></td> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(byte,java.lang.String)">Frame</a></span>​(byte opCode, |
| java.lang.String payload)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code> </code></td> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(byte,java.nio.ByteBuffer)">Frame</a></span>​(byte opCode, |
| java.nio.ByteBuffer payload)</code></th> |
| <td class="colLast"> </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"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </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><a href="Frame.html" title="class in org.eclipse.jetty.websocket.core">Frame</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#asReadOnly()">asReadOnly</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>static <a href="Frame.html" title="class in org.eclipse.jetty.websocket.core">Frame</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#copy(org.eclipse.jetty.websocket.core.Frame)">copy</a></span>​(<a href="Frame.html" title="class in org.eclipse.jetty.websocket.core">Frame</a> original)</code></th> |
| <td class="colLast"> </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.core.Frame)">copyHeaders</a></span>​(<a href="Frame.html" title="class in org.eclipse.jetty.websocket.core">Frame</a> frame)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>static <a href="Frame.html" title="class in org.eclipse.jetty.websocket.core">Frame</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#copyWithoutPayload(org.eclipse.jetty.websocket.core.Frame)">copyWithoutPayload</a></span>​(<a href="Frame.html" title="class in org.eclipse.jetty.websocket.core">Frame</a> original)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#demask()">demask</a></span>()</code></th> |
| <td class="colLast"> </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="#equals(java.lang.Object)">equals</a></span>​(java.lang.Object obj)</code></th> |
| <td class="colLast"> </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="#getMask()">getMask</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <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"> </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <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="i9" class="rowColor"> |
| <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"> |
| <div class="block">Get the payload of the frame as a UTF-8 string.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <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"> </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"> </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"> </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hasRsv()">hasRsv</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isControlFrame()">isControlFrame</a></span>()</code></th> |
| <td class="colLast"> </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="#isDataFrame()">isDataFrame</a></span>()</code></th> |
| <td class="colLast"> </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="#isFin()">isFin</a></span>()</code></th> |
| <td class="colLast"> </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"> </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"> </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"> </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"> </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"> </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code><a href="Frame.html" title="class in org.eclipse.jetty.websocket.core">Frame</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setFin(boolean)">setFin</a></span>​(boolean fin)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code><a href="Frame.html" title="class in org.eclipse.jetty.websocket.core">Frame</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setMask(byte%5B%5D)">setMask</a></span>​(byte[] maskingKey)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code>protected <a href="Frame.html" title="class in org.eclipse.jetty.websocket.core">Frame</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setOpCode(byte)">setOpCode</a></span>​(byte op)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><code><a href="Frame.html" title="class in org.eclipse.jetty.websocket.core">Frame</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setPayload(byte%5B%5D)">setPayload</a></span>​(byte[] buf)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i26" class="altColor"> |
| <td class="colFirst"><code><a href="Frame.html" title="class in org.eclipse.jetty.websocket.core">Frame</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setPayload(java.lang.String)">setPayload</a></span>​(java.lang.String str)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i27" class="rowColor"> |
| <td class="colFirst"><code><a href="Frame.html" title="class in org.eclipse.jetty.websocket.core">Frame</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setPayload(java.nio.ByteBuffer)">setPayload</a></span>​(java.nio.ByteBuffer buf)</code></th> |
| <td class="colLast"> |
| <div class="block">Set the data payload.</div> |
| </td> |
| </tr> |
| <tr id="i28" class="altColor"> |
| <td class="colFirst"><code><a href="Frame.html" title="class in org.eclipse.jetty.websocket.core">Frame</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setRsv1(boolean)">setRsv1</a></span>​(boolean rsv1)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i29" class="rowColor"> |
| <td class="colFirst"><code><a href="Frame.html" title="class in org.eclipse.jetty.websocket.core">Frame</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setRsv2(boolean)">setRsv2</a></span>​(boolean rsv2)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i30" class="altColor"> |
| <td class="colFirst"><code><a href="Frame.html" title="class in org.eclipse.jetty.websocket.core">Frame</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setRsv3(boolean)">setRsv3</a></span>​(boolean rsv3)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i31" 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"> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class 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="MAX_CONTROL_PAYLOAD"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>MAX_CONTROL_PAYLOAD</h4> |
| <pre>public static final int MAX_CONTROL_PAYLOAD</pre> |
| <div class="block">Maximum size of Control frame, per RFC 6455</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.eclipse.jetty.websocket.core.Frame.MAX_CONTROL_PAYLOAD">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="finRsvOp"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>finRsvOp</h4> |
| <pre>protected 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="mask"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>mask</h4> |
| <pre>protected byte[] mask</pre> |
| </li> |
| </ul> |
| <a id="payload"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>payload</h4> |
| <pre>protected java.nio.ByteBuffer payload</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="<init>(byte)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>Frame</h4> |
| <pre>public Frame​(byte 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> |
| <a id="<init>(byte,java.nio.ByteBuffer)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>Frame</h4> |
| <pre>public Frame​(byte opCode, |
| java.nio.ByteBuffer payload)</pre> |
| </li> |
| </ul> |
| <a id="<init>(byte,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>Frame</h4> |
| <pre>public Frame​(byte opCode, |
| java.lang.String payload)</pre> |
| </li> |
| </ul> |
| <a id="<init>(byte,boolean,java.nio.ByteBuffer)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>Frame</h4> |
| <pre>public Frame​(byte opCode, |
| boolean fin, |
| java.nio.ByteBuffer payload)</pre> |
| </li> |
| </ul> |
| <a id="<init>(byte,boolean,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>Frame</h4> |
| <pre>public Frame​(byte opCode, |
| boolean fin, |
| java.lang.String payload)</pre> |
| </li> |
| </ul> |
| <a id="<init>()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>Frame</h4> |
| <pre>protected Frame()</pre> |
| </li> |
| </ul> |
| <a id="<init>(byte,byte[],java.nio.ByteBuffer)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>Frame</h4> |
| <pre>public Frame​(byte finRsvOp, |
| byte[] mask, |
| java.nio.ByteBuffer payload)</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="copyWithoutPayload(org.eclipse.jetty.websocket.core.Frame)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>copyWithoutPayload</h4> |
| <pre class="methodSignature">public static <a href="Frame.html" title="class in org.eclipse.jetty.websocket.core">Frame</a> copyWithoutPayload​(<a href="Frame.html" title="class in org.eclipse.jetty.websocket.core">Frame</a> original)</pre> |
| </li> |
| </ul> |
| <a id="copy(org.eclipse.jetty.websocket.core.Frame)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>copy</h4> |
| <pre class="methodSignature">public static <a href="Frame.html" title="class in org.eclipse.jetty.websocket.core">Frame</a> copy​(<a href="Frame.html" title="class in org.eclipse.jetty.websocket.core">Frame</a> original)</pre> |
| </li> |
| </ul> |
| <a id="isControlFrame()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isControlFrame</h4> |
| <pre class="methodSignature">public boolean isControlFrame()</pre> |
| </li> |
| </ul> |
| <a id="isDataFrame()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isDataFrame</h4> |
| <pre class="methodSignature">public boolean isDataFrame()</pre> |
| </li> |
| </ul> |
| <a id="copyHeaders(org.eclipse.jetty.websocket.core.Frame)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>copyHeaders</h4> |
| <pre class="methodSignature">protected void copyHeaders​(<a href="Frame.html" title="class in org.eclipse.jetty.websocket.core">Frame</a> frame)</pre> |
| </li> |
| </ul> |
| <a id="equals(java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>equals</h4> |
| <pre class="methodSignature">public boolean equals​(java.lang.Object obj)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code>equals</code> in class <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 byte[] getMask()</pre> |
| </li> |
| </ul> |
| <a id="getOpCode()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOpCode</h4> |
| <pre class="methodSignature">public byte getOpCode()</pre> |
| </li> |
| </ul> |
| <a id="getPayload()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPayload</h4> |
| <pre class="methodSignature">public java.nio.ByteBuffer getPayload()</pre> |
| <div class="block">Get the payload ByteBuffer.</div> |
| </li> |
| </ul> |
| <a id="getPayloadAsUTF8()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPayloadAsUTF8</h4> |
| <pre class="methodSignature">public java.lang.String getPayloadAsUTF8()</pre> |
| <div class="block">Get the payload of the frame as a UTF-8 string. |
| <p>Should only be used in testing, does not validate the |
| UTF-8 and a non fin frame can contain partial UTF-8 characters.</p></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the payload as a UTF-8 string.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getPayloadLength()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPayloadLength</h4> |
| <pre class="methodSignature">public int getPayloadLength()</pre> |
| </li> |
| </ul> |
| <a id="hashCode()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hashCode</h4> |
| <pre class="methodSignature">public int hashCode()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code>hashCode</code> in class <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 boolean hasPayload()</pre> |
| </li> |
| </ul> |
| <a id="isFin()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isFin</h4> |
| <pre class="methodSignature">public boolean isFin()</pre> |
| </li> |
| </ul> |
| <a id="isMasked()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isMasked</h4> |
| <pre class="methodSignature">public boolean isMasked()</pre> |
| </li> |
| </ul> |
| <a id="isRsv1()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isRsv1</h4> |
| <pre class="methodSignature">public boolean isRsv1()</pre> |
| </li> |
| </ul> |
| <a id="isRsv2()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isRsv2</h4> |
| <pre class="methodSignature">public boolean isRsv2()</pre> |
| </li> |
| </ul> |
| <a id="isRsv3()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isRsv3</h4> |
| <pre class="methodSignature">public boolean isRsv3()</pre> |
| </li> |
| </ul> |
| <a id="reset()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>reset</h4> |
| <pre class="methodSignature">public void reset()</pre> |
| </li> |
| </ul> |
| <a id="setFin(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setFin</h4> |
| <pre class="methodSignature">public <a href="Frame.html" title="class in org.eclipse.jetty.websocket.core">Frame</a> setFin​(boolean fin)</pre> |
| </li> |
| </ul> |
| <a id="setMask(byte[])"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setMask</h4> |
| <pre class="methodSignature">public <a href="Frame.html" title="class in org.eclipse.jetty.websocket.core">Frame</a> setMask​(byte[] maskingKey)</pre> |
| </li> |
| </ul> |
| <a id="setOpCode(byte)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setOpCode</h4> |
| <pre class="methodSignature">protected <a href="Frame.html" title="class in org.eclipse.jetty.websocket.core">Frame</a> setOpCode​(byte op)</pre> |
| </li> |
| </ul> |
| <a id="setPayload(java.nio.ByteBuffer)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPayload</h4> |
| <pre class="methodSignature">public <a href="Frame.html" title="class in org.eclipse.jetty.websocket.core">Frame</a> setPayload​(java.nio.ByteBuffer 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="setPayload(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPayload</h4> |
| <pre class="methodSignature">public <a href="Frame.html" title="class in org.eclipse.jetty.websocket.core">Frame</a> setPayload​(java.lang.String str)</pre> |
| </li> |
| </ul> |
| <a id="setPayload(byte[])"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPayload</h4> |
| <pre class="methodSignature">public <a href="Frame.html" title="class in org.eclipse.jetty.websocket.core">Frame</a> setPayload​(byte[] buf)</pre> |
| </li> |
| </ul> |
| <a id="setRsv1(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setRsv1</h4> |
| <pre class="methodSignature">public <a href="Frame.html" title="class in org.eclipse.jetty.websocket.core">Frame</a> setRsv1​(boolean rsv1)</pre> |
| </li> |
| </ul> |
| <a id="setRsv2(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setRsv2</h4> |
| <pre class="methodSignature">public <a href="Frame.html" title="class in org.eclipse.jetty.websocket.core">Frame</a> setRsv2​(boolean rsv2)</pre> |
| </li> |
| </ul> |
| <a id="setRsv3(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setRsv3</h4> |
| <pre class="methodSignature">public <a href="Frame.html" title="class in org.eclipse.jetty.websocket.core">Frame</a> setRsv3​(boolean rsv3)</pre> |
| </li> |
| </ul> |
| <a id="asReadOnly()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>asReadOnly</h4> |
| <pre class="methodSignature">public <a href="Frame.html" title="class in org.eclipse.jetty.websocket.core">Frame</a> asReadOnly()</pre> |
| </li> |
| </ul> |
| <a id="hasRsv()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasRsv</h4> |
| <pre class="methodSignature">public boolean hasRsv()</pre> |
| </li> |
| </ul> |
| <a id="demask()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>demask</h4> |
| <pre class="methodSignature">public void demask()</pre> |
| </li> |
| </ul> |
| <a id="toString()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>toString</h4> |
| <pre class="methodSignature">public java.lang.String toString()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code>toString</code> in class <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/Frame.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 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: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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 © 1995–2021 <a href="https://webtide.com">Webtide</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |