public Class CloseFrame

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.

1014 indicates that the server was acting as a gateway or proxy and received an invalid response from the upstream server. This is similar to 502 HTTP Status Code See https://www.ietf.org/mail-archive/web/hybi/current/msg10748.html fore more information.

Since

1.3.8

The connection had a buggy close (this should not happen)

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 which 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.

The connection was flushed and closed

1001 indicates that an endpoint is "going away", such as a server going down, or a browser having navigated away from a page.

The connection had never been established

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 [RFC3629] data within a text message).

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.

indicates a normal closure, meaning whatever purpose the connection was established for has been fulfilled.

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.

1002 indicates that an endpoint is terminating the connection due to a protocol error.

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).

1012 indicates that the service is restarted. A client may reconnect, and if it choses to do, should reconnect using a randomized delay of 5 - 30s. See https://www.ietf.org/mail-archive/web/hybi/current/msg09670.html for more information.

Since

1.3.8

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).

1009 indicates that an endpoint is terminating the connection because it has received a message which is too big for it to process.

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. See https://www.ietf.org/mail-archive/web/hybi/current/msg09670.html for more information.

Since

1.3.8

1011 indicates that a server is terminating the connection because it encountered an unexpected condition that prevented it from fulfilling the request.

Overrides org.java_websocket.framing.FramedataImpl1.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

• It is reflexive: for any non-null reference value x, x.equals(x) should return true.
• It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
• It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
• It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
• For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Annotations

@Override

Get the used close code

Returns:int

the used close code

Get the message that closeframe is containing

Returns:String

the message in this frame

Overrides org.java_websocket.framing.FramedataImpl1.getPayloadData.

Implements org.java_websocket.framing.Framedata.getPayloadData.

Doc from org.java_websocket.framing.Framedata.getPayloadData.

The "Payload data" which was sent in this frame

Annotations

@Override

Overrides org.java_websocket.framing.FramedataImpl1.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

• Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
• If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
• It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Annotations

@Override

Overrides org.java_websocket.framing.ControlFrame.isValid.

Doc from org.java_websocket.framing.FramedataImpl1.isValid.

Check if the frame is valid due to specification

Annotations

@Override

Exceptions

InvalidDataException:

thrown if the frame is not a valid frame

Set the close code for this close frame

Parameters

code:int

the close code

Overrides org.java_websocket.framing.FramedataImpl1.setPayload.

Doc from org.java_websocket.framing.FramedataImpl1.setPayload.

Set the payload of this frame to the provided payload

Annotations

@Override

Set the close reason for this close frame

Parameters

reason:String

the reason code

Overrides org.java_websocket.framing.FramedataImpl1.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Annotations

@Override