discord4j.common.close

Class CloseException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

discord4j.common.close.CloseException

All Implemented Interfaces:

Serializable

public class CloseException
extends RuntimeException

Unchecked exception thrown when closing a websocket session, expectedly or not.

Used to wrap an underlying websocket CloseStatus so clients can retrieve the status code and perform actions after it.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CloseException(CloseStatus closeStatus, Context context) Create a CloseException with the given status and Reactor context.
CloseException(CloseStatus closeStatus, Context context, Throwable cause) Create a CloseException with the given status, Reactor context and cause.

Method Summary

Modifier and Type	Method and Description
CloseStatus	getCloseStatus() Return the underlying CloseStatus that triggered this exception.
int	getCode() Return the websocket close code.
Context	getContext() Return the Reactor Context providing metadata about this exception.
String	getMessage()
Optional<String>	getReason() Return a websocket close reason, if present.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

CloseException

public CloseException(CloseStatus closeStatus,
                      Context context)

Create a CloseException with the given status and Reactor context.

Parameters:

closeStatus - the CloseStatus representing this exception

context - a Context instance representing metadata related to this exception

CloseException

public CloseException(CloseStatus closeStatus,
                      Context context,
                      @Nullable
                      Throwable cause)

Create a CloseException with the given status, Reactor context and cause.

Parameters:

closeStatus - the CloseStatus representing this exception

context - a Context instance providing metadata related to this exception

cause - the cause for this exception

Method Detail

getCloseStatus

public CloseStatus getCloseStatus()

Return the underlying CloseStatus that triggered this exception.

Returns:

a close status

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

getContext

public Context getContext()

Return the Reactor Context providing metadata about this exception.

Returns:

a Reactor context instance

getMessage

public String getMessage()

Overrides:

getMessage in class Throwable