Package org.eclipse.jetty.websocket.core

Class CloseStatus

java.lang.Object

org.eclipse.jetty.websocket.core.CloseStatus

public class CloseStatus
extends Object

Representation of a WebSocket Close (status code & reason)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CloseStatus.Supplier

Field Summary

Fields

Modifier and Type	Field	Description
static final int	BAD_DATA
static final int	BAD_GATEWAY
static final int	BAD_PAYLOAD
static final int	EXTENSION_ERROR
static final int	FAILED_TLS_HANDSHAKE
static final int	MESSAGE_TOO_LARGE
static final int	NO_CLOSE
static final CloseStatus	NO_CLOSE_STATUS
static final int	NO_CODE
static final CloseStatus	NO_CODE_STATUS
static final int	NORMAL
static final CloseStatus	NORMAL_STATUS
static final int	POLICY_VIOLATION
static final int	PROTOCOL
static final int	RESERVED
static final int	SERVER_ERROR
static final int	SERVICE_RESTART
static final int	SHUTDOWN
static final int	TRY_AGAIN_LATER

Constructor Summary

Constructors

Constructor	Description
CloseStatus()	Creates a reason for closing a web socket connection with the no given status code.
CloseStatus(int statusCode)	Creates a reason for closing a web socket connection with the given status code and no reason phrase.
CloseStatus(int statusCode, String reasonPhrase)	Creates a reason for closing a web socket connection with the given status code and reason phrase.
CloseStatus(int statusCode, String reasonPhrase, Throwable cause)	Creates a reason for closing a web socket connection with the given status code and reason phrase.
CloseStatus(int statusCode, Throwable cause)	Creates a reason for closing a web socket connection with the given status code and reason phrase.
CloseStatus(ByteBuffer payload)
CloseStatus(Frame frame)

Method Summary

Modifier and Type	Method	Description
ByteBuffer	asPayloadBuffer()
static ByteBuffer	asPayloadBuffer(int statusCode, String reason)
static String	codeString(int closeStatus)
Throwable	getCause()
static CloseStatus	getCloseStatus(Frame frame)
int	getCode()
String	getReason()
boolean	isAbnormal()
boolean	isNormal()
static boolean	isOrdinary(int closeCode)
static boolean	isTransmittableStatusCode(int statusCode)	Test if provided status code can be sent/received on a WebSocket close.
Frame	toFrame()
static Frame	toFrame(int closeStatus)
static Frame	toFrame(int closeStatus, String reason)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

NORMAL

public static final int NORMAL

See Also:

• Constant Field Values

SHUTDOWN

public static final int SHUTDOWN

See Also:

• Constant Field Values

PROTOCOL

public static final int PROTOCOL

See Also:

• Constant Field Values

BAD_DATA

public static final int BAD_DATA

See Also:

• Constant Field Values

RESERVED

public static final int RESERVED

See Also:

• Constant Field Values

NO_CODE

public static final int NO_CODE

See Also:

• Constant Field Values

NO_CLOSE

public static final int NO_CLOSE

See Also:

• Constant Field Values

BAD_PAYLOAD

public static final int BAD_PAYLOAD

See Also:

• Constant Field Values

POLICY_VIOLATION

public static final int POLICY_VIOLATION

See Also:

• Constant Field Values

MESSAGE_TOO_LARGE

public static final int MESSAGE_TOO_LARGE

See Also:

• Constant Field Values

EXTENSION_ERROR

public static final int EXTENSION_ERROR

See Also:

• Constant Field Values

SERVER_ERROR

public static final int SERVER_ERROR

See Also:

• Constant Field Values

SERVICE_RESTART

public static final int SERVICE_RESTART

See Also:

• Constant Field Values

TRY_AGAIN_LATER

public static final int TRY_AGAIN_LATER

See Also:

• Constant Field Values

BAD_GATEWAY

public static final int BAD_GATEWAY

See Also:

• Constant Field Values

FAILED_TLS_HANDSHAKE

public static final int FAILED_TLS_HANDSHAKE

See Also:

• Constant Field Values

NO_CODE_STATUS

public static final CloseStatus NO_CODE_STATUS

NO_CLOSE_STATUS

public static final CloseStatus NO_CLOSE_STATUS

NORMAL_STATUS

public static final CloseStatus NORMAL_STATUS

Constructor Details

CloseStatus

public CloseStatus()

Creates a reason for closing a web socket connection with the no given status code.

CloseStatus

public CloseStatus(int statusCode)

Creates a reason for closing a web socket connection with the given status code and no reason phrase.

Parameters:

statusCode - the close code

CloseStatus

public CloseStatus(int statusCode,
 String reasonPhrase)

Creates a reason for closing a web socket connection with the given status code and reason phrase.

Parameters:

statusCode - the close code

reasonPhrase - the reason phrase

CloseStatus

public CloseStatus(int statusCode,
 Throwable cause)

Creates a reason for closing a web socket connection with the given status code and reason phrase.

Parameters:

statusCode - the close code

cause - the error which caused the close

CloseStatus

public CloseStatus(int statusCode,
 String reasonPhrase,
 Throwable cause)

Creates a reason for closing a web socket connection with the given status code and reason phrase.

Parameters:

statusCode - the close code

reasonPhrase - the reason phrase

cause - the error which caused the close

CloseStatus

public CloseStatus(Frame frame)

CloseStatus

public CloseStatus(ByteBuffer payload)

Method Details

getCloseStatus

public static CloseStatus getCloseStatus(Frame frame)

isOrdinary

public static boolean isOrdinary(int closeCode)

isAbnormal

public boolean isAbnormal()

getCause

public Throwable getCause()

getCode

public int getCode()

getReason

public String getReason()

asPayloadBuffer

public ByteBuffer asPayloadBuffer()

asPayloadBuffer

public static ByteBuffer asPayloadBuffer(int statusCode,
 String reason)

isTransmittableStatusCode

public static boolean isTransmittableStatusCode(int statusCode)

Test if provided status code can be sent/received on a WebSocket close.

This honors the RFC6455 rules and IANA rules.

Parameters:

statusCode - the statusCode to test

Returns:

true if transmittable

toFrame

public Frame toFrame()

toFrame

public static Frame toFrame(int closeStatus)

toFrame

public static Frame toFrame(int closeStatus,
 String reason)

codeString

public static String codeString(int closeStatus)

isNormal

public boolean isNormal()

toString

public String toString()

Overrides:

toString in class Object