java.lang.Object

net.minecraftforge.network.SimpleChannel.MessageBuilder<MSG>

Enclosing class:: SimpleChannel

public static class SimpleChannel.MessageBuilder<MSG> extends Object

Nested Class Summary

Nested Classes

Modifier and Type

Class

Description

static interface

SimpleChannel.MessageBuilder.ToBooleanBiFunction<T,U>

static interface

SimpleChannel.MessageBuilder.ToBooleanTriFunction<T,U,V>
Field Summary

Fields

Modifier and Type

Field

Description

private final SimpleChannel

channel

private BiConsumer<MSG,CustomPayloadEvent.Context>

consumer

private Function<FriendlyByteBuf,MSG>

decoder

private final Optional<NetworkDirection>

direction

private BiConsumer<MSG,FriendlyByteBuf>

encoder

private final int

id

private final Class<MSG>

type
Constructor Summary

Constructors

Modifier

Constructor

Description

private

MessageBuilder(SimpleChannel channel, Class<MSG> type, int id, @Nullable NetworkDirection networkDirection)
Method Summary

Modifier and Type

Method

Description

SimpleChannel

add()

Finishes building this packet.

<C> SimpleChannel.MessageBuilder<MSG>

consumerMainThread(io.netty.util.AttributeKey<C> key, org.apache.commons.lang3.function.TriConsumer<C,MSG,CustomPayloadEvent.Context> consumer)

Set the message consumer, which is called once a message has been decoded.

SimpleChannel.MessageBuilder<MSG>

consumerMainThread(BiConsumer<MSG,CustomPayloadEvent.Context> consumer)

Set the message consumer, which is called once a message has been decoded.

<C> SimpleChannel.MessageBuilder<MSG>

consumerNetworkThread(io.netty.util.AttributeKey<C> key, SimpleChannel.MessageBuilder.ToBooleanTriFunction<C,MSG,CustomPayloadEvent.Context> handler)

Function returning a boolean "packet handled" indication, for simpler channel building.

<C> SimpleChannel.MessageBuilder<MSG>

consumerNetworkThread(io.netty.util.AttributeKey<C> key, org.apache.commons.lang3.function.TriConsumer<C,MSG,CustomPayloadEvent.Context> consumer)

Set the message consumer, which is called once a message has been decoded.

SimpleChannel.MessageBuilder<MSG>

consumerNetworkThread(BiConsumer<MSG,CustomPayloadEvent.Context> consumer)

Set the message consumer, which is called once a message has been decoded.

SimpleChannel.MessageBuilder<MSG>

consumerNetworkThread(SimpleChannel.MessageBuilder.ToBooleanBiFunction<MSG,CustomPayloadEvent.Context> handler)

Function returning a boolean "packet handled" indication, for simpler channel building.

SimpleChannel.MessageBuilder<MSG>

decoder(Function<FriendlyByteBuf,MSG> decoder)

Set the message decoder, which reads the message from a FriendlyByteBuf.

SimpleChannel.MessageBuilder<MSG>

encoder(BiConsumer<MSG,FriendlyByteBuf> encoder)

Set the message encoder, which writes this message to a FriendlyByteBuf.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details
- channel
  
  private final SimpleChannel channel
- type
  
  private final Class<MSG> type
- id
  
  private final int id
- direction
  
  private final Optional<NetworkDirection> direction
- encoder
  
  private BiConsumer<MSG,FriendlyByteBuf> encoder
- decoder
  
  private Function<FriendlyByteBuf,MSG> decoder
- consumer
  
  private BiConsumer<MSG,CustomPayloadEvent.Context> consumer
Constructor Details
- MessageBuilder
  
  private MessageBuilder(SimpleChannel channel, Class<MSG> type, int id, @Nullable @Nullable NetworkDirection networkDirection)
Method Details
- encoder
  
  public SimpleChannel.MessageBuilder<MSG> encoder(BiConsumer<MSG,FriendlyByteBuf> encoder)
  
  Set the message encoder, which writes this message to a FriendlyByteBuf.
  The encoder is called immediately when the packet is sent. This means encoding typically occurs on the main server/client thread rather than on the network thread.
  However, this behaviour should not be relied on, and the encoder should try to be thread-safe and not interact with the current game state.
  
  Parameters:
  
  encoder - The message encoder.
  
  Returns:
  
  This message builder, for chaining.
