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

Class OutgoingSocketMessageEvent

java.lang.Object

de.craftsblock.craftscore.event.Event

de.craftsblock.craftscore.event.CancellableEvent

de.craftsblock.craftsnet.events.sockets.message.OutgoingSocketMessageEvent

All Implemented Interfaces:

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

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

The OutgoingSocketMessageEvent class represents an event related to an outgoing 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
OutgoingSocketMessageEvent(@NotNull SocketExchange exchange, @NotNull Frame frame)	Constructs a new OutgoingSocketMessageEvent with the specified SocketExchange and 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.
@NotNull Frame	getFrame()	Gets the incoming message as a Frame object.
void	setData(byte @NotNull [] data)	Sets the outgoing message data for the event.
void	setFrame(@NotNull Frame frame)	Sets the outgoing message frame.
void	setOpcode(@NotNull Opcode opcode)	Sets the opcode used to send the data.

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

OutgoingSocketMessageEvent

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

Constructs a new OutgoingSocketMessageEvent with the specified SocketExchange and message data.

Parameters:

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

frame - The Frame that contains the message information.

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

@NotNull
public @NotNull Frame getFrame()

Gets the incoming message as a Frame object.

Specified by:

getFrame in interface GenericSocketMessageEventBase

Returns:

The incoming message.

setOpcode

public void setOpcode(@NotNull
 @NotNull Opcode opcode)

Sets the opcode used to send the data.

Parameters:

opcode - The opcode which should be used.

setData

public void setData(byte @NotNull [] data)

Sets the outgoing message data for the event.

Parameters:

data - The outgoing message data to be set.

setFrame

public void setFrame(@NotNull
 @NotNull Frame frame)

Sets the outgoing message frame.

Parameters:

frame - The outgoing message frame.