org.spongepowered.api.event.server

Interface ClientPingServerEvent

All Superinterfaces:

Cancellable, Event

public interface ClientPingServerEvent
extends Event, Cancellable

Called when a client pings the server from the server list.

If this event gets cancelled, it will close the client connection without sending any response.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ClientPingServerEvent.Response Represents a mutable response to a status request.

Method Summary

Modifier and Type	Method and Description
StatusClient	getClient() Gets the client pinging the server.
ClientPingServerEvent.Response	getResponse() Gets the response that is about to be sent to the client.

Methods inherited from interface org.spongepowered.api.event.Event

getCause, getContext, getSource

Methods inherited from interface org.spongepowered.api.event.Cancellable

isCancelled, setCancelled

Method Detail

getClient

StatusClient getClient()

Gets the client pinging the server.

Returns:

The client of the status request

getResponse

ClientPingServerEvent.Response getResponse()

Gets the response that is about to be sent to the client.

Returns:

The response to the status request