Package io.papermc.paper.connection
Interface PlayerCommonConnection
- All Superinterfaces:
PlayerConnection
,ReadablePlayerCookieConnection
,WritablePlayerCookieConnection
- All Known Subinterfaces:
PlayerConfigurationConnection
,PlayerGameConnection
public interface PlayerCommonConnection
extends WritablePlayerCookieConnection, ReadablePlayerCookieConnection
Represents a connection that has properties shared between the GAME and CONFIG stage.
-
Method Summary
Modifier and TypeMethodDescription<T> T
getClientOption
(ClientOption<T> type) void
sendLinks
(ServerLinks links) Sends the given server links to this connection.void
sendReportDetails
(Map<String, String> details) Sends data to appear in this connection's report logs.void
Transfers this connection to another server.Methods inherited from interface io.papermc.paper.connection.PlayerConnection
disconnect, getAddress, getClientAddress, getHAProxyAddress, getVirtualHost, isTransferred
Methods inherited from interface io.papermc.paper.connection.ReadablePlayerCookieConnection
retrieveCookie
Methods inherited from interface io.papermc.paper.connection.WritablePlayerCookieConnection
storeCookie
-
Method Details
-
sendReportDetails
Sends data to appear in this connection's report logs. This is useful for debugging server state that may be causing player disconnects.These are formatted as key - value, where keys are limited to a length of 128 characters, values are limited to 4096, and 32 maximum entries can be sent.
- Parameters:
details
- report details
-
sendLinks
Sends the given server links to this connection.- Parameters:
links
- links to send
-
transfer
Transfers this connection to another server.- Parameters:
host
- hostport
- port
-
getClientOption
- Parameters:
type
- client option- Returns:
- the client option value of the player
-