Modifier and Type	Class and Description
pack-priv class	CloseStatus.CloseFrame
public static interface	CloseStatus.Supplier

Field Summary

Modifier and Type	Field and Description
public static final int	BAD_DATA
public static final int	BAD_GATEWAY
public static final int	BAD_PAYLOAD
private final Throwable	cause
private final int	code
public static final int	EXTENSION_ERROR
public static final int	FAILED_TLS_HANDSHAKE
pack-priv static final int	MAX_REASON_PHRASE
public static final int	MESSAGE_TOO_LARGE
public static final int	NO_CLOSE
public static final CloseStatus	NO_CLOSE_STATUS
public static final int	NO_CODE
public static final CloseStatus	NO_CODE_STATUS
public static final int	NORMAL
public static final CloseStatus	NORMAL_STATUS
public static final int	POLICY_VIOLATION
public static final int	PROTOCOL
private final String	reason
public static final int	RESERVED
public static final int	SERVER_ERROR
public static final int	SERVICE_RESTART
public static final int	SHUTDOWN
public static final int	TRY_AGAIN_LATER

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
public ByteBuffer	asPayloadBuffer()
public static ByteBuffer	asPayloadBuffer(int statusCode, String reason)
public static String	codeString(int closeStatus)
public Throwable	getCause()
public static CloseStatus	getCloseStatus(Frame frame)
public int	getCode()
public String	getReason()
public boolean	isAbnormal()
public boolean	isNormal()
public static boolean	isOrdinary(int closeCode)
public static boolean	Returns: true if transmittable isTransmittableStatusCode(int the statusCode to test statusCode) Test if provided status code can be sent/received on a WebSocket close.
public Frame	toFrame()
public static Frame	toFrame(int closeStatus)
public static Frame	toFrame(int closeStatus, String reason)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
private static byte[]	truncateToFit(byte[] bytes, int maxBytes)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

BAD_DATA	back to summary
public static final int BAD_DATA

BAD_GATEWAY	back to summary
public static final int BAD_GATEWAY

BAD_PAYLOAD	back to summary
public static final int BAD_PAYLOAD

cause	back to summary
private final Throwable cause

code	back to summary
private final int code

EXTENSION_ERROR	back to summary
public static final int EXTENSION_ERROR

FAILED_TLS_HANDSHAKE	back to summary
public static final int FAILED_TLS_HANDSHAKE

MAX_REASON_PHRASE	back to summary
pack-priv static final int MAX_REASON_PHRASE

MESSAGE_TOO_LARGE	back to summary
public static final int MESSAGE_TOO_LARGE

NO_CLOSE	back to summary
public static final int NO_CLOSE

NO_CLOSE_STATUS	back to summary
public static final CloseStatus NO_CLOSE_STATUS

NO_CODE	back to summary
public static final int NO_CODE

NO_CODE_STATUS	back to summary
public static final CloseStatus NO_CODE_STATUS

NORMAL	back to summary
public static final int NORMAL

NORMAL_STATUS	back to summary
public static final CloseStatus NORMAL_STATUS

POLICY_VIOLATION	back to summary
public static final int POLICY_VIOLATION

PROTOCOL	back to summary
public static final int PROTOCOL

reason	back to summary
private final String reason

RESERVED	back to summary
public static final int RESERVED

SERVER_ERROR	back to summary
public static final int SERVER_ERROR

SERVICE_RESTART	back to summary
public static final int SERVICE_RESTART

SHUTDOWN	back to summary
public static final int SHUTDOWN

TRY_AGAIN_LATER	back to summary
public static final int TRY_AGAIN_LATER

Constructor Detail

CloseStatus	back to summary
public CloseStatus() Creates a reason for closing a web socket connection with the no given status code.

CloseStatus	back to summary
public CloseStatus(int statusCode) Creates a reason for closing a web socket connection with the given status code and no reason phrase. Parameters statusCode:int the close code

CloseStatus

back to summary

public CloseStatus(int statusCode)

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

Parameters

statusCode:int: the close code

CloseStatus	back to summary
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:int the close code reasonPhrase:String the reason phrase

CloseStatus

back to summary

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:int: the close code
reasonPhrase:String: the reason phrase

CloseStatus	back to summary
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:int the close code cause:Throwable the error which caused the close

CloseStatus

back to summary

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:int: the close code
cause:Throwable: the error which caused the close

CloseStatus	back to summary
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:int the close code reasonPhrase:String the reason phrase cause:Throwable the error which caused the close

CloseStatus

back to summary

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:int: the close code
reasonPhrase:String: the reason phrase
cause:Throwable: the error which caused the close

CloseStatus	back to summary
public CloseStatus(Frame frame)

CloseStatus	back to summary
public CloseStatus(ByteBuffer payload)

Method Detail

asPayloadBuffer	back to summary
public ByteBuffer asPayloadBuffer()

asPayloadBuffer	back to summary
public static ByteBuffer asPayloadBuffer(int statusCode, String reason)

codeString	back to summary
public static String codeString(int closeStatus)

getCause	back to summary
public Throwable getCause()

getCloseStatus	back to summary
public static CloseStatus getCloseStatus(Frame frame)

getCode	back to summary
public int getCode()

getReason	back to summary
public String getReason()

isAbnormal	back to summary
public boolean isAbnormal()

isNormal	back to summary
public boolean isNormal()

isOrdinary	back to summary
public static boolean isOrdinary(int closeCode)

isTransmittableStatusCode	back to summary
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:int the statusCode to test Returns:boolean true if transmittable

isTransmittableStatusCode

back to summary

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:int: the statusCode to test

Returns:boolean

true if transmittable

toFrame	back to summary
public Frame toFrame()

toFrame	back to summary
public static Frame toFrame(int closeStatus)

toFrame	back to summary
public static Frame toFrame(int closeStatus, String reason)

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.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. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.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.

Returns:String

a string representation of the object

Annotations

@Override

truncateToFit	back to summary
private static byte[] truncateToFit(byte[] bytes, int maxBytes)

org.eclipse.jetty.websocket.core back to summary

pack-priv Class CloseStatus.CloseFrame

Class Inheritance

extends Frame
implements Supplier

java.lang.Object
org.eclipse.jetty.websocket.core.Frame
org.eclipse.jetty.websocket.core.CloseStatus.CloseFrame

All Implemented Interfaces

org.eclipse.jetty.websocket.core.CloseStatus.Supplier

Field Summary

Inherited from org.eclipse.jetty.websocket.core.Frame:: finRsvOp mask MAX_CONTROL_PAYLOAD payload

Constructor Summary

Access	Constructor and Description
public	CloseFrame(byte opcode)
public	CloseFrame(byte opCode, boolean fin, ByteBuffer payload)

Method Summary

Modifier and Type	Method and Description
public CloseStatus	getCloseStatus() Implements org.eclipse.jetty.websocket.core.CloseStatus.Supplier.getCloseStatus.
public String	toString() Overrides org.eclipse.jetty.websocket.core.Frame.toString. Returns a string representation of the object.