Package net.minecraftforge.network

Record Class PayloadChannel.Builder.HandlerFlow<BUF extends FriendlyByteBuf,CTX,BASE extends CustomPacketPayload & SimplePacket<CTX>>

java.lang.Object

java.lang.Record

net.minecraftforge.network.PayloadChannel.Builder.HandlerFlow<BUF,CTX,BASE>

All Implemented Interfaces:

ChannelBuildable<CustomPacketPayload>, PayloadHandlerFlow<BUF,BASE>, PayloadHandlerProtocol<BUF,BASE>, PayloadConnection<BASE>, PayloadChannel.Builder.ProtocolFactory<BUF,BASE>, BaseProtocol<PayloadHandlerFlow<BUF,BASE>,PayloadHandlerProtocol<BUF,BASE>>

Enclosing class:

PayloadChannel.Builder

private static record PayloadChannel.Builder.HandlerFlow<BUF extends FriendlyByteBuf,CTX,BASE extends CustomPacketPayload & SimplePacket<CTX>>(io.netty.util.AttributeKey<CTX> key, PayloadChannel.Builder.BuilderContext<BUF extends FriendlyByteBuf,BASE extends CustomPacketPayload & SimplePacket<CTX>> ctx)
extends Record
implements PayloadChannel.Builder.ProtocolFactory<BUF,BASE>, PayloadHandlerFlow<BUF,BASE>

Field Summary

Fields

Modifier and Type	Field	Description
private final PayloadChannel.Builder.BuilderContext<BUF,BASE>	ctx	The field for the ctx record component.
private final io.netty.util.AttributeKey<CTX>	key	The field for the key record component.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	HandlerFlow(io.netty.util.AttributeKey<CTX> key, PayloadChannel.Builder.BuilderContext<BUF,BASE> ctx)	Creates an instance of a HandlerFlow record class.

Method Summary

Modifier and Type	Method	Description
<MSG extends BASE> PayloadHandlerFlow<BUF,BASE>	add(CustomPacketPayload.Type<MSG> type, StreamCodec<BUF,MSG> codec)	Adds a packet to this channel that has it's protocol validated whenever sent or received.
<MSG extends BASE> PayloadHandlerFlow<BUF,BASE>	add(CustomPacketPayload.Type<MSG> type, StreamCodec<BUF,MSG> codec, BiConsumer<MSG,CustomPayloadEvent.Context> consumer)	Adds a packet to this channel that has it's protocol validated whenever sent or received.
<MSG extends BASE> PayloadHandlerFlow<BUF,BASE>	addMain(CustomPacketPayload.Type<MSG> type, StreamCodec<BUF,MSG> codec)	Adds a packet to this channel that has it's protocol validated whenever sent or received.
PayloadChannel.Builder.BuilderContext<BUF,BASE>	ctx()	Returns the value of the ctx record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
PayloadHandlerFlow<BUF,BASE>	flow(@Nullable PacketFlow flow)
final int	hashCode()	Returns a hash code value for this object.
io.netty.util.AttributeKey<CTX>	key()	Returns the value of the key record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.minecraftforge.network.simple.BaseProtocol

bidirectional, bidirectional, clientbound, clientbound, flow, flow, serverbound, serverbound

Methods inherited from interface net.minecraftforge.network.PayloadChannel.Builder.ProtocolFactory

build, protocol, protocol

Methods inherited from interface net.minecraftforge.network.payload.PayloadConnection

any, any, any, any, configuration, configuration, configuration, configuration, login, login, login, login, play, play, play, play, protocol, protocol

Field Details

key

private final io.netty.util.AttributeKey<CTX> key

The field for the key record component.

ctx

private final PayloadChannel.Builder.BuilderContext<BUF extends FriendlyByteBuf,BASE extends CustomPacketPayload & SimplePacket<CTX>> ctx

The field for the ctx record component.

Constructor Details

HandlerFlow

private HandlerFlow(io.netty.util.AttributeKey<CTX> key,
 PayloadChannel.Builder.BuilderContext<BUF,BASE> ctx)

Creates an instance of a HandlerFlow record class.

Parameters:

key - the value for the key record component

ctx - the value for the ctx record component

Method Details

add

public <MSG extends BASE>
PayloadHandlerFlow<BUF,BASE> add(CustomPacketPayload.Type<MSG> type,
 StreamCodec<BUF,MSG> codec)

Description copied from interface: PayloadHandlerFlow

Adds a packet to this channel that has it's protocol validated whenever sent or received.

The handler is called on the network thread, and so should not interact with most game state by default. CustomPayloadEvent.Context.enqueueWork(Runnable) can be used to handle the message on the main server or client thread. Alternatively one can use

invalid reference

#addMain(Class, StreamCodec)

to run the handler on the main thread.

Specified by:

add in interface PayloadHandlerFlow<BUF extends FriendlyByteBuf,CTX>

addMain

public <MSG extends BASE>
PayloadHandlerFlow<BUF,BASE> addMain(CustomPacketPayload.Type<MSG> type,
 StreamCodec<BUF,MSG> codec)

Description copied from interface: PayloadHandlerFlow

Adds a packet to this channel that has it's protocol validated whenever sent or received.

Unlike PayloadHandlerFlow.add(Type,StreamCodec), the consumer is called on the main thread, and so can interact with most game state by default.

Specified by:

addMain in interface PayloadHandlerFlow<BUF extends FriendlyByteBuf,CTX>

add

public <MSG extends BASE>
PayloadHandlerFlow<BUF,BASE> add(CustomPacketPayload.Type<MSG> type,
 StreamCodec<BUF,MSG> codec,
 BiConsumer<MSG,CustomPayloadEvent.Context> consumer)

Description copied from interface: PayloadHandlerFlow

Adds a packet to this channel that has it's protocol validated whenever sent or received.

The handler is called on the network thread, and so should not interact with most game state by default. CustomPayloadEvent.Context.enqueueWork(Runnable) can be used to handle the message on the main server or client thread.

Specified by:

add in interface PayloadHandlerFlow<BUF extends FriendlyByteBuf,CTX>

flow

public PayloadHandlerFlow<BUF,BASE> flow(@Nullable
 @Nullable PacketFlow flow)

Specified by:

flow in interface BaseProtocol<BUF extends FriendlyByteBuf,CTX>

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

key

public io.netty.util.AttributeKey<CTX> key()

Returns the value of the key record component.

Returns:

the value of the key record component

ctx

public PayloadChannel.Builder.BuilderContext<BUF,BASE> ctx()

Returns the value of the ctx record component.

Specified by:

ctx in interface PayloadChannel.Builder.ProtocolFactory<BUF extends FriendlyByteBuf,CTX>

Returns:

the value of the ctx record component