- decoder
  
  public SimpleChannel.MessageBuilder<MSG> decoder(Function<FriendlyByteBuf,MSG> decoder)
  
  Set the message decoder, which reads the message from a FriendlyByteBuf.
  The decoder is called when the message is received on the network thread. The decoder should not attempt to access or mutate any game state, deferring that until the the message is handled.
  
  Parameters:
  
  decoder - The message decoder.
  
  Returns:
  
  The message builder, for chaining.
- consumerNetworkThread
  
  public SimpleChannel.MessageBuilder<MSG> consumerNetworkThread(BiConsumer<MSG,CustomPayloadEvent.Context> consumer)
  
  Set the message consumer, which is called once a message has been decoded. This accepts the decoded message object and the message's context.
  The consumer 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 consumerMainThread(BiConsumer) to run the handler on the main thread.
  Parameters:
  
  consumer - The message consumer.
  
  Returns:
  
  The message builder, for chaining.
  
  See Also:
  
  consumerMainThread(BiConsumer)
- consumerNetworkThread
  
  public <C> SimpleChannel.MessageBuilder<MSG> consumerNetworkThread(io.netty.util.AttributeKey<C> key, org.apache.commons.lang3.function.TriConsumer<C,MSG,CustomPayloadEvent.Context> consumer)
  
  Set the message consumer, which is called once a message has been decoded. This accepts the decoded message object and the message's context. The instance will be retrieved from the associated AttributeKey on the channel.
  The consumer 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 #consumerMainThread(TriConsumer) to run the handler on the main thread.
  Parameters:
  
  consumer - The message consumer.
  
  Returns:
  
  The message builder, for chaining.
  
  See Also:
  
  consumerMainThread(BiConsumer)
- consumerNetworkThread
  
  public SimpleChannel.MessageBuilder<MSG> consumerNetworkThread(SimpleChannel.MessageBuilder.ToBooleanBiFunction<MSG,CustomPayloadEvent.Context> handler)
  
  Function returning a boolean "packet handled" indication, for simpler channel building.
  See Also:
  
  consumerNetworkThread(BiConsumer)
- consumerNetworkThread
  
  public <C> SimpleChannel.MessageBuilder<MSG> consumerNetworkThread(io.netty.util.AttributeKey<C> key, SimpleChannel.MessageBuilder.ToBooleanTriFunction<C,MSG,CustomPayloadEvent.Context> handler)
  
  Function returning a boolean "packet handled" indication, for simpler channel building.
  See Also:
  
  consumerNetworkThread(AttributeKey,TriConsumer)
- consumerMainThread
  
  public SimpleChannel.MessageBuilder<MSG> consumerMainThread(BiConsumer<MSG,CustomPayloadEvent.Context> consumer)
  
  Set the message consumer, which is called once a message has been decoded. This accepts the decoded message object and the message's context.
  Unlike consumerNetworkThread(BiConsumer), the consumer is called on the main thread, and so can interact with most game state by default.
  Parameters:
  
  consumer - The message consumer.
  
  Returns:
  
  The message builder, for chaining.
  
  See Also:
  
  consumerNetworkThread(BiConsumer)
- consumerMainThread
  
  public <C> SimpleChannel.MessageBuilder<MSG> consumerMainThread(io.netty.util.AttributeKey<C> key, org.apache.commons.lang3.function.TriConsumer<C,MSG,CustomPayloadEvent.Context> consumer)
  
  Set the message consumer, which is called once a message has been decoded. This accepts the decoded message object and the message's context. The instance will be retrieved from the associated AttributeKey on the channel.
  Unlike consumerNetworkThread(AttributeKey,TriConsumer), the consumer is called on the main thread, and so can interact with most game state by default.
  Parameters:
  
  consumer - The message consumer.
  
  Returns:
  
  The message builder, for chaining.
  
  See Also:
  
  consumerNetworkThread(BiConsumer)
- add
  
  public SimpleChannel add()
  
  Finishes building this packet.
  
  Returns:
  
  The attached SimpleChannel to facilitate chaining.

Class SimpleChannel.MessageBuilder<MSG>

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Details

channel

type

id

direction

encoder

decoder

consumer

Constructor Details

MessageBuilder

Method Details

encoder

decoder

consumerNetworkThread

consumerNetworkThread

consumerNetworkThread

consumerNetworkThread

consumerMainThread

consumerMainThread

add