Package de.craftsblock.craftsnet.events.sockets

Interface GenericSocketEventBase

All Known Subinterfaces:

GenericSocketMessageEventBase

All Known Implementing Classes:

ClientConnectEvent, ClientDisconnectEvent, IncomingSocketMessageEvent, OutgoingSocketMessageEvent, ReceivedPingMessageEvent, ReceivedPongMessageEvent

public interface GenericSocketEventBase

Represents the base for all websocket events.

Since:

3.4.0-SNAPSHOT

See Also:

• SocketExchange
• WebSocketClient
• WebSocketServer

Method Summary

Modifier and Type	Method	Description
default @NotNull WebSocketClient	getClient()	Gets the WebSocketClient which is involved in this event.
@NotNull SocketExchange	getExchange()	Gets the SocketExchange which stores the involved client, server and some other data.
default @NotNull WebSocketServer	getServer()	Gets the WebSocketServer which is involved in this event.

Method Details

getExchange

@NotNull
@NotNull SocketExchange getExchange()

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

Returns:

The SocketExchange.

getClient

@NotNull
default @NotNull WebSocketClient getClient()

Gets the WebSocketClient which is involved in this event.

Returns:

The WebSocketClient.

Since:

3.4.0-SNAPSHOT

getServer

@NotNull
default @NotNull WebSocketServer getServer()

Gets the WebSocketServer which is involved in this event.

Returns:

The WebSocketServer.

Since:

3.4.0-SNAPSHOT