Package net.neoforged.neoforge.network

Class NetworkRegistry

java.lang.Object

net.neoforged.neoforge.network.NetworkRegistry

public class NetworkRegistry
extends Object

The impl registry. Tracks channels on behalf of mods.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	NetworkRegistry.ChannelBuilder	Builder for constructing impl channels using a builder style API.
static class	NetworkRegistry.LoginPayload	Tracks individual outbound messages for dispatch to clients during login handling.

Field Summary

Fields

Modifier and Type	Field	Description
static ServerStatusPing.ChannelData	ABSENT	Special value for clientAcceptedVersions and serverAcceptedVersions predicates indicating the other side lacks this channel.
static String	ACCEPTVANILLA
private static Map<ResourceLocation,NetworkInstance>	instances
private static boolean	lock
private static final org.apache.logging.log4j.Logger	LOGGER
private static final org.apache.logging.log4j.Marker	NETREGISTRY

Constructor Summary

Constructors

Constructor	Description
NetworkRegistry()

Method Summary

Modifier and Type	Method	Description
static Predicate<String>	acceptMissingOr(String protocolVersion)	Makes a version predicate that accepts connections to vanilla or without the channel.
static Predicate<String>	acceptMissingOr(Predicate<String> versionCheck)	Makes a version predicate that accepts connections to vanilla or without the channel.
static boolean	acceptsVanillaClientConnections()
(package private) static Map<ResourceLocation,String>	buildChannelVersions()	Construct the Map representation of the channel list, for use during login handshaking
(package private) static Map<ResourceLocation,ServerStatusPing.ChannelData>	buildChannelVersionsForListPing()	Construct the Map representation of the channel list, for the client to check against during list ping
static boolean	canConnectToVanillaServer()
static boolean	checkListPingCompatibilityForClient(Map<ResourceLocation,ServerStatusPing.ChannelData> incoming)
private static NetworkInstance	createInstance(ResourceLocation name, Supplier<String> networkProtocolVersion, Predicate<String> clientAcceptedVersions, Predicate<String> serverAcceptedVersions)	Creates the internal NetworkInstance that tracks the channel data.
(package private) static Optional<NetworkInstance>	findTarget(ResourceLocation resourceLocation)	Find the NetworkInstance, if possible
(package private) static List<NetworkRegistry.LoginPayload>	gatherLoginPayloads(LoginNetworkDirection direction, boolean isLocal)	Retrieve the NetworkRegistry.LoginPayload list for dispatch during HandshakeHandler.tickLogin(Connection) handling.
static List<String>	getClientNonVanillaNetworkMods()
static List<String>	getServerNonVanillaNetworkMods()
boolean	isLocked()
(package private) static List<String>	listRejectedVanillaMods(BiFunction<NetworkInstance,String,Boolean> testFunction)
static void	lock()
static EventNetworkChannel	newEventChannel(ResourceLocation name, Supplier<String> networkProtocolVersion, Predicate<String> clientAcceptedVersions, Predicate<String> serverAcceptedVersions)	Create a new EventNetworkChannel.
static SimpleChannel	newSimpleChannel(ResourceLocation name, Supplier<String> networkProtocolVersion, Predicate<String> clientAcceptedVersions, Predicate<String> serverAcceptedVersions)	Create a new SimpleChannel.
private static Map<ResourceLocation,String>	validateChannels(Map<ResourceLocation,String> incoming, String originName, BiFunction<NetworkInstance,String,Boolean> testFunction)	Tests if the map matches with the supplied predicate tester
(package private) static Map<ResourceLocation,String>	validateClientChannels(Map<ResourceLocation,String> channels)	Validate the channels from the server on the client.
(package private) static Map<ResourceLocation,String>	validateServerChannels(Map<ResourceLocation,String> channels)	Validate the channels from the client on the server.

Methods inherited from class java.lang.Object

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

Field Details

LOGGER

private static final org.apache.logging.log4j.Logger LOGGER

NETREGISTRY

private static final org.apache.logging.log4j.Marker NETREGISTRY

instances

private static Map<ResourceLocation,NetworkInstance> instances

ABSENT

public static ServerStatusPing.ChannelData ABSENT

Special value for clientAcceptedVersions and serverAcceptedVersions predicates indicating the other side lacks this channel.

ACCEPTVANILLA

public static String ACCEPTVANILLA

lock

private static boolean lock

Constructor Details

NetworkRegistry

public NetworkRegistry()

Method Details

acceptMissingOr

public static Predicate<String> acceptMissingOr(String protocolVersion)

Makes a version predicate that accepts connections to vanilla or without the channel.

Parameters:

protocolVersion - The protocol version, which will be matched exactly.

Returns:

A new predicate with the new conditions.

acceptMissingOr

public static Predicate<String> acceptMissingOr(Predicate<String> versionCheck)

Makes a version predicate that accepts connections to vanilla or without the channel.

Parameters:

versionCheck - The main version predicate, which should check the version number of the protocol.

Returns:

A new predicate with the new conditions.

getServerNonVanillaNetworkMods

public static List<String> getServerNonVanillaNetworkMods()

getClientNonVanillaNetworkMods

public static List<String> getClientNonVanillaNetworkMods()

acceptsVanillaClientConnections

public static boolean acceptsVanillaClientConnections()

canConnectToVanillaServer

public static boolean canConnectToVanillaServer()

