| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (1.8.0_92) on Thu Jun 07 14:26:31 EDT 2018 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>StatusCode (Jetty :: Project 9.3.24.v20180605 API)</title> |
| <meta name="date" content="2018-06-07"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="StatusCode (Jetty :: Project 9.3.24.v20180605 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.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"> |
| <li><a href="../../../../../org/eclipse/jetty/websocket/api/Session.html" title="interface in org.eclipse.jetty.websocket.api"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/eclipse/jetty/websocket/api/SuspendToken.html" title="interface in org.eclipse.jetty.websocket.api"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/eclipse/jetty/websocket/api/StatusCode.html" target="_top">Frames</a></li> |
| <li><a href="StatusCode.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></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> |
| </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="#methods.inherited.from.class.java.lang.Object">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>Method</li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.eclipse.jetty.websocket.api</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> |
| <br> |
| <pre>public 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 =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/api/StatusCode.html#ABNORMAL">ABNORMAL</a></span></code> |
| <div class="block">Abnormal Close is a synonym for <a href="../../../../../org/eclipse/jetty/websocket/api/StatusCode.html#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> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/api/StatusCode.html#BAD_DATA">BAD_DATA</a></span></code> |
| <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> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/api/StatusCode.html#BAD_PAYLOAD">BAD_PAYLOAD</a></span></code> |
| <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> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/api/StatusCode.html#FAILED_TLS_HANDSHAKE">FAILED_TLS_HANDSHAKE</a></span></code> |
| <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> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/api/StatusCode.html#MESSAGE_TOO_LARGE">MESSAGE_TOO_LARGE</a></span></code> |
| <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="rowColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/api/StatusCode.html#NO_CLOSE">NO_CLOSE</a></span></code> |
| <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="altColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/api/StatusCode.html#NO_CODE">NO_CODE</a></span></code> |
| <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="rowColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/api/StatusCode.html#NORMAL">NORMAL</a></span></code> |
| <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="altColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/api/StatusCode.html#POLICY_VIOLATION">POLICY_VIOLATION</a></span></code> |
| <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="rowColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/api/StatusCode.html#PROTOCOL">PROTOCOL</a></span></code> |
| <div class="block">1002 indicates that an endpoint is terminating the connection due to a protocol error.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/api/StatusCode.html#REQUIRED_EXTENSION">REQUIRED_EXTENSION</a></span></code> |
| <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="rowColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/api/StatusCode.html#SERVER_ERROR">SERVER_ERROR</a></span></code> |
| <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="altColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/api/StatusCode.html#SERVICE_RESTART">SERVICE_RESTART</a></span></code> |
| <div class="block">1012 indicates that the service is restarted.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/api/StatusCode.html#SHUTDOWN">SHUTDOWN</a></span></code> |
| <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="altColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/api/StatusCode.html#TRY_AGAIN_LATER">TRY_AGAIN_LATER</a></span></code> |
| <div class="block">1013 indicates that the service is experiencing overload.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/api/StatusCode.html#UNDEFINED">UNDEFINED</a></span></code> |
| <div class="block">Reserved.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/api/StatusCode.html#StatusCode--">StatusCode</a></span>()</code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a name="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, toString, wait, wait, wait</code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="NORMAL"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>NORMAL</h4> |
| <pre>public static final 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 name="SHUTDOWN"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SHUTDOWN</h4> |
| <pre>public static final 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 name="PROTOCOL"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>PROTOCOL</h4> |
| <pre>public static final 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 name="BAD_DATA"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>BAD_DATA</h4> |
| <pre>public static final 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 name="UNDEFINED"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>UNDEFINED</h4> |
| <pre>public static final 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 name="NO_CODE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>NO_CODE</h4> |
| <pre>public static final 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 name="NO_CLOSE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>NO_CLOSE</h4> |
| <pre>public static final 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 name="ABNORMAL"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ABNORMAL</h4> |
| <pre>public static final int ABNORMAL</pre> |
| <div class="block">Abnormal Close is a synonym for <a href="../../../../../org/eclipse/jetty/websocket/api/StatusCode.html#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 name="BAD_PAYLOAD"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>BAD_PAYLOAD</h4> |
| <pre>public static final 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 name="POLICY_VIOLATION"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>POLICY_VIOLATION</h4> |
| <pre>public static final 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 name="MESSAGE_TOO_LARGE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>MESSAGE_TOO_LARGE</h4> |
| <pre>public static final 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 name="REQUIRED_EXTENSION"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>REQUIRED_EXTENSION</h4> |
| <pre>public static final 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 name="SERVER_ERROR"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SERVER_ERROR</h4> |
| <pre>public static final 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 name="SERVICE_RESTART"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SERVICE_RESTART</h4> |
| <pre>public static final 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 name="TRY_AGAIN_LATER"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>TRY_AGAIN_LATER</h4> |
| <pre>public static final 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 name="FAILED_TLS_HANDSHAKE"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>FAILED_TLS_HANDSHAKE</h4> |
| <pre>public static final 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> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="StatusCode--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>StatusCode</h4> |
| <pre>public StatusCode()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.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"> |
| <li><a href="../../../../../org/eclipse/jetty/websocket/api/Session.html" title="interface in org.eclipse.jetty.websocket.api"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/eclipse/jetty/websocket/api/SuspendToken.html" title="interface in org.eclipse.jetty.websocket.api"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/eclipse/jetty/websocket/api/StatusCode.html" target="_top">Frames</a></li> |
| <li><a href="StatusCode.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses-noframe.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> |
| </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="#methods.inherited.from.class.java.lang.Object">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>Method</li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 1995–2018 <a href="http://webtide.com">Webtide</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
