Record Class WebsocketCloseReason

java.lang.Object

java.lang.Record

io.fluxzero.sdk.common.websocket.WebsocketCloseReason

Record Components:

code - the numeric WebSocket close status code

reason - the optional close reason, normalized to an empty string when null

public record WebsocketCloseReason(int code, String reason)
extends Record

WebSocket close information used by the low-level Fluxzero runtime clients.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	GOING_AWAY	Standard close code used when an endpoint is going away.
static final int	NO_STATUS_CODE	Synthetic close code used when no status code was received from the peer.
static final int	NORMAL_CLOSURE	Standard close code for a normal, intentional shutdown.
static final int	UNEXPECTED_CONDITION	Standard close code used when the client aborts because an unexpected condition occurred.

Constructor Summary

Constructors

Constructor	Description
WebsocketCloseReason(int code, String reason)	Creates an instance of a WebsocketCloseReason record class.

Method Summary

Modifier and Type	Method	Description
int	code()	Returns the value of the code record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
String	reason()	Returns the value of the reason record component.
String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

NORMAL_CLOSURE

public static final int NORMAL_CLOSURE

Standard close code for a normal, intentional shutdown.

See Also:

• Constant Field Values

GOING_AWAY

public static final int GOING_AWAY

Standard close code used when an endpoint is going away.

See Also:

• Constant Field Values

NO_STATUS_CODE

public static final int NO_STATUS_CODE

Synthetic close code used when no status code was received from the peer.

See Also:

• Constant Field Values

UNEXPECTED_CONDITION

public static final int UNEXPECTED_CONDITION

Standard close code used when the client aborts because an unexpected condition occurred.

See Also:

• Constant Field Values

Constructor Details

WebsocketCloseReason

public WebsocketCloseReason(int code,
 String reason)

Creates an instance of a WebsocketCloseReason record class.

Parameters:

code - the value for the code record component

reason - the value for the reason record component

Method Details

toString

public String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

code

public int code()

Returns the value of the code record component.

Returns:

the value of the code record component

reason

public String reason()

Returns the value of the reason record component.

Returns:

the value of the reason record component