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

Class ReceivedPingMessageEvent

java.lang.Object

de.craftsblock.craftscore.event.Event

de.craftsblock.craftsnet.events.sockets.message.ReceivedPingMessageEvent

All Implemented Interfaces:

GenericSocketEventBase, GenericSocketMessageEventBase

public class ReceivedPingMessageEvent
extends de.craftsblock.craftscore.event.Event
implements GenericSocketMessageEventBase

An event indicating that a Ping message has been received.

Since:

3.0.5-SNAPSHOT

See Also:

• GenericSocketMessageEventBase

Constructor Summary

Constructors

Constructor	Description
ReceivedPingMessageEvent(SocketExchange exchange, @NotNull Frame frame)	Constructs a ReceivedPingMessageEvent with the specified SocketExchange.

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.
byte @Nullable []	getMessage()	Deprecated, for removal: This API element is subject to removal in a future version. Use GenericSocketMessageEventBase.getData() instead.

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

ReceivedPingMessageEvent

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

Constructs a ReceivedPingMessageEvent with the specified SocketExchange.

Parameters:

exchange - The SocketExchange associated with the received Pong message.

frame - The frame send with the ping message.

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.

getMessage

@Deprecated(forRemoval=true,
            since="3.4.0-SNAPSHOT")
public byte @Nullable [] getMessage()

Deprecated, for removal: This API element is subject to removal in a future version.

Use GenericSocketMessageEventBase.getData() instead.

Retrieves the message as a byte array that was sent with the ping message.

Returns:

The message as a byte array if present, otherwise null.