Package net.neoforged.neoforge.network.handling

Record Class MainThreadPayloadHandler<T extends CustomPacketPayload>

java.lang.Object

java.lang.Record

net.neoforged.neoforge.network.handling.MainThreadPayloadHandler<T>

All Implemented Interfaces:

IPayloadHandler<T>

public record MainThreadPayloadHandler<T extends CustomPacketPayload>(IPayloadHandler<T extends CustomPacketPayload> handler)
extends Record
implements IPayloadHandler<T>

Helper class that always executes the wrapped handler on the main thread.

Field Summary

Fields

Modifier and Type	Field	Description
private final IPayloadHandler<T>	handler	The field for the handler record component.

Constructor Summary

Constructors

Constructor	Description
MainThreadPayloadHandler(IPayloadHandler<T> handler)	Creates an instance of a MainThreadPayloadHandler record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
void	handle(T payload, IPayloadContext context)	Handles the payload with the supplied context.
IPayloadHandler<T>	handler()	Returns the value of the handler record component.
final int	hashCode()	Returns a hash code value for this object.
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

Field Details

handler

private final IPayloadHandler<T extends CustomPacketPayload> handler

The field for the handler record component.

Constructor Details

MainThreadPayloadHandler

public MainThreadPayloadHandler(IPayloadHandler<T> handler)

Creates an instance of a MainThreadPayloadHandler record class.

Parameters:

handler - the value for the handler record component

Method Details

handle

public void handle(T payload,
 IPayloadContext context)

Description copied from interface: IPayloadHandler

Handles the payload with the supplied context.

The thread the supplied handler executes in depends on the HandlerThread set in PayloadRegistrar.executesOn(net.neoforged.neoforge.network.registration.HandlerThread).

Specified by:

handle in interface IPayloadHandler<T extends CustomPacketPayload>

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.

handler

public IPayloadHandler<T> handler()

Returns the value of the handler record component.

Returns:

the value of the handler record component