Class FMLHandshakeHandler
An instance is created during ClientIntentionPacket
handling, and attached
to the Connection.channel()
via FMLNetworkConstants.FML_HANDSHAKE_HANDLER
.
The FMLNetworkConstants.handshakeChannel
is a SimpleChannel
with standard messages flowing in both directions.
The loginWrapper
transforms these messages into ServerboundCustomQueryPacket
and ClientboundCustomQueryPacket
compatible messages, by means of wrapping.
The handshake is ticked #tickLogin(NetworkManager)
from the ServerLoginPacketListenerImpl.tick()
method,
utilizing the ServerLoginPacketListenerImpl.State#NEGOTIATING
state, which is otherwise unused in vanilla code.
During client to server initiation, on the server, the NetworkEvent.GatherLoginPayloadsEvent
is fired,
which solicits all registered channels at the NetworkRegistry
for any
NetworkRegistry.LoginPayload
they wish to supply.
The collected NetworkRegistry.LoginPayload
are sent, one per tick, via
the FMLLoginWrapper#wrapPacket(ResourceLocation, net.minecraft.network.FriendlyByteBuf)
mechanism to the incoming client connection. Each
packet is indexed via ServerboundCustomQueryPacket.getTransactionId()
, which is
the only mechanism available for tracking request/response pairs.
Each packet sent from the server should be replied by the client, though not necessarily in sent order. The reply
should contain the index of the server's packet it is replying to. The FMLLoginWrapper
class handles indexing
replies correctly automatically.
Once all packets have been dispatched, we wait for all replies to be received. Once all replies are received, the final login phase will commence.
-
Field Summary
Modifier and TypeFieldDescriptionprivate NetworkDirection
(package private) static org.apache.logging.log4j.Marker
private static org.apache.logging.log4j.Logger
private static FMLLoginWrapper
private Connection
private List<NetworkRegistry.LoginPayload>
private int
private Set<ResourceLocation>
private Map<ResourceLocation,String>
private Map<ResourceLocation,ForgeRegistry.Snapshot>
-
Constructor Summary
ModifierConstructorDescriptionprivate
FMLHandshakeHandler(Connection networkManager, NetworkDirection side)
-
Method Summary
Modifier and TypeMethodDescriptionstatic <MSG extends IntSupplier>
BiConsumer<MSG,Supplier<NetworkEvent.Context>>biConsumerFor(ThreeConsumer<FMLHandshakeHandler,? super MSG,? super Supplier<NetworkEvent.Context>> consumer)
Transforms a two-argument instance method reference into aBiConsumer
based on thegetHandshake(Supplier)
function.private static FMLHandshakeHandler
getHandshake(Supplier<NetworkEvent.Context> contextSupplier)
Retrieve the handshake from theNetworkEvent.Context
(package private) void
handleClientAck(FMLHandshakeMessages.C2SAcknowledge msg, Supplier<NetworkEvent.Context> contextSupplier)
(package private) void
handleClientModListOnServer(FMLHandshakeMessages.C2SModListReply clientModList, Supplier<NetworkEvent.Context> c)
(package private) void
handleConfigSync(FMLHandshakeMessages.S2CConfigData msg, Supplier<NetworkEvent.Context> contextSupplier)
(package private) <MSG extends IntSupplier>
voidhandleIndexedMessage(MSG message, Supplier<NetworkEvent.Context> c)
private boolean
handleRegistryLoading(Supplier<NetworkEvent.Context> contextSupplier)
(package private) void
handleRegistryMessage(FMLHandshakeMessages.S2CRegistry registryPacket, Supplier<NetworkEvent.Context> contextSupplier)
(package private) void
handleServerModListOnClient(FMLHandshakeMessages.S2CModList serverModList, Supplier<NetworkEvent.Context> c)
static <MSG extends IntSupplier>
BiConsumer<MSG,Supplier<NetworkEvent.Context>>indexFirst(ThreeConsumer<FMLHandshakeHandler,MSG,Supplier<NetworkEvent.Context>> next)
Transforms a two-argument instance method reference into aBiConsumer
biConsumerFor(ThreeConsumer)
, first calling thehandleIndexedMessage(IntSupplier, Supplier)
method to handle index tracking.(package private) static void
registerHandshake(Connection manager, NetworkDirection direction)
Create a new handshake instance.(package private) static boolean
tickLogin(Connection networkManager)
boolean
FML will send packets, from Server to Client, from the messages queue until the queue is drained.
-
Field Details
-
FMLHSMARKER
static final org.apache.logging.log4j.Marker FMLHSMARKER -
LOGGER
private static final org.apache.logging.log4j.Logger LOGGER -
loginWrapper
-
messageList
-
sentMessages
-
direction
-
manager
-
packetPosition
private int packetPosition -
registrySnapshots
-
registriesToReceive
-
registryHashes
-
-
Constructor Details
-
FMLHandshakeHandler
-
-
Method Details
-
registerHandshake
Create a new handshake instance. Called when connection is first created during theClientIntentionPacket
handling.- Parameters:
manager
- The network manager for this connectiondirection
- TheNetworkDirection
for this connection:NetworkDirection.LOGIN_TO_SERVER
orNetworkDirection.LOGIN_TO_CLIENT
-
tickLogin
-
biConsumerFor
public static <MSG extends IntSupplier> BiConsumer<MSG,Supplier<NetworkEvent.Context>> biConsumerFor(ThreeConsumer<FMLHandshakeHandler,? super MSG,? super Supplier<NetworkEvent.Context>> consumer)Transforms a two-argument instance method reference into aBiConsumer
based on thegetHandshake(Supplier)
function. This should only be used for login message types.- Type Parameters:
MSG
- message type- Parameters:
consumer
- A two argument instance method reference- Returns:
- A
BiConsumer
for use in message handling
-
indexFirst
public static <MSG extends IntSupplier> BiConsumer<MSG,Supplier<NetworkEvent.Context>> indexFirst(ThreeConsumer<FMLHandshakeHandler,MSG,Supplier<NetworkEvent.Context>> next)Transforms a two-argument instance method reference into aBiConsumer
biConsumerFor(ThreeConsumer)
, first calling thehandleIndexedMessage(IntSupplier, Supplier)
method to handle index tracking. Used for client to server replies. This should only be used for login messages.- Type Parameters:
MSG
- message type- Parameters:
next
- The method reference to call after index handling- Returns:
- A
BiConsumer
for use in message handling
-
getHandshake
Retrieve the handshake from theNetworkEvent.Context
- Parameters:
contextSupplier
- theNetworkEvent.Context
- Returns:
- The handshake handler for the connection
-
handleServerModListOnClient
void handleServerModListOnClient(FMLHandshakeMessages.S2CModList serverModList, Supplier<NetworkEvent.Context> c) -
handleIndexedMessage
-
handleClientModListOnServer
void handleClientModListOnServer(FMLHandshakeMessages.C2SModListReply clientModList, Supplier<NetworkEvent.Context> c) -
handleRegistryMessage
void handleRegistryMessage(FMLHandshakeMessages.S2CRegistry registryPacket, Supplier<NetworkEvent.Context> contextSupplier) -
handleRegistryLoading
-
handleClientAck
void handleClientAck(FMLHandshakeMessages.C2SAcknowledge msg, Supplier<NetworkEvent.Context> contextSupplier) -
handleConfigSync
void handleConfigSync(FMLHandshakeMessages.S2CConfigData msg, Supplier<NetworkEvent.Context> contextSupplier) -
tickServer
public boolean tickServer()FML will send packets, from Server to Client, from the messages queue until the queue is drained. Each message will be indexed, and placed into the "pending acknowledgement" queue. As indexed packets are received at the server, they will be removed from the "pending acknowledgement" queue. Once the pending queue is drained, this method returns true - indicating that login processing can proceed to the next step.- Returns:
- true if there is no more need to tick this login connection.
-