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

Interface GenericSocketMessageEventBase

All Superinterfaces:

GenericSocketEventBase

All Known Implementing Classes:

IncomingSocketMessageEvent, OutgoingSocketMessageEvent, ReceivedPingMessageEvent, ReceivedPongMessageEvent

public interface GenericSocketMessageEventBase
extends GenericSocketEventBase

Represents the base for all websocket message events.

Since:

3.4.0-SNAPSHOT

See Also:

• Frame
• ByteBuffer
• Opcode

Method Summary

Modifier and Type	Method	Description
default ByteBuffer	getBuffer()	Gets the incoming message as a ByteBuffer object.
default byte @NotNull []	getData()	Gets the incoming message as a byte array.
Frame	getFrame()	Gets the incoming message as a Frame object.
default Opcode	getOpcode()	Gets the opcode used when sending the data.
default String	getUtf8()	Gets the incoming message as an utf8 encoded string.

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

getClient, getExchange, getServer

Method Details

getFrame

Frame getFrame()

Gets the incoming message as a Frame object.

Returns:

The incoming message.

getBuffer

default ByteBuffer getBuffer()

Gets the incoming message as a ByteBuffer object.

Returns:

The incoming message.

getData

default byte @NotNull [] getData()

Gets the incoming message as a byte array.

Returns:

The incoming message data.

getUtf8

default String getUtf8()

Gets the incoming message as an utf8 encoded string.

Returns:

The incoming message.

getOpcode

default Opcode getOpcode()

Gets the opcode used when sending the data.

Returns:

The opcode of the message.