Package codechicken.lib.packet

Class StreamNetworkChannel

java.lang.Object

codechicken.lib.packet.StreamNetworkChannel

public final class StreamNetworkChannel
extends Object

A simple Stream based network channel, very similar to the NeoForge api, however provides raw, stream-based packets.

You would construct one of these and store it statically, see CCLNetwork for inspiration.

Created by covers1624 on 10/26/25.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	StreamNetworkChannel.BidirectionalPacketHandle	A handle for constructing a packet bound for a client or the server.
static interface	StreamNetworkChannel.ClientPacketHandle	A handle for constructing client-bound packets.
static interface	StreamNetworkChannel.ConfigurationContext	The context available when executing a configuration task.
static interface	StreamNetworkChannel.ConfigurationHandler	A helpful interface for the configuration phase packet handler type.
static interface	StreamNetworkChannel.ConfigurationPacketHandle
static interface	StreamNetworkChannel.ConfigurationTaskFactory	A factory for constructing ICustomConfigurationTask instances.
static interface	StreamNetworkChannel.PlayHandler	A helpful interface for the gameplay packet handler type.
static interface	StreamNetworkChannel.ServerPacketHandle	A handle for constructing server-bound packets.

Constructor Summary

Constructors

Constructor	Description
StreamNetworkChannel(String namespace)	Create a new network channel.

Method Summary

Modifier and Type	Method	Description
void	assignClientHandler(StreamNetworkChannel.ClientPacketHandle handle, StreamNetworkChannel.PlayHandler handler)	Assign the client-side handler for a packet.
void	assignClientHandler(StreamNetworkChannel.ConfigurationPacketHandle handle, StreamNetworkChannel.ConfigurationHandler handler)	Assign the client-side handler for a configuration task packet.
StreamNetworkChannel.ConfigurationPacketHandle	configurationToClient(String name, StreamNetworkChannel.ConfigurationTaskFactory factory)	Register a packet to configure a connecting client.
void	init(net.neoforged.bus.api.IEventBus bus, net.neoforged.fml.ModContainer container)	Called with your mod event bus and mod container.
StreamNetworkChannel	optional()	Mark this network channel as optional, not required on the client/server.
StreamNetworkChannel.BidirectionalPacketHandle	playBidirectional(String name, StreamNetworkChannel.PlayHandler serverHandler)	Register a packet to be set to either the client or the server during gameplay.
StreamNetworkChannel.ClientPacketHandle	playToClient(String name)	Register a packet to be set to the client during gameplay.
StreamNetworkChannel.ServerPacketHandle	playToServer(String name, StreamNetworkChannel.PlayHandler handler)	Register a packet to be set to the server during gameplay.

Methods inherited from class java.lang.Object

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

Constructor Details

StreamNetworkChannel

public StreamNetworkChannel(String namespace)

Create a new network channel.

Parameters:

namespace - The namespace, usually your mod id.

Method Details

init

public void init(net.neoforged.bus.api.IEventBus bus,
 net.neoforged.fml.ModContainer container)

Called with your mod event bus and mod container.

Parameters:

bus - Your mod event bus.

container - Your mod container.

optional

public StreamNetworkChannel optional()

Mark this network channel as optional, not required on the client/server.

Returns:

The same channel.

playToClient

public StreamNetworkChannel.ClientPacketHandle playToClient(String name)

Register a packet to be set to the client during gameplay.

The packet handle must be assigned via assignClientHandler(codechicken.lib.packet.StreamNetworkChannel.ClientPacketHandle, codechicken.lib.packet.StreamNetworkChannel.PlayHandler) on the client-side only.

Parameters:

name - The name of the packet.

Returns:

A handle to construct packets.

See Also:

• assignClientHandler(ClientPacketHandle, PlayHandler)

playToServer

public StreamNetworkChannel.ServerPacketHandle playToServer(String name,
 StreamNetworkChannel.PlayHandler handler)

Register a packet to be set to the server during gameplay.

Parameters:

name - The name of the packet.

handler - The handler for the packet.

Returns:

A handle to construct packets.

playBidirectional

public StreamNetworkChannel.BidirectionalPacketHandle playBidirectional(String name,
 StreamNetworkChannel.PlayHandler serverHandler)

Register a packet to be set to either the client or the server during gameplay.

The packet's client handle must be assigned via assignClientHandler(codechicken.lib.packet.StreamNetworkChannel.ClientPacketHandle, codechicken.lib.packet.StreamNetworkChannel.PlayHandler) on the client-side only.

Parameters:

name - The name of the packet.

serverHandler - The handler for the packet server-side.

Returns:

A handle to construct packets.

See Also:

• assignClientHandler(ClientPacketHandle, PlayHandler)

assignClientHandler

public void assignClientHandler(StreamNetworkChannel.ClientPacketHandle handle,
 StreamNetworkChannel.PlayHandler handler)

Assign the client-side handler for a packet.

Parameters:

handle - The packet handle to attach to.

handler - The handler.

configurationToClient

public StreamNetworkChannel.ConfigurationPacketHandle configurationToClient(String name,
 StreamNetworkChannel.ConfigurationTaskFactory factory)

Register a packet to configure a connecting client.

Parameters:

name - The name of the packet.

factory - The factory to construct a ICustomConfigurationTask.

Returns:

The packet handle.

assignClientHandler

public void assignClientHandler(StreamNetworkChannel.ConfigurationPacketHandle handle,
 StreamNetworkChannel.ConfigurationHandler handler)

Assign the client-side handler for a configuration task packet.

Parameters:

handle - The packet handle to attach to.

handler - The handler.