Package com.velocitypowered.api.event.connection

Class ConnectionHandshakeEvent

java.lang.Object

com.velocitypowered.api.event.connection.ConnectionHandshakeEvent

public final class ConnectionHandshakeEvent
extends Object

This event is fired when a handshake is established between a client and the proxy. Velocity will fire this event asynchronously and will not wait for it to complete before handling the connection.

Constructor Summary

Constructors

Constructor	Description
ConnectionHandshakeEvent(InboundConnection connection)	Deprecated, for removal: This API element is subject to removal in a future version. use ConnectionHandshakeEvent(InboundConnection, HandshakeIntent)
ConnectionHandshakeEvent(InboundConnection connection, HandshakeIntent intent)	Constructs a new ConnectionHandshakeEvent.

Method Summary

Modifier and Type	Method	Description
InboundConnection	getConnection()	Returns the inbound connection associated with this handshake.
HandshakeIntent	getIntent()	Returns the HandshakeIntent associated with this connection handshake.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

ConnectionHandshakeEvent

public ConnectionHandshakeEvent(InboundConnection connection,
 HandshakeIntent intent)

Constructs a new ConnectionHandshakeEvent.

Parameters:

connection - the inbound connection from the client

intent - the intent of the handshake (e.g., login or status)

ConnectionHandshakeEvent

@Deprecated(forRemoval=true)
public ConnectionHandshakeEvent(InboundConnection connection)

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

use ConnectionHandshakeEvent(InboundConnection, HandshakeIntent)

This method is only retained to avoid breaking plugins that have not yet updated their integration tests.

Parameters:

connection - the inbound connection

Method Details

getConnection

public InboundConnection getConnection()

Returns the inbound connection associated with this handshake.

Returns:

the connection

getIntent

public HandshakeIntent getIntent()

Returns the HandshakeIntent associated with this connection handshake.

Returns:

the intent of the handshake

toString

public String toString()

Overrides:

toString in class Object