Package net.neoforged.neoforge.network.simple

Class SimpleChannel

java.lang.Object

net.neoforged.neoforge.network.simple.SimpleChannel

public class SimpleChannel
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static final record	SimpleChannel.LoginPacketEntry
static class	SimpleChannel.MessageBuilder<MSG>

Field Summary

Fields

Modifier and Type	Field	Description
private final IndexedMessageCodec	indexedCodec
private final NetworkInstance	instance
private final List<SimpleChannel.LoginPacketEntry>	loginPackets
private final Optional<Consumer<NetworkEvent.ChannelRegistrationChangeEvent>>	registryChangeConsumer

Constructor Summary

Constructors

Modifier	Constructor	Description
	SimpleChannel(NetworkInstance instance)
	SimpleChannel(NetworkInstance instance, Consumer<NetworkEvent.ChannelRegistrationChangeEvent> registryChangeNotify)
private	SimpleChannel(NetworkInstance instance, Optional<Consumer<NetworkEvent.ChannelRegistrationChangeEvent>> registryChangeNotify)

Method Summary

Modifier and Type	Method	Description
<MSG> int	encodeMessage(MSG message, FriendlyByteBuf target)
boolean	isRemotePresent(Connection manager)	Returns true if the channel is present in the given connection.
<M> SimpleChannel.MessageBuilder<M>	messageBuilder(Class<M> type, int id)	Build a new MessageBuilder.
<M> SimpleChannel.MessageBuilder<M>	messageBuilder(Class<M> type, int id, INetworkDirection<?> direction)	Build a new MessageBuilder.
private void	networkEventListener(NetworkEvent networkEvent)
private void	networkLoginGather(NetworkEvent.GatherLoginPayloadsEvent gatherEvent)
<MSG> IndexedMessageCodec.MessageHandler<MSG>	registerMessage(int index, Class<MSG> messageType, MessageFunctions.MessageEncoder<MSG> encoder, MessageFunctions.MessageDecoder<MSG> decoder, MessageFunctions.MessageConsumer<MSG> messageConsumer)
<MSG> IndexedMessageCodec.MessageHandler<MSG>	registerMessage(int index, Class<MSG> messageType, MessageFunctions.MessageEncoder<MSG> encoder, MessageFunctions.MessageDecoder<MSG> decoder, MessageFunctions.MessageConsumer<MSG> messageConsumer, Optional<INetworkDirection<?>> networkDirection)
<MSG> void	reply(MSG msgToReply, NetworkEvent.Context context)
<MSG> void	send(PacketDistributor.PacketTarget target, MSG message)	Send a message to the PacketDistributor.PacketTarget from a PacketDistributor instance.
<MSG> void	sendTo(MSG message, Connection manager, PlayNetworkDirection direction)
<MSG> void	sendToServer(MSG message)
<M extends SimpleLoginMessage> SimpleChannel.MessageBuilder<M>	simpleLoginMessageBuilder(Class<M> type, int id)	Build a new MessageBuilder for a login message that implements SimpleLoginMessage.
<M extends SimpleLoginMessage> SimpleChannel.MessageBuilder<M>	simpleLoginMessageBuilder(Class<M> type, int id, INetworkDirection<?> direction)	Build a new MessageBuilder for a login message that implements SimpleLoginMessage.
<M extends SimpleMessage> SimpleChannel.MessageBuilder<M>	simpleMessageBuilder(Class<M> type, int id)	Build a new MessageBuilder for a message that implements SimpleMessage.
<M extends SimpleMessage> SimpleChannel.MessageBuilder<M>	simpleMessageBuilder(Class<M> type, int id, INetworkDirection<?> direction)	Build a new MessageBuilder for a message that implements SimpleMessage.
private <MSG> INetworkDirection.PacketData	toBuffer(MSG msg)
<MSG> Packet<?>	toVanillaPacket(MSG message, PlayNetworkDirection direction)

Methods inherited from class java.lang.Object

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

Field Details

instance

private final NetworkInstance instance

indexedCodec

private final IndexedMessageCodec indexedCodec

registryChangeConsumer

private final Optional<Consumer<NetworkEvent.ChannelRegistrationChangeEvent>> registryChangeConsumer

loginPackets

private final List<SimpleChannel.LoginPacketEntry> loginPackets

Constructor Details

SimpleChannel

public SimpleChannel(NetworkInstance instance)

SimpleChannel

private SimpleChannel(NetworkInstance instance,
 Optional<Consumer<NetworkEvent.ChannelRegistrationChangeEvent>> registryChangeNotify)

SimpleChannel

public SimpleChannel(NetworkInstance instance,
 Consumer<NetworkEvent.ChannelRegistrationChangeEvent> registryChangeNotify)

Method Details

networkLoginGather

private void networkLoginGather(NetworkEvent.GatherLoginPayloadsEvent gatherEvent)