newSimpleChannel

public static SimpleChannel newSimpleChannel(ResourceLocation name,
 Supplier<String> networkProtocolVersion,
 Predicate<String> clientAcceptedVersions,
 Predicate<String> serverAcceptedVersions)

Create a new SimpleChannel.

Parameters:

name - The registry name for this channel. Must be unique

networkProtocolVersion - The impl protocol version string that will be offered to the remote side NetworkRegistry.ChannelBuilder.networkProtocolVersion(Supplier)

clientAcceptedVersions - Called on the client with the networkProtocolVersion string from the server NetworkRegistry.ChannelBuilder.clientAcceptedVersions(Predicate)

serverAcceptedVersions - Called on the server with the networkProtocolVersion string from the client NetworkRegistry.ChannelBuilder.serverAcceptedVersions(Predicate)

Returns:

A new SimpleChannel

See Also:

• newSimpleChannel(ResourceLocation, Supplier, Predicate, Predicate)

newEventChannel

public static EventNetworkChannel newEventChannel(ResourceLocation name,
 Supplier<String> networkProtocolVersion,
 Predicate<String> clientAcceptedVersions,
 Predicate<String> serverAcceptedVersions)

Create a new EventNetworkChannel.

Parameters:

name - The registry name for this channel. Must be unique

networkProtocolVersion - The impl protocol version string that will be offered to the remote side NetworkRegistry.ChannelBuilder.networkProtocolVersion(Supplier)

clientAcceptedVersions - Called on the client with the networkProtocolVersion string from the server NetworkRegistry.ChannelBuilder.clientAcceptedVersions(Predicate)

serverAcceptedVersions - Called on the server with the networkProtocolVersion string from the client NetworkRegistry.ChannelBuilder.serverAcceptedVersions(Predicate)

Returns:

A new EventNetworkChannel

See Also:

• newEventChannel(ResourceLocation, Supplier, Predicate, Predicate)

createInstance

private static NetworkInstance createInstance(ResourceLocation name,
 Supplier<String> networkProtocolVersion,
 Predicate<String> clientAcceptedVersions,
 Predicate<String> serverAcceptedVersions)

Creates the internal NetworkInstance that tracks the channel data.

Parameters:

name - registry name

networkProtocolVersion - The protocol version string

clientAcceptedVersions - The client accepted predicate

serverAcceptedVersions - The server accepted predicate

Returns:

The NetworkInstance

Throws:

IllegalArgumentException - if the name already exists

findTarget

static Optional<NetworkInstance> findTarget(ResourceLocation resourceLocation)

Find the NetworkInstance, if possible

Parameters:

resourceLocation - The impl instance to lookup

Returns:

The Optional NetworkInstance

buildChannelVersions

static Map<ResourceLocation,String> buildChannelVersions()

Construct the Map representation of the channel list, for use during login handshaking

See Also:

• HandshakeMessages.S2CModList
• HandshakeMessages.C2SModListReply

buildChannelVersionsForListPing

static Map<ResourceLocation,ServerStatusPing.ChannelData> buildChannelVersionsForListPing()

Construct the Map representation of the channel list, for the client to check against during list ping

See Also:

• HandshakeMessages.S2CModList
• HandshakeMessages.C2SModListReply

listRejectedVanillaMods

static List<String> listRejectedVanillaMods(BiFunction<NetworkInstance,String,Boolean> testFunction)

validateClientChannels

static Map<ResourceLocation,String> validateClientChannels(Map<ResourceLocation,String> channels)

Validate the channels from the server on the client. Tests the client predicates against the server supplied impl protocol version.

Parameters:

channels - An @Map of name->version pairs for testing

Returns:

a map of mismatched channel ids and versions, or an empty map if all channels accept themselves

validateServerChannels

static Map<ResourceLocation,String> validateServerChannels(Map<ResourceLocation,String> channels)

Validate the channels from the client on the server. Tests the server predicates against the client supplied impl protocol version.

Parameters:

channels - An @Map of name->version pairs for testing

Returns:

a map of mismatched channel ids and versions, or an empty map if all channels accept themselves

validateChannels

private static Map<ResourceLocation,String> validateChannels(Map<ResourceLocation,String> incoming,
 String originName,
 BiFunction<NetworkInstance,String,Boolean> testFunction)

Tests if the map matches with the supplied predicate tester

Parameters:

incoming - An @Map of name->version pairs for testing

originName - A label for use in logging (where the version pairs came from)

testFunction - The test function to use for testing

Returns:

a map of mismatched channel ids and versions, or an empty map if all channels accept themselves

gatherLoginPayloads

static List<NetworkRegistry.LoginPayload> gatherLoginPayloads(LoginNetworkDirection direction,
 boolean isLocal)

Retrieve the NetworkRegistry.LoginPayload list for dispatch during HandshakeHandler.tickLogin(Connection) handling. Dispatches NetworkEvent.GatherLoginPayloadsEvent to each NetworkInstance.

Parameters:

direction - the impl direction for the request - only gathers for LOGIN_TO_CLIENT

Returns:

The NetworkRegistry.LoginPayload list

checkListPingCompatibilityForClient

public static boolean checkListPingCompatibilityForClient(Map<ResourceLocation,ServerStatusPing.ChannelData> incoming)

isLocked

public boolean isLocked()

lock

public static void lock()