mods.thecomputerizer.theimpossiblelibrary.api.network.message

Class MessageWrapperAPI<PLAYER,CTX>

java.lang.Object

mods.thecomputerizer.theimpossiblelibrary.api.network.message.MessageWrapperAPI<PLAYER,CTX>

All Implemented Interfaces:

CoreStateAccessor

Direct Known Subclasses:

MessageWrapperAPI.Client, MessageWrapperAPI.ClientLogin, MessageWrapperAPI.Server, MessageWrapperAPI.ServerLogin

public abstract class MessageWrapperAPI<PLAYER,CTX>
extends java.lang.Object
implements CoreStateAccessor

Wrapper class for interfacing version/loader-specific code. Extend MessageAPI to send a packet through the API Any class that extends this is required to have a constructor with a single ByteBuf as an input

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MessageWrapperAPI.Client<PLAYER,CTX> Sent from the server during gameplay Received on the client during gameplay
static class	MessageWrapperAPI.ClientLogin<PLAYER,CTX> Sent from the server during login Received on the client during login
static class	MessageWrapperAPI.Server<PLAYER,CTX> Sent from the client during gameplay Received on the server during gameplay
static class	MessageWrapperAPI.ServerLogin<PLAYER,CTX> Sent from the client during login Received on the server during login

Field Summary

Fields

Modifier and Type	Field and Description
protected MessageDirectionInfo<?>	info

Fields inherited from interface mods.thecomputerizer.theimpossiblelibrary.api.core.CoreStateAccessor

BOOLEAN_VALUES, FABRIC, FORGE, FORGE_OR_NEOFORGE, GAME_VERSION, JAVA_17, JAVA_21, JAVA_8, JAVA_MODULES, JAVA_VERSION, JAVA_VERSION_ASM, LEGACY, MOD_LOADER, NAMED_ENV, NEOFORGE, SRG_ENV, V12, V16, V16_OR_EARLIER, V16_OR_LATER, V18, V18_OR_EARLIER, V18_OR_LATER, V19, V19_2_OR_EARLIER, V19_4_OR_LATER, V19_OR_EARLIER, V19_OR_LATER, V20, V20_4_OR_EARLIER, V20_6_OR_LATER, V20_OR_EARLIER, V20_OR_LATER, V21, V21_OR_LATER

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MessageWrapperAPI()
protected	MessageWrapperAPI(io.netty.buffer.ByteBuf buf)

Method Summary

