Package de.craftsblock.craftsnet.events.sockets.message

Class IncomingSocketMessageEvent

java.lang.Object

de.craftsblock.craftscore.event.Event

de.craftsblock.craftscore.event.CancellableEvent

de.craftsblock.craftsnet.events.sockets.message.IncomingSocketMessageEvent

All Implemented Interfaces:

de.craftsblock.craftscore.event.Cancellable, GenericSocketEventBase, GenericSocketMessageEventBase

public class IncomingSocketMessageEvent
extends de.craftsblock.craftscore.event.CancellableEvent
implements GenericSocketMessageEventBase

The IncomingSocketMessageEvent class represents an event related to an incoming message on a websocket connection. It extends the base CancellableEvent to support event cancellation.

Since:

2.1.1-SNAPSHOT

See Also:

• GenericSocketMessageEventBase

Constructor Summary

Constructors

Constructor	Description
IncomingSocketMessageEvent(SocketExchange exchange, @NotNull Frame frame)	Constructs a new IncomingSocketMessageEvent with the specified SocketExchange and incoming message data.

Method Summary

Modifier and Type	Method	Description
@NotNull SocketExchange	getExchange()	Gets the SocketExchange which stores the involved client, server and some other data.
Frame	getFrame()	Gets the incoming message as a Frame object.

Methods inherited from class de.craftsblock.craftscore.event.CancellableEvent

isCancelled, setCancelled

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

Methods inherited from interface de.craftsblock.craftsnet.events.sockets.message.GenericSocketMessageEventBase

getBuffer, getData, getOpcode, getUtf8

Constructor Details

IncomingSocketMessageEvent

public IncomingSocketMessageEvent(SocketExchange exchange,
 @NotNull
 @NotNull Frame frame)

Constructs a new IncomingSocketMessageEvent with the specified SocketExchange and incoming message data.

Parameters:

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

frame - The incoming message frame for this event.

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.

getFrame

public Frame getFrame()

Gets the incoming message as a Frame object.

Specified by:

getFrame in interface GenericSocketMessageEventBase

Returns:

The incoming message.