discord4j.common.close

Class CloseStatus

java.lang.Object

discord4j.common.close.CloseStatus

public class CloseStatus
extends Object

Container for WebSocket "close" status codes and reasons.

See Also:

RFC 6455, Section 7.4.1 "Defined Status Codes"

Field Summary

Fields

Modifier and Type	Field and Description
static CloseStatus	ABNORMAL_CLOSE
static CloseStatus	NORMAL_CLOSE

Constructor Summary

Constructors

Constructor and Description
CloseStatus(int code, String reason) Create a new CloseStatus instance.

Method Summary

Modifier and Type	Method and Description
int	getCode() Return the websocket close code.
Optional<String>	getReason() Return a websocket close reason, if present.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

NORMAL_CLOSE

public static final CloseStatus NORMAL_CLOSE

ABNORMAL_CLOSE

public static final CloseStatus ABNORMAL_CLOSE

Constructor Detail

CloseStatus

public CloseStatus(int code,
                   @Nullable
                   String reason)

Create a new CloseStatus instance.

Parameters:

code - the status code

reason - the reason

Method Detail

getCode

public int getCode()

Return the websocket close code.

Returns:

a websocket close code

getReason

public Optional<String> getReason()

Return a websocket close reason, if present.

Returns:

an Optional containing a close reason if present, or empty otherwise

toString

public String toString()

Overrides:

toString in class Object