net.minecraftforge.fml.network

Class NetworkRegistry

java.lang.Object

net.minecraftforge.fml.network.NetworkRegistry

public class NetworkRegistry
extends java.lang.Object

The network registry. Tracks channels on behalf of mods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NetworkRegistry.ChannelBuilder Builder for constructing network 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 and Description
static java.lang.String	ABSENT Special value for clientAcceptedVersions and serverAcceptedVersions predicates indicating the other side lacks this channel.
static java.lang.String	ACCEPTVANILLA
private static java.util.Map<ResourceLocation,NetworkInstance>	instances
private static boolean	lock
private static org.apache.logging.log4j.Logger	LOGGER
private static org.apache.logging.log4j.Marker	NETREGISTRY

Constructor Summary

Constructors

Constructor and Description
NetworkRegistry()

Method Summary

Modifier and Type	Method and Description
static boolean	acceptsVanillaClientConnections()
(package private) static java.util.Map<ResourceLocation,java.lang.String>	buildChannelVersions() Construct the Map representation of the channel list, for use during login handshaking
(package private) static java.util.Map<ResourceLocation,org.apache.commons.lang3.tuple.Pair<java.lang.String,java.lang.Boolean>>	buildChannelVersionsForListPing() Construct the Map representation of the channel list, for the client to check against during list ping
static boolean	canConnectToVanillaServer()
static boolean	checkListPingCompatibilityForClient(java.util.Map<ResourceLocation,org.apache.commons.lang3.tuple.Pair<java.lang.String,java.lang.Boolean>> incoming)
private static NetworkInstance	createInstance(ResourceLocation name, java.util.function.Supplier<java.lang.String> networkProtocolVersion, java.util.function.Predicate<java.lang.String> clientAcceptedVersions, java.util.function.Predicate<java.lang.String> serverAcceptedVersions) Creates the internal NetworkInstance that tracks the channel data.
(package private) static java.util.Optional<NetworkInstance>	findTarget(ResourceLocation resourceLocation) Find the NetworkInstance, if possible
(package private) static java.util.List<NetworkRegistry.LoginPayload>	gatherLoginPayloads(NetworkDirection direction, boolean isLocal) Retrieve the NetworkRegistry.LoginPayload list for dispatch during FMLHandshakeHandler.tickLogin(NetworkManager) handling.
static java.util.List<java.lang.String>	getClientNonVanillaNetworkMods()
static java.util.List<java.lang.String>	getServerNonVanillaNetworkMods()
boolean	isLocked()
(package private) static java.util.List<java.lang.String>	listRejectedVanillaMods(java.util.function.BiFunction<NetworkInstance,java.lang.String,java.lang.Boolean> testFunction)
static void	lock()
static EventNetworkChannel	newEventChannel(ResourceLocation name, java.util.function.Supplier<java.lang.String> networkProtocolVersion, java.util.function.Predicate<java.lang.String> clientAcceptedVersions, java.util.function.Predicate<java.lang.String> serverAcceptedVersions) Create a new EventNetworkChannel.
static SimpleChannel	newSimpleChannel(ResourceLocation name, java.util.function.Supplier<java.lang.String> networkProtocolVersion, java.util.function.Predicate<java.lang.String> clientAcceptedVersions, java.util.function.Predicate<java.lang.String> serverAcceptedVersions) Create a new SimpleChannel.
private static boolean	validateChannels(java.util.Map<ResourceLocation,java.lang.String> incoming, java.lang.String originName, java.util.function.BiFunction<NetworkInstance,java.lang.String,java.lang.Boolean> testFunction) Tests if the map matches with the supplied predicate tester
(package private) static boolean	validateClientChannels(java.util.Map<ResourceLocation,java.lang.String> channels) Validate the channels from the server on the client.
(package private) static boolean	validateServerChannels(java.util.Map<ResourceLocation,java.lang.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 Detail

LOGGER

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

NETREGISTRY

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

instances

private static java.util.Map<ResourceLocation,NetworkInstance> instances

ABSENT

public static java.lang.String ABSENT

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

ACCEPTVANILLA

public static java.lang.String ACCEPTVANILLA

lock

private static boolean lock

Constructor Detail

NetworkRegistry

public NetworkRegistry()

Method Detail

getServerNonVanillaNetworkMods

public static java.util.List<java.lang.String> getServerNonVanillaNetworkMods()

getClientNonVanillaNetworkMods

public static java.util.List<java.lang.String> getClientNonVanillaNetworkMods()

acceptsVanillaClientConnections

public static boolean acceptsVanillaClientConnections()

canConnectToVanillaServer

public static boolean canConnectToVanillaServer()

newSimpleChannel

public static SimpleChannel newSimpleChannel(ResourceLocation name,
                                             java.util.function.Supplier<java.lang.String> networkProtocolVersion,
                                             java.util.function.Predicate<java.lang.String> clientAcceptedVersions,
                                             java.util.function.Predicate<java.lang.String> serverAcceptedVersions)

Create a new SimpleChannel.

Parameters:

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

networkProtocolVersion - The network 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,
                                                  java.util.function.Supplier<java.lang.String> networkProtocolVersion,
                                                  java.util.function.Predicate<java.lang.String> clientAcceptedVersions,
                                                  java.util.function.Predicate<java.lang.String> serverAcceptedVersions)

