Class AbstractNetworkAddon<H>

java.lang.Object

net.fabricmc.fabric.impl.networking.AbstractNetworkAddon<H>

Type Parameters:

H - the channel handler type

Direct Known Subclasses:

AbstractChanneledNetworkAddon, ClientLoginNetworkAddon, ServerLoginNetworkAddon

public abstract class AbstractNetworkAddon<H>
extends Object

A network addon is a simple abstraction to hold information about a player's registered channels.

Field Summary

Fields

Modifier and Type	Field	Description
protected final org.slf4j.Logger	logger
protected final GlobalReceiverRegistry<H>	receiver

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractNetworkAddon(GlobalReceiverRegistry<H> receiver, String description)

Method Summary

Modifier and Type	Method	Description
final void	endSession()
@Nullable H	getHandler(net.minecraft.resources.Identifier channel)
Set<net.minecraft.resources.Identifier>	getReceivableChannels()
final void	handleDisconnect()
protected abstract void	handleRegistration(net.minecraft.resources.Identifier channelName)
protected abstract void	handleUnregistration(net.minecraft.resources.Identifier channelName)
protected abstract void	invokeDisconnectEvent()
protected abstract void	invokeInitEvent()
protected abstract boolean	isReservedChannel(net.minecraft.resources.Identifier channelName)	Checks if a channel is considered a "reserved" channel.
final void	lateInit()
boolean	registerChannel(net.minecraft.resources.Identifier channelName, H handler)
void	registerChannels(Map<net.minecraft.resources.Identifier, H> map)
H	unregisterChannel(net.minecraft.resources.Identifier channelName)

Methods inherited from class Object

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

Field Details

receiver

protected final GlobalReceiverRegistry<H> receiver

logger

protected final org.slf4j.Logger logger

Constructor Details

AbstractNetworkAddon

protected AbstractNetworkAddon(GlobalReceiverRegistry<H> receiver,
 String description)

Method Details

lateInit

public final void lateInit()

invokeInitEvent

protected abstract void invokeInitEvent()

endSession

public final void endSession()

getHandler

public @Nullable H getHandler(net.minecraft.resources.Identifier channel)

registerChannels

public void registerChannels(Map<net.minecraft.resources.Identifier, H> map)

registerChannel

public boolean registerChannel(net.minecraft.resources.Identifier channelName,
 H handler)

unregisterChannel

public H unregisterChannel(net.minecraft.resources.Identifier channelName)

getReceivableChannels

public Set<net.minecraft.resources.Identifier> getReceivableChannels()

handleRegistration

protected abstract void handleRegistration(net.minecraft.resources.Identifier channelName)

handleUnregistration

protected abstract void handleUnregistration(net.minecraft.resources.Identifier channelName)

handleDisconnect

public final void handleDisconnect()

invokeDisconnectEvent

protected abstract void invokeDisconnectEvent()

isReservedChannel

protected abstract boolean isReservedChannel(net.minecraft.resources.Identifier channelName)

Checks if a channel is considered a "reserved" channel. A reserved channel such as "minecraft:(un)register" has special handling and should not have any channel handlers registered for it.

Parameters:

channelName - the channel name

Returns:

whether the channel is reserved