Modifier and Type	Method and Description
static <DIR> DIR	classToDir(java.lang.Class<?> msgCls)
void	decode(io.netty.buffer.ByteBuf buf) In the case of a decoding failure we can't easily determine how to allocate the rest of the buffer.
protected @Nullable MessageAPI<CTX>	decodeMessage(io.netty.buffer.ByteBuf buf, java.util.concurrent.atomic.AtomicBoolean failure)
protected @Nullable MessageAPI<CTX>	decodeMessage(io.netty.buffer.ByteBuf buf, java.lang.Class<?> msgClass, java.util.concurrent.atomic.AtomicBoolean failure)
static <P,C,B extends io.netty.buffer.ByteBuf> @NotNull java.util.function.Function<B,MessageWrapperAPI<P,C>>	decoder(java.lang.Class<?> msgClass)
static <DIR,P,C,B extends io.netty.buffer.ByteBuf> @NotNull java.util.function.Function<B,MessageWrapperAPI<P,C>>	decoder(MessageDirectionInfo<DIR> dir)
protected java.lang.String	dirName()
void	disableDebug()
void	enableDebug()
void	encode(io.netty.buffer.ByteBuf buf)
static <P,C,B extends io.netty.buffer.ByteBuf> @NotNull java.util.function.BiConsumer<MessageWrapperAPI<P,C>,B>	encoder()
static <DIR,P,C> java.lang.Class<MessageWrapperAPI<P,C>>	getClass(DIR dir)
static <DIR,P,C> java.lang.Class<MessageWrapperAPI<P,C>>	getClass(MessageDirectionInfo<DIR> dir)
protected <DIR> DIR	getDir() Get the current network direction from the info field or null if the field is not set
static <DIR,P,C> MessageWrapperAPI<P,C>	getInstance(DIR dir)
static <DIR,P,C,B extends io.netty.buffer.ByteBuf> MessageWrapperAPI<P,C>	getInstance(DIR dir, B buf)
static <DIR,P,C> MessageWrapperAPI<P,C>	getInstance(MessageDirectionInfo<DIR> dir)
static <DIR,P,C,B extends io.netty.buffer.ByteBuf> MessageWrapperAPI<P,C>	getInstance(MessageDirectionInfo<DIR> dir, B buf)
protected @Nullable java.util.Collection<java.lang.Class<?>>	getMissingDecoders() Expose missing decoder collection to subclasses
protected <DIR> DIR	getOppositeDir() Get the opposite of the current network direction from the info field or null if the field is not set
protected java.util.Collection<java.lang.Class<?>>	getOrInitMissingDecoders() Expose missing decoder collection to subclasses
@Nullable MessageWrapperAPI<PLAYER,CTX>	handle(CTX context)
static <DIR,P,C,S> @NotNull java.util.function.BiConsumer<MessageWrapperAPI<P,C>,S>	handler(DIR dir, java.util.function.Function<S,C> contextGetter, java.util.function.Function<C,P> playerGetter)
static <DIR,P,C,S> @NotNull java.util.function.BiConsumer<MessageWrapperAPI<P,C>,S>	handler(MessageDirectionInfo<DIR> dir, java.util.function.Function<S,C> contextGetter, java.util.function.Function<C,P> playerGetter)
protected java.util.Collection<java.lang.Class<?>>	initMissingDecoderCollection() Extensible for subclasses
static <DIR,P,C,B extends io.netty.buffer.ByteBuf> @NotNull java.util.function.Function<B,MessageWrapperAPI<P,C>>	innerDecoder(DIR dir)
protected void	markFoundMissingDecoder(java.lang.Class<?> msgClass)
protected void	markMissingDecoder(java.lang.Class<?> msgClass, io.netty.buffer.ByteBuf buf, java.util.concurrent.atomic.AtomicBoolean decodingFailure)
void	send()
<DIR> MessageWrapperAPI<PLAYER,CTX>	setMessage(DIR dir, MessageAPI<CTX> message)
<DIR> MessageWrapperAPI<PLAYER,CTX>	setMessages(DIR dir, java.util.Collection<MessageAPI<CTX>> messages)
<DIR> MessageWrapperAPI<PLAYER,CTX>	setMessages(DIR dir, MessageAPI<CTX>... messages)
MessageWrapperAPI<PLAYER,CTX>	setPlayer(PLAYER player)
MessageWrapperAPI<PLAYER,CTX>	setPlayers(java.util.Collection<PLAYER> players)
MessageWrapperAPI<PLAYER,CTX>	setPlayers(PLAYER... players)

Methods inherited from class java.lang.Object

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

Field Detail

info

protected MessageDirectionInfo<?> info

Constructor Detail

MessageWrapperAPI

protected MessageWrapperAPI()

MessageWrapperAPI

protected MessageWrapperAPI(io.netty.buffer.ByteBuf buf)

Method Detail

classToDir

public static <DIR> DIR classToDir(java.lang.Class<?> msgCls)

decoder

@NotNull
public static <DIR,P,C,B extends io.netty.buffer.ByteBuf> @NotNull java.util.function.Function<B,MessageWrapperAPI<P,C>> decoder(MessageDirectionInfo<DIR> dir)

decoder

@NotNull
public static <P,C,B extends io.netty.buffer.ByteBuf> @NotNull java.util.function.Function<B,MessageWrapperAPI<P,C>> decoder(java.lang.Class<?> msgClass)

encoder

@NotNull
public static <P,C,B extends io.netty.buffer.ByteBuf> @NotNull java.util.function.BiConsumer<MessageWrapperAPI<P,C>,B> encoder()

getClass

public static <DIR,P,C> java.lang.Class<MessageWrapperAPI<P,C>> getClass(MessageDirectionInfo<DIR> dir)

getClass

public static <DIR,P,C> java.lang.Class<MessageWrapperAPI<P,C>> getClass(DIR dir)

getInstance

public static <DIR,P,C> MessageWrapperAPI<P,C> getInstance(MessageDirectionInfo<DIR> dir)

getInstance

public static <DIR,P,C> MessageWrapperAPI<P,C> getInstance(DIR dir)

getInstance

