Package net.minestom.server.network.player

Class PlayerSocketConnection

java.lang.Object

net.minestom.server.network.player.PlayerConnection

net.minestom.server.network.player.PlayerSocketConnection

@Internal
public class PlayerSocketConnection
extends PlayerConnection

Represents a socket connection.

It is the implementation used for all network client.

Constructor Summary

Constructors

Constructor	Description
PlayerSocketConnection(@NotNull SocketChannel channel, SocketAddress remoteAddress)

Method Summary

Modifier and Type	Method	Description
void	flushSync()
@Nullable GameProfile	gameProfile()
@NotNull SocketChannel	getChannel()
@Nullable String	getLoginUsername()	Retrieves the username received from the client during connection.
byte[]	getNonce()
int	getProtocolVersion()	Gets the protocol version of a client.
@NotNull SocketAddress	getRemoteAddress()	Gets the remote address of the client.
@Nullable String	getServerAddress()	Gets the server address that the client used to connect.
int	getServerPort()	Gets the server port that the client used to connect.
void	read(PacketParser<ClientPacket> packetParser)
void	refreshServerInformation(@Nullable String serverAddress, int serverPort, int protocolVersion)	Used in ClientHandshakePacket to change the internal fields.
void	sendPacket(@NotNull SendablePacket packet)	Serializes the packet and send it to the client.
void	sendPackets(@NotNull Collection<SendablePacket> packets)
void	setEncryptionKey(@NotNull SecretKey secretKey)	Sets the encryption key and add the codecs to the pipeline.
void	setNonce(byte[] nonce)
void	setRemoteAddress(@NotNull SocketAddress remoteAddress)	Changes the internal remote address field.
void	startCompression()	Enables compression and add a new codec to the pipeline.
void	UNSAFE_setLoginUsername(@NotNull String loginUsername)	Sets the internal login username field.
void	UNSAFE_setProfile(@NotNull GameProfile gameProfile)

Methods inherited from class net.minestom.server.network.player.PlayerConnection

disconnect, fetchCookie, getConnectionState, getIdentifier, getPlayer, isOnline, kick, loginPluginMessageProcessor, playerPublicKey, receiveCookieResponse, receiveKnownPacksResponse, requestKnownPacks, sendPackets, setConnectionState, setPlayer, setPlayerPublicKey, storeCookie, toString

Methods inherited from class java.lang.Object

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

Constructor Details

PlayerSocketConnection

public PlayerSocketConnection(@NotNull
 @NotNull SocketChannel channel,
 SocketAddress remoteAddress)

Method Details

read

public void read(PacketParser<ClientPacket> packetParser)
          throws IOException

Throws:

IOException

setEncryptionKey

public void setEncryptionKey(@NotNull
 @NotNull SecretKey secretKey)

Sets the encryption key and add the codecs to the pipeline.

Parameters:

secretKey - the secret key to use in the encryption

Throws:

IllegalStateException - if encryption is already enabled for this connection

startCompression

public void startCompression()

Enables compression and add a new codec to the pipeline.

Throws:

IllegalStateException - if encryption is already enabled for this connection

sendPacket

public void sendPacket(@NotNull
 @NotNull SendablePacket packet)

Description copied from class: PlayerConnection

Serializes the packet and send it to the client.

Specified by:

sendPacket in class PlayerConnection

Parameters:

packet - the packet to send

sendPackets

public void sendPackets(@NotNull
 @NotNull Collection<SendablePacket> packets)

Overrides:

sendPackets in class PlayerConnection

getRemoteAddress

@NotNull
public @NotNull SocketAddress getRemoteAddress()

Description copied from class: PlayerConnection

Gets the remote address of the client.

Specified by:

getRemoteAddress in class PlayerConnection

Returns:

the remote address

setRemoteAddress

@Internal
public void setRemoteAddress(@NotNull
 @NotNull SocketAddress remoteAddress)

Changes the internal remote address field.

Mostly unsafe, used internally when interacting with a proxy.

Parameters:

remoteAddress - the new connection remote address

getChannel

@NotNull
public @NotNull SocketChannel getChannel()

gameProfile

@Nullable
public @Nullable GameProfile gameProfile()

UNSAFE_setProfile

public void UNSAFE_setProfile(@NotNull
 @NotNull GameProfile gameProfile)

getLoginUsername

@Nullable
public @Nullable String getLoginUsername()

Retrieves the username received from the client during connection.

This value has not been checked and could be anything.

Returns:

the username given by the client, unchecked

UNSAFE_setLoginUsername

public void UNSAFE_setLoginUsername(@NotNull
 @NotNull String loginUsername)

Sets the internal login username field.

Parameters:

loginUsername - the new login username field

getServerAddress

@Nullable
public @Nullable String getServerAddress()

Gets the server address that the client used to connect.

WARNING: it is given by the client, it is possible for it to be wrong.

Overrides:

getServerAddress in class PlayerConnection

Returns:

the server address used

getServerPort

public int getServerPort()

Gets the server port that the client used to connect.

WARNING: it is given by the client, it is possible for it to be wrong.

Overrides:

getServerPort in class PlayerConnection

Returns:

the server port used

getProtocolVersion

public int getProtocolVersion()

Gets the protocol version of a client.

Overrides:

getProtocolVersion in class PlayerConnection

Returns:

protocol version of client.

refreshServerInformation

public void refreshServerInformation(@Nullable
 @Nullable String serverAddress,
 int serverPort,
 int protocolVersion)

Used in ClientHandshakePacket to change the internal fields.

Parameters:

serverAddress - the server address which the client used

serverPort - the server port which the client used

protocolVersion - the protocol version which the client used

getNonce

public byte[] getNonce()

setNonce

public void setNonce(byte[] nonce)

flushSync

public void flushSync()
               throws IOException

Throws:

IOException