Create a new EventNetworkChannel.

Parameters:

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

networkProtocolVersion - The network 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,
                                              java.util.function.Supplier<java.lang.String> networkProtocolVersion,
                                              java.util.function.Predicate<java.lang.String> clientAcceptedVersions,
                                              java.util.function.Predicate<java.lang.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:

java.lang.IllegalArgumentException - if the name already exists

findTarget

static java.util.Optional<NetworkInstance> findTarget(ResourceLocation resourceLocation)

Find the NetworkInstance, if possible

Parameters:

resourceLocation - The network instance to lookup

Returns:

The Optional NetworkInstance

buildChannelVersions

static java.util.Map<ResourceLocation,java.lang.String> buildChannelVersions()

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

See Also:

FMLHandshakeMessages.S2CModList, FMLHandshakeMessages.C2SModListReply

buildChannelVersionsForListPing

static java.util.Map<ResourceLocation,org.apache.commons.lang3.tuple.Pair<java.lang.String,java.lang.Boolean>> buildChannelVersionsForListPing()

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

See Also:

FMLHandshakeMessages.S2CModList, FMLHandshakeMessages.C2SModListReply

listRejectedVanillaMods

static java.util.List<java.lang.String> listRejectedVanillaMods(java.util.function.BiFunction<NetworkInstance,java.lang.String,java.lang.Boolean> testFunction)

validateClientChannels

static boolean validateClientChannels(java.util.Map<ResourceLocation,java.lang.String> channels)

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

Parameters:

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

Returns:

true if all channels accept themselves

validateServerChannels

static boolean validateServerChannels(java.util.Map<ResourceLocation,java.lang.String> channels)

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

Parameters:

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

Returns:

true if all channels accept themselves

validateChannels

private static boolean validateChannels(java.util.Map<ResourceLocation,java.lang.String> incoming,
                                        java.lang.String originName,
                                        java.util.function.BiFunction<NetworkInstance,java.lang.String,java.lang.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:

true if all channels accept themselves

gatherLoginPayloads

static java.util.List<NetworkRegistry.LoginPayload> gatherLoginPayloads(NetworkDirection direction,
                                                                        boolean isLocal)

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

Parameters:

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

Returns:

The NetworkRegistry.LoginPayload list

checkListPingCompatibilityForClient

public static boolean checkListPingCompatibilityForClient(java.util.Map<ResourceLocation,org.apache.commons.lang3.tuple.Pair<java.lang.String,java.lang.Boolean>> incoming)

isLocked

public boolean isLocked()

lock

public static void lock()