public static <DIR,P,C,B extends io.netty.buffer.ByteBuf> MessageWrapperAPI<P,C> getInstance(MessageDirectionInfo<DIR> dir,
                                                                                             B buf)

getInstance

public static <DIR,P,C,B extends io.netty.buffer.ByteBuf> MessageWrapperAPI<P,C> getInstance(DIR dir,
                                                                                             B buf)

handler

@NotNull
public static <DIR,P,C,S> @NotNull java.util.function.BiConsumer<MessageWrapperAPI<P,C>,S> handler(MessageDirectionInfo<DIR> dir,
                                                                                                             java.util.function.Function<S,C> contextGetter,
                                                                                                             java.util.function.Function<C,P> playerGetter)

handler

@NotNull
public static <DIR,P,C,S> @NotNull java.util.function.BiConsumer<MessageWrapperAPI<P,C>,S> handler(DIR dir,
                                                                                                             java.util.function.Function<S,C> contextGetter,
                                                                                                             java.util.function.Function<C,P> playerGetter)

innerDecoder

@NotNull
public static <DIR,P,C,B extends io.netty.buffer.ByteBuf> @NotNull java.util.function.Function<B,MessageWrapperAPI<P,C>> innerDecoder(DIR dir)

decode

public void decode(io.netty.buffer.ByteBuf buf)

In the case of a decoding failure we can't easily determine how to allocate the rest of the buffer. As such, the decoding is immediately stopped while the failure is addressed. If this is a forge environment with legacy network handling, we will try to request any missing decoders and resume the decoding process if that is successful. Otherwise, any extra encoded data is lost.

decodeMessage

@Nullable
protected @Nullable MessageAPI<CTX> decodeMessage(io.netty.buffer.ByteBuf buf,
                                                             java.util.concurrent.atomic.AtomicBoolean failure)

decodeMessage

@Nullable
protected @Nullable MessageAPI<CTX> decodeMessage(io.netty.buffer.ByteBuf buf,
                                                             java.lang.Class<?> msgClass,
                                                             java.util.concurrent.atomic.AtomicBoolean failure)

dirName

protected java.lang.String dirName()

disableDebug

public void disableDebug()

enableDebug

public void enableDebug()

encode

public void encode(io.netty.buffer.ByteBuf buf)

getDir

@Nullable
protected <DIR> DIR getDir()

Get the current network direction from the info field or null if the field is not set

getMissingDecoders

@Nullable
protected @Nullable java.util.Collection<java.lang.Class<?>> getMissingDecoders()

Expose missing decoder collection to subclasses

getOppositeDir

@Nullable
protected <DIR> DIR getOppositeDir()

Get the opposite of the current network direction from the info field or null if the field is not set

getOrInitMissingDecoders

protected java.util.Collection<java.lang.Class<?>> getOrInitMissingDecoders()

Expose missing decoder collection to subclasses

handle

@Nullable
public @Nullable MessageWrapperAPI<PLAYER,CTX> handle(CTX context)

initMissingDecoderCollection

protected java.util.Collection<java.lang.Class<?>> initMissingDecoderCollection()

Extensible for subclasses

markFoundMissingDecoder

protected void markFoundMissingDecoder(java.lang.Class<?> msgClass)

markMissingDecoder

protected void markMissingDecoder(java.lang.Class<?> msgClass,
                                  io.netty.buffer.ByteBuf buf,
                                  java.util.concurrent.atomic.AtomicBoolean decodingFailure)

send

public void send()

setMessage

public <DIR> MessageWrapperAPI<PLAYER,CTX> setMessage(DIR dir,
                                                      MessageAPI<CTX> message)

setMessages

@SafeVarargs
public final <DIR> MessageWrapperAPI<PLAYER,CTX> setMessages(DIR dir,
                                                                           MessageAPI<CTX>... messages)

setMessages

public <DIR> MessageWrapperAPI<PLAYER,CTX> setMessages(DIR dir,
                                                       java.util.Collection<MessageAPI<CTX>> messages)

setPlayer

public MessageWrapperAPI<PLAYER,CTX> setPlayer(PLAYER player)

setPlayers

@SafeVarargs
public final MessageWrapperAPI<PLAYER,CTX> setPlayers(PLAYER... players)

setPlayers

public MessageWrapperAPI<PLAYER,CTX> setPlayers(java.util.Collection<PLAYER> players)