blob: 0afc5931af09d0c4ef70a2141e2f3af70594e9fe [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.11) on Mon Jun 14 16:40:44 EDT 2021 -->
<title>StatusCode (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="StatusCode (Eclipse Jetty API Doc - v10.0.5)";
}
}
catch(err) {
}
//-->
var data = {"i0":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static 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/StatusCode.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><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.api</a></div>
<h2 title="Class StatusCode" class="title">Class StatusCode</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.eclipse.jetty.websocket.api.StatusCode</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<pre>public final class <span class="typeNameLabel">StatusCode</span>
extends java.lang.Object</pre>
<div class="block">The <a href="https://tools.ietf.org/html/rfc6455#section-7.4">RFC 6455 specified status codes</a> and <a href="https://www.iana.org/assignments/websocket/websocket.xml#close-code-number-rules">IANA: WebSocket Close Code Number Registry</a></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">&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>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#ABNORMAL">ABNORMAL</a></span></code></th>
<td class="colLast">
<div class="block">Abnormal Close is a synonym for <a href="#NO_CLOSE"><code>NO_CLOSE</code></a>, used to indicate a close
condition where no close frame was processed from the remote side.</div>
</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_DATA">BAD_DATA</a></span></code></th>
<td class="colLast">
<div class="block">1003 indicates that an endpoint is terminating the connection because it has received a type of data it cannot accept (e.g., an endpoint that understands
only text data MAY send this if it receives a binary message).</div>
</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">
<div class="block">1007 indicates that an endpoint is terminating the connection because it has received data within a message that was not consistent with the type of the
message (e.g., non-UTF-8 [<a href="https://tools.ietf.org/html/rfc3629">RFC3629</a>] data within a text message).</div>
</td>
</tr>
<tr class="rowColor">
<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">
<div class="block">1015 is a reserved value and MUST NOT be set as a status code in a Close control frame by an endpoint.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#INVALID_UPSTREAM_RESPONSE">INVALID_UPSTREAM_RESPONSE</a></span></code></th>
<td class="colLast">
<div class="block">1014 indicates that a gateway or proxy received and invalid upstream response.</div>
</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">
<div class="block">1009 indicates that an endpoint is terminating the connection because it has received a message that is too big for it to process.</div>
</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">
<div class="block">1006 is a reserved value and MUST NOT be set as a status code in a Close control frame by an endpoint.</div>
</td>
</tr>
<tr class="rowColor">
<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">
<div class="block">1005 is a reserved value and MUST NOT be set as a status code in a Close control frame by an endpoint.</div>
</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">
<div class="block">1000 indicates a normal closure, meaning that the purpose for which the connection was established has been fulfilled.</div>
</td>
</tr>
<tr class="rowColor">
<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">
<div class="block">1008 indicates that an endpoint is terminating the connection because it has received a message that violates its policy.</div>
</td>
</tr>
<tr class="altColor">
<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">
<div class="block">1002 indicates that an endpoint is terminating the connection due to a protocol error.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#REQUIRED_EXTENSION">REQUIRED_EXTENSION</a></span></code></th>
<td class="colLast">
<div class="block">1010 indicates that an endpoint (client) is terminating the connection because it has expected the server to negotiate one or more extension, but the
server didn't return them in the response message of the WebSocket handshake.</div>
</td>
</tr>
<tr class="altColor">
<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">
<div class="block">1011 indicates that a server is terminating the connection because it encountered an unexpected condition that prevented it from fulfilling the request.</div>
</td>
</tr>
<tr class="rowColor">
<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">
<div class="block">1012 indicates that the service is restarted.</div>
</td>
</tr>
<tr class="altColor">
<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">
<div class="block">1001 indicates that an endpoint is "going away", such as a server going down or a browser having navigated away from a page.</div>
</td>
</tr>
<tr class="rowColor">
<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">
<div class="block">1013 indicates that the service is experiencing overload.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#UNDEFINED">UNDEFINED</a></span></code></th>
<td class="colLast">
<div class="block">Reserved.</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">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">StatusCode</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static 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>static boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isTransmittable(int)">isTransmittable</a></span>&#8203;(int&nbsp;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>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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&nbsp;int NORMAL</pre>
<div class="block">1000 indicates a normal closure, meaning that the purpose for which the connection was established has been fulfilled.
<p>
See <a href="https://tools.ietf.org/html/rfc6455#section-7.4.1">RFC 6455, Section 7.4.1 Defined Status Codes</a>.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.eclipse.jetty.websocket.api.StatusCode.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&nbsp;int SHUTDOWN</pre>
<div class="block">1001 indicates that an endpoint is "going away", such as a server going down or a browser having navigated away from a page.
<p>
See <a href="https://tools.ietf.org/html/rfc6455#section-7.4.1">RFC 6455, Section 7.4.1 Defined Status Codes</a>.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.eclipse.jetty.websocket.api.StatusCode.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&nbsp;int PROTOCOL</pre>
<div class="block">1002 indicates that an endpoint is terminating the connection due to a protocol error.
<p>
See <a href="https://tools.ietf.org/html/rfc6455#section-7.4.1">RFC 6455, Section 7.4.1 Defined Status Codes</a>.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.eclipse.jetty.websocket.api.StatusCode.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&nbsp;int BAD_DATA</pre>
<div class="block">1003 indicates that an endpoint is terminating the connection because it has received a type of data it cannot accept (e.g., an endpoint that understands
only text data MAY send this if it receives a binary message).
<p>
See <a href="https://tools.ietf.org/html/rfc6455#section-7.4.1">RFC 6455, Section 7.4.1 Defined Status Codes</a>.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.eclipse.jetty.websocket.api.StatusCode.BAD_DATA">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="UNDEFINED">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>UNDEFINED</h4>
<pre>public static final&nbsp;int UNDEFINED</pre>
<div class="block">Reserved. The specific meaning might be defined in the future.
<p>
See <a href="https://tools.ietf.org/html/rfc6455#section-7.4.1">RFC 6455, Section 7.4.1 Defined Status Codes</a>.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.eclipse.jetty.websocket.api.StatusCode.UNDEFINED">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&nbsp;int NO_CODE</pre>
<div class="block">1005 is a reserved value and MUST NOT be set as a status code in a Close control frame by an endpoint. It is designated for use in applications expecting
a status code to indicate that no status code was actually present.
<p>
See <a href="https://tools.ietf.org/html/rfc6455#section-7.4.1">RFC 6455, Section 7.4.1 Defined Status Codes</a>.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.eclipse.jetty.websocket.api.StatusCode.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&nbsp;int NO_CLOSE</pre>
<div class="block">1006 is a reserved value and MUST NOT be set as a status code in a Close control frame by an endpoint. It is designated for use in applications expecting
a status code to indicate that the connection was closed abnormally, e.g., without sending or receiving a Close control frame.
<p>
See <a href="https://tools.ietf.org/html/rfc6455#section-7.4.1">RFC 6455, Section 7.4.1 Defined Status Codes</a>.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.eclipse.jetty.websocket.api.StatusCode.NO_CLOSE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="ABNORMAL">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ABNORMAL</h4>
<pre>public static final&nbsp;int ABNORMAL</pre>
<div class="block">Abnormal Close is a synonym for <a href="#NO_CLOSE"><code>NO_CLOSE</code></a>, used to indicate a close
condition where no close frame was processed from the remote side.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.eclipse.jetty.websocket.api.StatusCode.ABNORMAL">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&nbsp;int BAD_PAYLOAD</pre>
<div class="block">1007 indicates that an endpoint is terminating the connection because it has received data within a message that was not consistent with the type of the
message (e.g., non-UTF-8 [<a href="https://tools.ietf.org/html/rfc3629">RFC3629</a>] data within a text message).
<p>
See <a href="https://tools.ietf.org/html/rfc6455#section-7.4.1">RFC 6455, Section 7.4.1 Defined Status Codes</a>.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.eclipse.jetty.websocket.api.StatusCode.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&nbsp;int POLICY_VIOLATION</pre>
<div class="block">1008 indicates that an endpoint is terminating the connection because it has received a message that violates its policy. This is a generic status code
that can be returned when there is no other more suitable status code (e.g., 1003 or 1009) or if there is a need to hide specific details about the
policy.
<p>
See <a href="https://tools.ietf.org/html/rfc6455#section-7.4.1">RFC 6455, Section 7.4.1 Defined Status Codes</a>.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.eclipse.jetty.websocket.api.StatusCode.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&nbsp;int MESSAGE_TOO_LARGE</pre>
<div class="block">1009 indicates that an endpoint is terminating the connection because it has received a message that is too big for it to process.
<p>
See <a href="https://tools.ietf.org/html/rfc6455#section-7.4.1">RFC 6455, Section 7.4.1 Defined Status Codes</a>.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.eclipse.jetty.websocket.api.StatusCode.MESSAGE_TOO_LARGE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="REQUIRED_EXTENSION">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>REQUIRED_EXTENSION</h4>
<pre>public static final&nbsp;int REQUIRED_EXTENSION</pre>
<div class="block">1010 indicates that an endpoint (client) is terminating the connection because it has expected the server to negotiate one or more extension, but the
server didn't return them in the response message of the WebSocket handshake. The list of extensions that are needed SHOULD appear in the /reason/ part
of the Close frame. Note that this status code is not used by the server, because it can fail the WebSocket handshake instead.
<p>
See <a href="https://tools.ietf.org/html/rfc6455#section-7.4.1">RFC 6455, Section 7.4.1 Defined Status Codes</a>.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.eclipse.jetty.websocket.api.StatusCode.REQUIRED_EXTENSION">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&nbsp;int SERVER_ERROR</pre>
<div class="block">1011 indicates that a server is terminating the connection because it encountered an unexpected condition that prevented it from fulfilling the request.
<p>
See <a href="https://tools.ietf.org/html/rfc6455#section-7.4.1">RFC 6455, Section 7.4.1 Defined Status Codes</a>.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.eclipse.jetty.websocket.api.StatusCode.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&nbsp;int SERVICE_RESTART</pre>
<div class="block">1012 indicates that the service is restarted. a client may reconnect, and if it chooses to do, should reconnect using a randomized delay of 5 - 30s.
<p>
See <a href="https://www.ietf.org/mail-archive/web/hybi/current/msg09649.html">[hybi] Additional WebSocket Close Error Codes</a></div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.eclipse.jetty.websocket.api.StatusCode.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&nbsp;int TRY_AGAIN_LATER</pre>
<div class="block">1013 indicates that the service is experiencing overload. a client should only connect to a different IP (when there are multiple for the target) or
reconnect to the same IP upon user action.
<p>
See <a href="https://www.ietf.org/mail-archive/web/hybi/current/msg09649.html">[hybi] Additional WebSocket Close Error Codes</a></div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.eclipse.jetty.websocket.api.StatusCode.TRY_AGAIN_LATER">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="INVALID_UPSTREAM_RESPONSE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>INVALID_UPSTREAM_RESPONSE</h4>
<pre>public static final&nbsp;int INVALID_UPSTREAM_RESPONSE</pre>
<div class="block">1014 indicates that a gateway or proxy received and invalid upstream response.
<p>
See <a href="https://www.ietf.org/mail-archive/web/hybi/current/msg10748.html">[hybi] WebSocket Subprotocol Close Code: Bad Gateway</a></div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.eclipse.jetty.websocket.api.StatusCode.INVALID_UPSTREAM_RESPONSE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="FAILED_TLS_HANDSHAKE">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>FAILED_TLS_HANDSHAKE</h4>
<pre>public static final&nbsp;int FAILED_TLS_HANDSHAKE</pre>
<div class="block">1015 is a reserved value and MUST NOT be set as a status code in a Close control frame by an endpoint. It is designated for use in applications expecting
a status code to indicate that the connection was closed due to a failure to perform a TLS handshake (e.g., the server certificate can't be verified).
<p>
See <a href="https://tools.ietf.org/html/rfc6455#section-7.4.1">RFC 6455, Section 7.4.1 Defined Status Codes</a>.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.eclipse.jetty.websocket.api.StatusCode.FAILED_TLS_HANDSHAKE">Constant Field Values</a></dd>
</dl>
</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;()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>StatusCode</h4>
<pre>public&nbsp;StatusCode()</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="isTransmittable(int)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>isTransmittable</h4>
<pre class="methodSignature">public static&nbsp;boolean&nbsp;isTransmittable&#8203;(int&nbsp;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>
</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/StatusCode.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><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;2021 <a href="https://webtide.com">Webtide</a>. All rights reserved.</small></p>
</footer>
</body>
</html>