org.java_websocket.framing

Interface CloseFrame

All Superinterfaces:

Framedata

All Known Implementing Classes:

CloseFrameBuilder

public interface CloseFrame
extends Framedata

Nested Class Summary

Nested classes/interfaces inherited from interface org.java_websocket.framing.Framedata

Framedata.Opcode

Field Summary

Fields

Modifier and Type	Field and Description
static int	ABNORMAL_CLOSE 1006 is a reserved value and MUST NOT be set as a status code in a Close control frame by an endpoint.
static int	BUGGYCLOSE
static int	EXTENSION 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.
static int	FLASHPOLICY
static int	GOING_AWAY 1001 indicates that an endpoint is "going away", such as a server going down, or a browser having navigated away from a page.
static int	NEVER_CONNECTED The connection had never been established
static int	NO_UTF8 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).
static int	NOCODE 1005 is a reserved value and MUST NOT be set as a status code in a Close control frame by an endpoint.
static int	NORMAL indicates a normal closure, meaning whatever purpose the connection was established for has been fulfilled.
static int	POLICY_VALIDATION 1008 indicates that an endpoint is terminating the connection because it has received a message that violates its policy.
static int	PROTOCOL_ERROR 1002 indicates that an endpoint is terminating the connection due to a protocol error.
static int	REFUSE 1003 indicates that an endpoint is terminating the connection because it has received a type of data it cannot accept (e.g.
static int	TLS_ERROR 1015 is a reserved value and MUST NOT be set as a status code in a Close control frame by an endpoint.
static int	TOOBIG 1009 indicates that an endpoint is terminating the connection because it has received a message which is too big for it to process.
static int	UNEXPECTED_CONDITION 1011 indicates that a server is terminating the connection because it encountered an unexpected condition that prevented it from fulfilling the request.

Method Summary

Methods

Modifier and Type	Method and Description
int	getCloseCode()
String	getMessage()

Methods inherited from interface org.java_websocket.framing.Framedata

append, getOpcode, getPayloadData, getTransfereMasked, isFin

Field Detail

NORMAL

static final int NORMAL

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

See Also:

Constant Field Values

GOING_AWAY

static final int GOING_AWAY

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

See Also:

Constant Field Values

PROTOCOL_ERROR

static final int PROTOCOL_ERROR

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

See Also:

Constant Field Values

REFUSE

static final int REFUSE

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

See Also:

Constant Field Values

NOCODE

static final int NOCODE

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.

See Also:

Constant Field Values

ABNORMAL_CLOSE

static final int ABNORMAL_CLOSE

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.

See Also:

Constant Field Values

NO_UTF8

static final int NO_UTF8

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

See Also:

Constant Field Values

POLICY_VALIDATION

static final int POLICY_VALIDATION

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.

See Also:

Constant Field Values

TOOBIG

static final int TOOBIG

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

See Also:

Constant Field Values

EXTENSION

static final int EXTENSION

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.

See Also:

Constant Field Values

UNEXPECTED_CONDITION

static final int UNEXPECTED_CONDITION

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

See Also:

Constant Field Values

TLS_ERROR

static final int TLS_ERROR

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

See Also:

Constant Field Values

NEVER_CONNECTED

static final int NEVER_CONNECTED

The connection had never been established

See Also:

Constant Field Values

BUGGYCLOSE

static final int BUGGYCLOSE

See Also:

Constant Field Values

FLASHPOLICY

static final int FLASHPOLICY

See Also:

Constant Field Values

Method Detail

getCloseCode

int getCloseCode()
                 throws InvalidFrameException

Throws:

InvalidFrameException

getMessage

String getMessage()
                  throws InvalidDataException

Throws:

InvalidDataException