| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.11) on Mon Jun 14 16:40:44 EDT 2021 --> |
| <title>CloseStatus (Eclipse Jetty API Doc - v10.0.5)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2021-06-14"> |
| <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="CloseStatus (Eclipse Jetty API Doc - v10.0.5)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":10,"i1":9,"i2":9,"i3":10,"i4":9,"i5":10,"i6":10,"i7":10,"i8":10,"i9":9,"i10":9,"i11":10,"i12":9,"i13":9,"i14":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/CloseStatus.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><a href="#nested.class.summary">Nested</a> | </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 CloseStatus" class="title">Class CloseStatus</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.eclipse.jetty.websocket.core.CloseStatus</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <pre>public class <span class="typeNameLabel">CloseStatus</span> |
| extends java.lang.Object</pre> |
| <div class="block">Representation of a WebSocket Close (status code & reason)</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> |
| <table class="memberSummary"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Class</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static interface </code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="CloseStatus.Supplier.html" title="interface in org.eclipse.jetty.websocket.core">CloseStatus.Supplier</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| </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"> </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>static int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#BAD_DATA">BAD_DATA</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#BAD_GATEWAY">BAD_GATEWAY</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="#BAD_PAYLOAD">BAD_PAYLOAD</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#EXTENSION_ERROR">EXTENSION_ERROR</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="#FAILED_TLS_HANDSHAKE">FAILED_TLS_HANDSHAKE</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#MESSAGE_TOO_LARGE">MESSAGE_TOO_LARGE</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="#NO_CLOSE">NO_CLOSE</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="CloseStatus.html" title="class in org.eclipse.jetty.websocket.core">CloseStatus</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#NO_CLOSE_STATUS">NO_CLOSE_STATUS</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="#NO_CODE">NO_CODE</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="CloseStatus.html" title="class in org.eclipse.jetty.websocket.core">CloseStatus</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#NO_CODE_STATUS">NO_CODE_STATUS</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="#NORMAL">NORMAL</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="CloseStatus.html" title="class in org.eclipse.jetty.websocket.core">CloseStatus</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#NORMAL_STATUS">NORMAL_STATUS</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="#POLICY_VIOLATION">POLICY_VIOLATION</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#PROTOCOL">PROTOCOL</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="#RESERVED">RESERVED</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#SERVER_ERROR">SERVER_ERROR</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="#SERVICE_RESTART">SERVICE_RESTART</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#SHUTDOWN">SHUTDOWN</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="#TRY_AGAIN_LATER">TRY_AGAIN_LATER</a></span></code></th> |
| <td class="colLast"> </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">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()">CloseStatus</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a reason for closing a web socket connection with the no given status code.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(int)">CloseStatus</a></span>​(int statusCode)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a reason for closing a web socket connection with the given status code and no reason phrase.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(int,java.lang.String)">CloseStatus</a></span>​(int statusCode, |
| java.lang.String reasonPhrase)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a reason for closing a web socket connection with the given status code and reason phrase.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(int,java.lang.String,java.lang.Throwable)">CloseStatus</a></span>​(int statusCode, |
| java.lang.String reasonPhrase, |
| java.lang.Throwable cause)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a reason for closing a web socket connection with the given status code and reason phrase.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(int,java.lang.Throwable)">CloseStatus</a></span>​(int statusCode, |
| java.lang.Throwable cause)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a reason for closing a web socket connection with the given status code and reason phrase.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.nio.ByteBuffer)">CloseStatus</a></span>​(java.nio.ByteBuffer payload)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.eclipse.jetty.websocket.core.Frame)">CloseStatus</a></span>​(<a href="Frame.html" title="class in org.eclipse.jetty.websocket.core">Frame</a> frame)</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>java.nio.ByteBuffer</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#asPayloadBuffer()">asPayloadBuffer</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>static java.nio.ByteBuffer</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#asPayloadBuffer(int,java.lang.String)">asPayloadBuffer</a></span>​(int statusCode, |
| java.lang.String reason)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>static java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#codeString(int)">codeString</a></span>​(int closeStatus)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>java.lang.Throwable</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCause()">getCause</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>static <a href="CloseStatus.html" title="class in org.eclipse.jetty.websocket.core">CloseStatus</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCloseStatus(org.eclipse.jetty.websocket.core.Frame)">getCloseStatus</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="i5" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCode()">getCode</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getReason()">getReason</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isAbnormal()">isAbnormal</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isNormal()">isNormal</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isOrdinary(int)">isOrdinary</a></span>​(int closeCode)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isTransmittableStatusCode(int)">isTransmittableStatusCode</a></span>​(int statusCode)</code></th> |
| <td class="colLast"> |
| <div class="block">Test if provided status code can be sent/received on a WebSocket close.</div> |
| </td> |
| </tr> |
| <tr id="i11" 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="#toFrame()">toFrame</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <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="#toFrame(int)">toFrame</a></span>​(int closeStatus)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i13" 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="#toFrame(int,java.lang.String)">toFrame</a></span>​(int closeStatus, |
| java.lang.String reason)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i14" 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"> </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, 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"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a id="NORMAL"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>NORMAL</h4> |
| <pre>public static final int NORMAL</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.eclipse.jetty.websocket.core.CloseStatus.NORMAL">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="SHUTDOWN"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SHUTDOWN</h4> |
| <pre>public static final int SHUTDOWN</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.eclipse.jetty.websocket.core.CloseStatus.SHUTDOWN">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="PROTOCOL"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>PROTOCOL</h4> |
| <pre>public static final int PROTOCOL</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.eclipse.jetty.websocket.core.CloseStatus.PROTOCOL">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="BAD_DATA"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>BAD_DATA</h4> |
| <pre>public static final int BAD_DATA</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.eclipse.jetty.websocket.core.CloseStatus.BAD_DATA">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="RESERVED"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>RESERVED</h4> |
| <pre>public static final int RESERVED</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.eclipse.jetty.websocket.core.CloseStatus.RESERVED">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="NO_CODE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>NO_CODE</h4> |
| <pre>public static final int NO_CODE</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.eclipse.jetty.websocket.core.CloseStatus.NO_CODE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="NO_CLOSE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>NO_CLOSE</h4> |
| <pre>public static final int NO_CLOSE</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.eclipse.jetty.websocket.core.CloseStatus.NO_CLOSE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="BAD_PAYLOAD"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>BAD_PAYLOAD</h4> |
| <pre>public static final int BAD_PAYLOAD</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.eclipse.jetty.websocket.core.CloseStatus.BAD_PAYLOAD">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="POLICY_VIOLATION"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>POLICY_VIOLATION</h4> |
| <pre>public static final int POLICY_VIOLATION</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.eclipse.jetty.websocket.core.CloseStatus.POLICY_VIOLATION">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="MESSAGE_TOO_LARGE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>MESSAGE_TOO_LARGE</h4> |
| <pre>public static final int MESSAGE_TOO_LARGE</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.eclipse.jetty.websocket.core.CloseStatus.MESSAGE_TOO_LARGE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="EXTENSION_ERROR"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>EXTENSION_ERROR</h4> |
| <pre>public static final int EXTENSION_ERROR</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.eclipse.jetty.websocket.core.CloseStatus.EXTENSION_ERROR">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="SERVER_ERROR"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SERVER_ERROR</h4> |
| <pre>public static final int SERVER_ERROR</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.eclipse.jetty.websocket.core.CloseStatus.SERVER_ERROR">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="SERVICE_RESTART"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SERVICE_RESTART</h4> |
| <pre>public static final int SERVICE_RESTART</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.eclipse.jetty.websocket.core.CloseStatus.SERVICE_RESTART">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="TRY_AGAIN_LATER"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>TRY_AGAIN_LATER</h4> |
| <pre>public static final int TRY_AGAIN_LATER</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.eclipse.jetty.websocket.core.CloseStatus.TRY_AGAIN_LATER">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="BAD_GATEWAY"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>BAD_GATEWAY</h4> |
| <pre>public static final int BAD_GATEWAY</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.eclipse.jetty.websocket.core.CloseStatus.BAD_GATEWAY">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="FAILED_TLS_HANDSHAKE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>FAILED_TLS_HANDSHAKE</h4> |
| <pre>public static final int FAILED_TLS_HANDSHAKE</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.eclipse.jetty.websocket.core.CloseStatus.FAILED_TLS_HANDSHAKE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="NO_CODE_STATUS"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>NO_CODE_STATUS</h4> |
| <pre>public static final <a href="CloseStatus.html" title="class in org.eclipse.jetty.websocket.core">CloseStatus</a> NO_CODE_STATUS</pre> |
| </li> |
| </ul> |
| <a id="NO_CLOSE_STATUS"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>NO_CLOSE_STATUS</h4> |
| <pre>public static final <a href="CloseStatus.html" title="class in org.eclipse.jetty.websocket.core">CloseStatus</a> NO_CLOSE_STATUS</pre> |
| </li> |
| </ul> |
| <a id="NORMAL_STATUS"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>NORMAL_STATUS</h4> |
| <pre>public static final <a href="CloseStatus.html" title="class in org.eclipse.jetty.websocket.core">CloseStatus</a> NORMAL_STATUS</pre> |
| </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>()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>CloseStatus</h4> |
| <pre>public CloseStatus()</pre> |
| <div class="block">Creates a reason for closing a web socket connection with the no given status code.</div> |
| </li> |
| </ul> |
| <a id="<init>(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>CloseStatus</h4> |
| <pre>public CloseStatus​(int statusCode)</pre> |
| <div class="block">Creates a reason for closing a web socket connection with the given status code and no reason phrase.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>statusCode</code> - the close code</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="<init>(int,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>CloseStatus</h4> |
| <pre>public CloseStatus​(int statusCode, |
| java.lang.String reasonPhrase)</pre> |
| <div class="block">Creates a reason for closing a web socket connection with the given status code and reason phrase.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>statusCode</code> - the close code</dd> |
| <dd><code>reasonPhrase</code> - the reason phrase</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="<init>(int,java.lang.Throwable)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>CloseStatus</h4> |
| <pre>public CloseStatus​(int statusCode, |
| java.lang.Throwable cause)</pre> |
| <div class="block">Creates a reason for closing a web socket connection with the given status code and reason phrase.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>statusCode</code> - the close code</dd> |
| <dd><code>cause</code> - the error which caused the close</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="<init>(int,java.lang.String,java.lang.Throwable)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>CloseStatus</h4> |
| <pre>public CloseStatus​(int statusCode, |
| java.lang.String reasonPhrase, |
| java.lang.Throwable cause)</pre> |
| <div class="block">Creates a reason for closing a web socket connection with the given status code and reason phrase.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>statusCode</code> - the close code</dd> |
| <dd><code>reasonPhrase</code> - the reason phrase</dd> |
| <dd><code>cause</code> - the error which caused the close</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="<init>(org.eclipse.jetty.websocket.core.Frame)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>CloseStatus</h4> |
| <pre>public CloseStatus​(<a href="Frame.html" title="class in org.eclipse.jetty.websocket.core">Frame</a> frame)</pre> |
| </li> |
| </ul> |
| <a id="<init>(java.nio.ByteBuffer)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>CloseStatus</h4> |
| <pre>public CloseStatus​(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="getCloseStatus(org.eclipse.jetty.websocket.core.Frame)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCloseStatus</h4> |
| <pre class="methodSignature">public static <a href="CloseStatus.html" title="class in org.eclipse.jetty.websocket.core">CloseStatus</a> getCloseStatus​(<a href="Frame.html" title="class in org.eclipse.jetty.websocket.core">Frame</a> frame)</pre> |
| </li> |
| </ul> |
| <a id="isOrdinary(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isOrdinary</h4> |
| <pre class="methodSignature">public static boolean isOrdinary​(int closeCode)</pre> |
| </li> |
| </ul> |
| <a id="isAbnormal()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isAbnormal</h4> |
| <pre class="methodSignature">public boolean isAbnormal()</pre> |
| </li> |
| </ul> |
| <a id="getCause()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCause</h4> |
| <pre class="methodSignature">public java.lang.Throwable getCause()</pre> |
| </li> |
| </ul> |
| <a id="getCode()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCode</h4> |
| <pre class="methodSignature">public int getCode()</pre> |
| </li> |
| </ul> |
| <a id="getReason()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getReason</h4> |
| <pre class="methodSignature">public java.lang.String getReason()</pre> |
| </li> |
| </ul> |
| <a id="asPayloadBuffer()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>asPayloadBuffer</h4> |
| <pre class="methodSignature">public java.nio.ByteBuffer asPayloadBuffer()</pre> |
| </li> |
| </ul> |
| <a id="asPayloadBuffer(int,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>asPayloadBuffer</h4> |
| <pre class="methodSignature">public static java.nio.ByteBuffer asPayloadBuffer​(int statusCode, |
| java.lang.String reason)</pre> |
| </li> |
| </ul> |
| <a id="isTransmittableStatusCode(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isTransmittableStatusCode</h4> |
| <pre class="methodSignature">public static boolean isTransmittableStatusCode​(int statusCode)</pre> |
| <div class="block">Test if provided status code can be sent/received on a WebSocket close. |
| <p> |
| This honors the RFC6455 rules and IANA rules. |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>statusCode</code> - the statusCode to test</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if transmittable</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="toFrame()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toFrame</h4> |
| <pre class="methodSignature">public <a href="Frame.html" title="class in org.eclipse.jetty.websocket.core">Frame</a> toFrame()</pre> |
| </li> |
| </ul> |
| <a id="toFrame(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toFrame</h4> |
| <pre class="methodSignature">public static <a href="Frame.html" title="class in org.eclipse.jetty.websocket.core">Frame</a> toFrame​(int closeStatus)</pre> |
| </li> |
| </ul> |
| <a id="toFrame(int,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toFrame</h4> |
| <pre class="methodSignature">public static <a href="Frame.html" title="class in org.eclipse.jetty.websocket.core">Frame</a> toFrame​(int closeStatus, |
| java.lang.String reason)</pre> |
| </li> |
| </ul> |
| <a id="codeString(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>codeString</h4> |
| <pre class="methodSignature">public static java.lang.String codeString​(int closeStatus)</pre> |
| </li> |
| </ul> |
| <a id="isNormal()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isNormal</h4> |
| <pre class="methodSignature">public boolean isNormal()</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/CloseStatus.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><a href="#nested.class.summary">Nested</a> | </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> |