networkEventListener

private void networkEventListener(NetworkEvent networkEvent)

encodeMessage

public <MSG> int encodeMessage(MSG message,
 FriendlyByteBuf target)

registerMessage

public <MSG>
IndexedMessageCodec.MessageHandler<MSG> registerMessage(int index,
 Class<MSG> messageType,
 MessageFunctions.MessageEncoder<MSG> encoder,
 MessageFunctions.MessageDecoder<MSG> decoder,
 MessageFunctions.MessageConsumer<MSG> messageConsumer)

registerMessage

public <MSG>
IndexedMessageCodec.MessageHandler<MSG> registerMessage(int index,
 Class<MSG> messageType,
 MessageFunctions.MessageEncoder<MSG> encoder,
 MessageFunctions.MessageDecoder<MSG> decoder,
 MessageFunctions.MessageConsumer<MSG> messageConsumer,
 Optional<INetworkDirection<?>> networkDirection)

toBuffer

private <MSG> INetworkDirection.PacketData toBuffer(MSG msg)

sendToServer

public <MSG> void sendToServer(MSG message)

sendTo

public <MSG> void sendTo(MSG message,
 Connection manager,
 PlayNetworkDirection direction)

send

public <MSG> void send(PacketDistributor.PacketTarget target,
 MSG message)

Send a message to the PacketDistributor.PacketTarget from a PacketDistributor instance.

 channel.send(PacketDistributor.PLAYER.with(() -> player), message)
 

Type Parameters:

MSG - The type of the message

Parameters:

target - The curried target from a PacketDistributor

message - The message to send

toVanillaPacket

public <MSG> Packet<?> toVanillaPacket(MSG message,
 PlayNetworkDirection direction)

reply

public <MSG> void reply(MSG msgToReply,
 NetworkEvent.Context context)

isRemotePresent

public boolean isRemotePresent(Connection manager)

Returns true if the channel is present in the given connection.

Returns:

true if the channel is present in the given connection

messageBuilder

public <M> SimpleChannel.MessageBuilder<M> messageBuilder(Class<M> type,
 int id)

Build a new MessageBuilder. The type should implement IntSupplier if it is a login packet.

Type Parameters:

M - Type of type

Parameters:

type - Type of message

id - id in the indexed codec

Returns:

a MessageBuilder

messageBuilder

public <M> SimpleChannel.MessageBuilder<M> messageBuilder(Class<M> type,
 int id,
 INetworkDirection<?> direction)

Build a new MessageBuilder. The type should implement IntSupplier if it is a login packet.

Type Parameters:

M - Type of type

Parameters:

type - Type of message

id - id in the indexed codec

direction - a impl direction which will be asserted before any processing of this message occurs. Use to enforce strict sided handling to prevent spoofing.

Returns:

a MessageBuilder

simpleMessageBuilder

public <M extends SimpleMessage>
SimpleChannel.MessageBuilder<M> simpleMessageBuilder(Class<M> type,
 int id)

Build a new MessageBuilder for a message that implements SimpleMessage. This will automatically set the encoder and the handler.

Type Parameters:

M - the type of the message

Parameters:

type - the type of message

id - the id in the indexed codec

Returns:

a MessageBuilder

simpleMessageBuilder

public <M extends SimpleMessage>
SimpleChannel.MessageBuilder<M> simpleMessageBuilder(Class<M> type,
 int id,
 INetworkDirection<?> direction)

Build a new MessageBuilder for a message that implements SimpleMessage. This will automatically set the encoder and the handler.

Type Parameters:

M - the type of the message

Parameters:

type - the type of message

id - the id in the indexed codec

direction - a impl direction which will be asserted before any processing of this message occurs. Use to enforce strict sided handling to prevent spoofing.

Returns:

a MessageBuilder

simpleLoginMessageBuilder

public <M extends SimpleLoginMessage>
SimpleChannel.MessageBuilder<M> simpleLoginMessageBuilder(Class<M> type,
 int id)

Build a new MessageBuilder for a login message that implements SimpleLoginMessage. This will automatically set the encoder, the handler and the login index setter and getter.

Type Parameters:

M - the type of the message

Parameters:

type - the type of message

id - the id in the indexed codec

Returns:

a MessageBuilder

simpleLoginMessageBuilder

public <M extends SimpleLoginMessage>
SimpleChannel.MessageBuilder<M> simpleLoginMessageBuilder(Class<M> type,
 int id,
 INetworkDirection<?> direction)

Build a new MessageBuilder for a login message that implements SimpleLoginMessage. This will automatically set the encoder, the handler and the login index setter and getter.

Type Parameters:

M - the type of the message

Parameters:

type - the type of message

id - the id in the indexed codec

direction - a impl direction which will be asserted before any processing of this message occurs. Use to enforce strict sided handling to prevent spoofing.

Returns:

a MessageBuilder