Package de.craftsblock.craftsnet.events.sockets

Class ClientDisconnectEvent

java.lang.Object

de.craftsblock.craftscore.event.Event

de.craftsblock.craftsnet.events.sockets.ClientDisconnectEvent

All Implemented Interfaces:

GenericSocketEventBase

public class ClientDisconnectEvent
extends de.craftsblock.craftscore.event.Event
implements GenericSocketEventBase

The ClientDisconnectEvent class represents an event related to a client disconnection from a websocket connection. It extends the base Event class and provides information about the SocketExchange and the SocketMapping associated with the disconnection event.

Since:

2.1.1-SNAPSHOT

See Also:

• GenericSocketEventBase

Constructor Summary

Constructors

Constructor	Description
ClientDisconnectEvent(SocketExchange exchange, int closeCode, String closeReason, boolean closeByServer)	Constructs a new ClientDisconnectEvent with the specified SocketExchange and SocketMapping.

Method Summary

Modifier and Type	Method	Description
ClosureCode	getCloseCode()	Gets the close code parsed to a ClosureCode why the connection was closed.
String	getCloseReason()	Gets the reason why the connection was closed.
@NotNull SocketExchange	getExchange()	Gets the SocketExchange which stores the involved client, server and some other data.
EnumMap<ProcessPriority.Priority,List<RouteRegistry.EndpointMapping>>	getMappings()	Gets a EnumMap of all RouteRegistry.EndpointMapping associated with the client disconnect event.
int	getRawCloseCode()	Gets the raw close code why the connection was closed.
boolean	hasMappings()	Checks if the client disconnection event has at least one valid SocketMapping associated with it.
boolean	wasClosedByServer()	Gets whether the server disconnected the client or the client disconnected.

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.craftsblock.craftsnet.events.sockets.GenericSocketEventBase

getClient, getServer

Constructor Details

ClientDisconnectEvent

public ClientDisconnectEvent(SocketExchange exchange,
 int closeCode,
 String closeReason,
 boolean closeByServer)

Constructs a new ClientDisconnectEvent with the specified SocketExchange and SocketMapping.

Parameters:

exchange - The SocketExchange object representing the socket connection and its associated data.

closeCode - The close code.

closeReason - The close reason.

closeByServer - Whether the connection was closed by the server or the client.

Method Details

getExchange

@NotNull
public @NotNull SocketExchange getExchange()

Gets the SocketExchange which stores the involved client, server and some other data.

Specified by:

getExchange in interface GenericSocketEventBase

Returns:

The SocketExchange.

getMappings

public EnumMap<ProcessPriority.Priority,List<RouteRegistry.EndpointMapping>> getMappings()

Gets a EnumMap of all RouteRegistry.EndpointMapping associated with the client disconnect event.

Returns:

A EnumMap of RouteRegistry.EndpointMapping objects representing the mapping for the socket connection.

hasMappings

public boolean hasMappings()

Checks if the client disconnection event has at least one valid SocketMapping associated with it.

Returns:

true if the event has at least one valid SocketMapping, false otherwise.

getRawCloseCode

public int getRawCloseCode()

Gets the raw close code why the connection was closed.

Returns:

The raw close code if it was present, -1 otherwise

getCloseCode

public ClosureCode getCloseCode()

Gets the close code parsed to a ClosureCode why the connection was closed.

Returns:

The parsed close code if it was present, and it is registered in the ClosureCode enum, null otherwise

getCloseReason

public String getCloseReason()

Gets the reason why the connection was closed.

Returns:

The close reason if it was present, null otherwise

wasClosedByServer

public boolean wasClosedByServer()

Gets whether the server disconnected the client or the client disconnected.

Returns:

true if the server closed the connection, false otherwise.