Package net.minecraftforge.network
Record Class SimpleChannel.HandlerFlow<BUF extends FriendlyByteBuf,CTX,BASE extends SimplePacket<CTX>>
java.lang.Object
java.lang.Record
net.minecraftforge.network.SimpleChannel.HandlerFlow<BUF,CTX,BASE>
- All Implemented Interfaces:
ChannelBuildable<Object>
,BaseProtocol<SimpleHandlerFlow<BUF,
,BASE>, SimpleHandlerProtocol<BUF, BASE>> SimpleHandlerFlow<BUF,
,BASE> SimpleHandlerProtocol<BUF,
,BASE> SimpleBuildable
,SimpleConnection<BASE>
,SimpleChannel.ProtocolFactory<BUF,
BASE>
- Enclosing class:
SimpleChannel
private static record SimpleChannel.HandlerFlow<BUF extends FriendlyByteBuf,CTX,BASE extends SimplePacket<CTX>> (io.netty.util.AttributeKey<CTX> key, SimpleChannel.SimpleContext<BUF extends FriendlyByteBuf,BASE extends SimplePacket<CTX>> ctx)
extends Record
implements SimpleChannel.ProtocolFactory<BUF,BASE>, SimpleHandlerFlow<BUF,BASE>
-
Field Summary
-
Constructor Summary
ModifierConstructorDescriptionprivate
HandlerFlow
(io.netty.util.AttributeKey<CTX> key, SimpleChannel.SimpleContext<BUF, BASE> ctx) Creates an instance of aHandlerFlow
record class. -
Method Summary
Modifier and TypeMethodDescription<MSG extends BASE>
SimpleHandlerFlow<BUF, BASE> add
(Class<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>
SimpleHandlerFlow<BUF, BASE> add
(Class<MSG> type, StreamCodec<BUF, MSG> codec, BiConsumer<MSG, CustomPayloadEvent.Context> handler) Adds a packet to this channel that has it's protocol validated whenever sent or received.<MSG extends BASE>
SimpleHandlerFlow<BUF, BASE> addMain
(Class<MSG> type, StreamCodec<BUF, MSG> codec) Adds a packet to this channel that has it's protocol validated whenever sent or received.ctx()
Returns the value of thectx
record component.final boolean
Indicates whether some other object is "equal to" this one.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 thekey
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.SimpleChannel.ProtocolFactory
build, protocol, protocol
Methods inherited from interface net.minecraftforge.network.simple.SimpleConnection
any, any, any, any, configuration, configuration, configuration, configuration, login, login, login, login, play, play, play, play, protocol, protocol
-
Field Details
-
key
The field for thekey
record component. -
ctx
private final SimpleChannel.SimpleContext<BUF extends FriendlyByteBuf,BASE extends SimplePacket<CTX>> ctxThe field for thectx
record component.
-
-
Constructor Details
-
HandlerFlow
Creates an instance of aHandlerFlow
record class.- Parameters:
key
- the value for thekey
record componentctx
- the value for thectx
record component
-
-
Method Details
-
add
public <MSG extends BASE> SimpleHandlerFlow<BUF,BASE> add(Class<MSG> type, StreamCodec<BUF, MSG> codec) Description copied from interface:SimpleHandlerFlow
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 useSimpleHandlerFlow.addMain(Class, StreamCodec)
to run the handler on the main thread.- Specified by:
add
in interfaceSimpleHandlerFlow<BUF extends FriendlyByteBuf,
CTX>
-
addMain
public <MSG extends BASE> SimpleHandlerFlow<BUF,BASE> addMain(Class<MSG> type, StreamCodec<BUF, MSG> codec) Description copied from interface:SimpleHandlerFlow
Adds a packet to this channel that has it's protocol validated whenever sent or received.Unlike
SimpleHandlerFlow.add(Class,StreamCodec)
, the consumer is called on the main thread, and so can interact with most game state by default.- Specified by:
addMain
in interfaceSimpleHandlerFlow<BUF extends FriendlyByteBuf,
CTX>
-
add
public <MSG extends BASE> SimpleHandlerFlow<BUF,BASE> add(Class<MSG> type, StreamCodec<BUF, MSG> codec, BiConsumer<MSG, CustomPayloadEvent.Context> handler) Description copied from interface:SimpleHandlerFlow
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 interfaceSimpleHandlerFlow<BUF extends FriendlyByteBuf,
CTX>
-
flow
- Specified by:
flow
in interfaceBaseProtocol<BUF extends FriendlyByteBuf,
CTX>
-
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. -
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. -
equals
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 withObjects::equals(Object,Object)
. -
key
Returns the value of thekey
record component.- Returns:
- the value of the
key
record component
-
ctx
Returns the value of thectx
record component.- Specified by:
ctx
in interfaceSimpleChannel.ProtocolFactory<BUF extends FriendlyByteBuf,
CTX> - Returns:
- the value of the
ctx
record component
-