From 8b8f979a4fc7380d1d458c0defeaf398d770b9b3 Mon Sep 17 00:00:00 2001 From: KnightMiner Date: Fri, 24 Jul 2020 12:08:21 -0500 Subject: [PATCH] Clean up network logic * Renamed BookNetowkr network to MantleNetwork, as I'd like this to be usable for things other than books if needed * Replace abstract packet with an interface * Reimplement threadsafe packet * Simplify registration methods * Require a network direction on registation, to filter packets into client only/server only --- src/main/java/slimeknights/mantle/Mantle.java | 4 +- .../mantle/client/book/BookLoader.java | 6 +- .../mantle/network/AbstractPacket.java | 29 ------ .../network/AbstractPacketThreadsafe.java | 40 -------- .../mantle/network/BookNetwork.java | 12 --- .../mantle/network/MantleNetwork.java | 18 ++++ .../mantle/network/NetworkWrapper.java | 94 +++++++++++++++++-- .../network/book/UpdateSavedPagePacket.java | 46 --------- .../mantle/network/packet/ISimplePacket.java | 23 +++++ .../network/packet/IThreadsafePacket.java | 24 +++++ .../network/packet/UpdateSavedPagePacket.java | 37 ++++++++ .../{book => packet}/package-info.java | 2 +- 12 files changed, 193 insertions(+), 142 deletions(-) delete mode 100644 src/main/java/slimeknights/mantle/network/AbstractPacket.java delete mode 100644 src/main/java/slimeknights/mantle/network/AbstractPacketThreadsafe.java delete mode 100644 src/main/java/slimeknights/mantle/network/BookNetwork.java create mode 100644 src/main/java/slimeknights/mantle/network/MantleNetwork.java delete mode 100644 src/main/java/slimeknights/mantle/network/book/UpdateSavedPagePacket.java create mode 100644 src/main/java/slimeknights/mantle/network/packet/ISimplePacket.java create mode 100644 src/main/java/slimeknights/mantle/network/packet/IThreadsafePacket.java create mode 100644 src/main/java/slimeknights/mantle/network/packet/UpdateSavedPagePacket.java rename src/main/java/slimeknights/mantle/network/{book => packet}/package-info.java (78%) diff --git a/src/main/java/slimeknights/mantle/Mantle.java b/src/main/java/slimeknights/mantle/Mantle.java index e4bdca9..67b7cf1 100644 --- a/src/main/java/slimeknights/mantle/Mantle.java +++ b/src/main/java/slimeknights/mantle/Mantle.java @@ -8,8 +8,8 @@ import net.minecraftforge.fml.event.lifecycle.FMLCommonSetupEvent; import net.minecraftforge.fml.javafmlmod.FMLJavaModLoadingContext; import org.apache.logging.log4j.LogManager; import org.apache.logging.log4j.Logger; -import slimeknights.mantle.network.BookNetwork; import slimeknights.mantle.client.ClientEvents; +import slimeknights.mantle.network.MantleNetwork; /** * Mantle @@ -35,7 +35,7 @@ public class Mantle { } private void commonSetup(final FMLCommonSetupEvent event) { - BookNetwork.registerPackets(); + MantleNetwork.registerPackets(); } /** diff --git a/src/main/java/slimeknights/mantle/client/book/BookLoader.java b/src/main/java/slimeknights/mantle/client/book/BookLoader.java index 7d4ff89..7fdd9b4 100644 --- a/src/main/java/slimeknights/mantle/client/book/BookLoader.java +++ b/src/main/java/slimeknights/mantle/client/book/BookLoader.java @@ -28,8 +28,8 @@ import slimeknights.mantle.client.book.data.content.ContentTextRightImage; import slimeknights.mantle.client.book.data.content.PageContent; import slimeknights.mantle.client.book.data.deserializer.HexStringDeserializer; import slimeknights.mantle.client.book.repository.BookRepository; -import slimeknights.mantle.network.BookNetwork; -import slimeknights.mantle.network.book.UpdateSavedPagePacket; +import slimeknights.mantle.network.MantleNetwork; +import slimeknights.mantle.network.packet.UpdateSavedPagePacket; import javax.annotation.Nullable; import java.util.HashMap; @@ -138,7 +138,7 @@ public class BookLoader implements IResourceManagerReloadListener { } BookHelper.writeSavedPage(item, page); - BookNetwork.wrapper.network.sendToServer(new UpdateSavedPagePacket(page)); + MantleNetwork.INSTANCE.network.sendToServer(new UpdateSavedPagePacket(page)); } /** diff --git a/src/main/java/slimeknights/mantle/network/AbstractPacket.java b/src/main/java/slimeknights/mantle/network/AbstractPacket.java deleted file mode 100644 index 42841aa..0000000 --- a/src/main/java/slimeknights/mantle/network/AbstractPacket.java +++ /dev/null @@ -1,29 +0,0 @@ -package slimeknights.mantle.network; - -import io.netty.buffer.ByteBuf; -import net.minecraft.network.PacketBuffer; -import net.minecraft.util.math.BlockPos; -import net.minecraftforge.fml.network.NetworkEvent; - -import java.util.function.Supplier; - -public abstract class AbstractPacket { - - public abstract void encode(PacketBuffer buf); - - public abstract void handle(Supplier context); - - protected void writePos(BlockPos pos, ByteBuf buf) { - buf.writeInt(pos.getX()); - buf.writeInt(pos.getY()); - buf.writeInt(pos.getZ()); - } - - protected BlockPos readPos(ByteBuf buf) { - int x = buf.readInt(); - int y = buf.readInt(); - int z = buf.readInt(); - return new BlockPos(x, y, z); - } - -} diff --git a/src/main/java/slimeknights/mantle/network/AbstractPacketThreadsafe.java b/src/main/java/slimeknights/mantle/network/AbstractPacketThreadsafe.java deleted file mode 100644 index 97f0f5d..0000000 --- a/src/main/java/slimeknights/mantle/network/AbstractPacketThreadsafe.java +++ /dev/null @@ -1,40 +0,0 @@ -package slimeknights.mantle.network; - -import net.minecraft.client.network.play.ClientPlayNetHandler; -import net.minecraft.network.play.ServerPlayNetHandler; - -/** - * Threadsafe integration of the abstract packet. - * Basically if you're doing something that has any influence on the world you should use this. - * (That's ~everything) - */ -public abstract class AbstractPacketThreadsafe extends AbstractPacket { - - //TODO fix! - /* - @Override - public final IMessage handleClient(final ClientPlayNetHandler netHandler) { - FMLCommonHandler.instance().getWorldThread(netHandler).addScheduledTask(new Runnable() { - @Override - public void run() { - handleClientSafe(netHandler); - } - }); - return null; - } - - @Override - public final IMessage handleServer(final ServerPlayNetHandler netHandler) { - FMLCommonHandler.instance().getWorldThread(netHandler).addScheduledTask(new Runnable() { - @Override - public void run() { - handleServerSafe(netHandler); - } - }); - return null; - } - - public abstract void handleClientSafe(ClientPlayNetHandler netHandler); - - public abstract void handleServerSafe(ServerPlayNetHandler netHandler);*/ -} diff --git a/src/main/java/slimeknights/mantle/network/BookNetwork.java b/src/main/java/slimeknights/mantle/network/BookNetwork.java deleted file mode 100644 index ca04c7e..0000000 --- a/src/main/java/slimeknights/mantle/network/BookNetwork.java +++ /dev/null @@ -1,12 +0,0 @@ -package slimeknights.mantle.network; - -import slimeknights.mantle.network.book.UpdateSavedPagePacket; - -public class BookNetwork { - - public static final NetworkWrapper wrapper = new NetworkWrapper("mantle:books"); - - public static void registerPackets() { - wrapper.registerPacket(UpdateSavedPagePacket.class, UpdateSavedPagePacket::encode, UpdateSavedPagePacket::new, UpdateSavedPagePacket::handle); - } -} diff --git a/src/main/java/slimeknights/mantle/network/MantleNetwork.java b/src/main/java/slimeknights/mantle/network/MantleNetwork.java new file mode 100644 index 0000000..af5bed2 --- /dev/null +++ b/src/main/java/slimeknights/mantle/network/MantleNetwork.java @@ -0,0 +1,18 @@ +package slimeknights.mantle.network; + +import net.minecraftforge.fml.network.NetworkDirection; +import slimeknights.mantle.Mantle; +import slimeknights.mantle.network.packet.FluidUpdatePacket; +import slimeknights.mantle.network.packet.UpdateSavedPagePacket; + +public class MantleNetwork { + /** Network instance */ + public static final NetworkWrapper INSTANCE = new NetworkWrapper(Mantle.getResource("network")); + + /** + * Registers packets into this network + */ + public static void registerPackets() { + INSTANCE.registerPacket(UpdateSavedPagePacket.class, UpdateSavedPagePacket::new, NetworkDirection.PLAY_TO_SERVER); + } +} diff --git a/src/main/java/slimeknights/mantle/network/NetworkWrapper.java b/src/main/java/slimeknights/mantle/network/NetworkWrapper.java index 29e7b3b..ce9481c 100644 --- a/src/main/java/slimeknights/mantle/network/NetworkWrapper.java +++ b/src/main/java/slimeknights/mantle/network/NetworkWrapper.java @@ -1,14 +1,23 @@ package slimeknights.mantle.network; +import net.minecraft.entity.Entity; import net.minecraft.entity.player.ServerPlayerEntity; +import net.minecraft.network.IPacket; import net.minecraft.network.PacketBuffer; import net.minecraft.util.ResourceLocation; +import net.minecraft.util.math.BlockPos; +import net.minecraft.world.chunk.Chunk; +import net.minecraft.world.server.ServerWorld; import net.minecraftforge.common.util.FakePlayer; import net.minecraftforge.fml.network.NetworkDirection; -import net.minecraftforge.fml.network.NetworkEvent; +import net.minecraftforge.fml.network.NetworkEvent.Context; import net.minecraftforge.fml.network.NetworkRegistry; +import net.minecraftforge.fml.network.PacketDistributor; import net.minecraftforge.fml.network.simple.SimpleChannel; +import slimeknights.mantle.network.packet.ISimplePacket; +import javax.annotation.Nullable; +import java.util.Optional; import java.util.function.BiConsumer; import java.util.function.Function; import java.util.function.Supplier; @@ -17,31 +26,98 @@ import java.util.function.Supplier; * A small network implementation/wrapper using AbstractPackets instead of IMessages. * Instantiate in your mod class and register your packets accordingly. */ +@SuppressWarnings({"unused", "WeakerAccess"}) public class NetworkWrapper { - + /** Network instance */ public final SimpleChannel network; private int id = 0; private static final String PROTOCOL_VERSION = Integer.toString(1); - public NetworkWrapper(String channelName) { - this.network = NetworkRegistry.ChannelBuilder.named(new ResourceLocation(channelName)) + /** + * Creates a new network wrapper + * @param channelName Unique packet channel name + */ + public NetworkWrapper(ResourceLocation channelName) { + this.network = NetworkRegistry.ChannelBuilder.named(channelName) .clientAcceptedVersions(PROTOCOL_VERSION::equals) .serverAcceptedVersions(PROTOCOL_VERSION::equals) .networkProtocolVersion(() -> PROTOCOL_VERSION) .simpleChannel(); } - public void registerPacket(Class packetClazz, BiConsumer encoder, Function decoder, BiConsumer> messageConsumer) { - this.network.registerMessage(this.id++, packetClazz, encoder, decoder, messageConsumer); + /** + * Registers a new {@link ISimplePacket} + * @param clazz Packet class + * @param decoder Packet decoder, typically the constructor + * @param Packet class type + */ + public void registerPacket(Class clazz, Function decoder, @Nullable NetworkDirection direction) { + registerPacket(clazz, ISimplePacket::encode, decoder, ISimplePacket::handle, direction); } + /** + * Registers a new generic packet + * @param clazz Packet class + * @param encoder Encodes a packet to the buffer + * @param decoder Packet decoder, typically the constructor + * @param consumer Logic to handle a packet + * @param direction Network direction for validation. Pass null for no direction + * @param Packet class type + */ + public void registerPacket(Class clazz, BiConsumer encoder, Function decoder, BiConsumer> consumer, @Nullable NetworkDirection direction) { + this.network.registerMessage(this.id++, clazz, encoder, decoder, consumer, Optional.ofNullable(direction)); + } + + + /* Sending packets */ + + /** + * Sends a packet to the server + * @param msg Packet to send + */ public void sendToServer(Object msg) { this.network.sendToServer(msg); } - public void sendTo(Object msg, ServerPlayerEntity player) { - if (!(player instanceof FakePlayer)) { - this.network.sendTo(msg, player.connection.netManager, NetworkDirection.PLAY_TO_CLIENT); + /** + * Sends a packet to the given packet distributor + * @param target Packet target + * @param message Packet to send + */ + public void send(PacketDistributor.PacketTarget target, Object message) { + network.send(target, message); + } + + /** + * Sends a vanilla packet to the given entity + * @param player Player receiving the packet + * @param packet Packet + */ + public void sendVanillaPacket(IPacket packet, Entity player) { + if (player instanceof ServerPlayerEntity && ((ServerPlayerEntity) player).connection != null) { + ((ServerPlayerEntity) player).connection.sendPacket(packet); } } + + /** + * Sends a packet to a player + * @param msg Packet + * @param player Player to send + */ + public void sendTo(Object msg, ServerPlayerEntity player) { + if (!(player instanceof FakePlayer)) { + network.sendTo(msg, player.connection.netManager, NetworkDirection.PLAY_TO_CLIENT); + } + } + + /** + * Sends a packet to players near a location + * @param msg Packet to send + * @param serverWorld World instance + * @param position Position within range + */ + public void sendToClientsAround(Object msg, ServerWorld serverWorld, BlockPos position) { + Chunk chunk = serverWorld.getChunkAt(position); + network.send(PacketDistributor.TRACKING_CHUNK.with(() -> chunk), msg); + } } diff --git a/src/main/java/slimeknights/mantle/network/book/UpdateSavedPagePacket.java b/src/main/java/slimeknights/mantle/network/book/UpdateSavedPagePacket.java deleted file mode 100644 index 9bb4319..0000000 --- a/src/main/java/slimeknights/mantle/network/book/UpdateSavedPagePacket.java +++ /dev/null @@ -1,46 +0,0 @@ -package slimeknights.mantle.network.book; - -import net.minecraft.entity.player.PlayerEntity; -import net.minecraft.item.ItemStack; -import net.minecraft.network.PacketBuffer; -import net.minecraft.util.Hand; -import net.minecraftforge.fml.network.NetworkEvent; -import slimeknights.mantle.client.book.BookHelper; -import slimeknights.mantle.network.AbstractPacket; - -import java.util.function.Supplier; - -public class UpdateSavedPagePacket extends AbstractPacket { - - private String pageName; - - public UpdateSavedPagePacket(String pageName) { - this.pageName = pageName; - } - - public UpdateSavedPagePacket(PacketBuffer buffer) { - this.pageName = buffer.readString(32767); - } - - @Override - public void encode(PacketBuffer buf) { - buf.writeString(this.pageName); - } - - @Override - public void handle(Supplier context) { - context.get().enqueueWork(() -> { - if (context.get().getSender() != null && this.pageName != null) { - PlayerEntity player = context.get().getSender(); - if (player != null) { - ItemStack is = player.getHeldItem(Hand.MAIN_HAND); - if (!is.isEmpty()) { - BookHelper.writeSavedPage(is, this.pageName); - } - } - } - }); - - context.get().setPacketHandled(true); - } -} diff --git a/src/main/java/slimeknights/mantle/network/packet/ISimplePacket.java b/src/main/java/slimeknights/mantle/network/packet/ISimplePacket.java new file mode 100644 index 0000000..488d681 --- /dev/null +++ b/src/main/java/slimeknights/mantle/network/packet/ISimplePacket.java @@ -0,0 +1,23 @@ +package slimeknights.mantle.network.packet; + +import net.minecraft.network.PacketBuffer; +import net.minecraftforge.fml.network.NetworkEvent; + +import java.util.function.Supplier; + +/** + * Packet interface to add common methods for registration + */ +public interface ISimplePacket { + /** + * Encodes a packet for the buffer + * @param buf Buffer instance + */ + void encode(PacketBuffer buf); + + /** + * Handles receiving the packet + * @param context Packet context + */ + void handle(Supplier context); +} diff --git a/src/main/java/slimeknights/mantle/network/packet/IThreadsafePacket.java b/src/main/java/slimeknights/mantle/network/packet/IThreadsafePacket.java new file mode 100644 index 0000000..4f8f03c --- /dev/null +++ b/src/main/java/slimeknights/mantle/network/packet/IThreadsafePacket.java @@ -0,0 +1,24 @@ +package slimeknights.mantle.network.packet; + +import net.minecraftforge.fml.network.NetworkEvent; + +import java.util.function.Supplier; + +/** + * Packet instance that automatically wraps the logic in {@link NetworkEvent.Context#enqueueWork(Runnable)} for thread safety + */ +public interface IThreadsafePacket extends ISimplePacket { + @Override + default void handle(Supplier supplier) { + NetworkEvent.Context context = supplier.get(); + context.enqueueWork(() -> handleThreadsafe(context)); + context.setPacketHandled(true); + } + + /** + * Handles receiving the packet on the correct thread + * Packet is automatically set to handled as well by the base logic + * @param context Packet context + */ + void handleThreadsafe(NetworkEvent.Context context); +} diff --git a/src/main/java/slimeknights/mantle/network/packet/UpdateSavedPagePacket.java b/src/main/java/slimeknights/mantle/network/packet/UpdateSavedPagePacket.java new file mode 100644 index 0000000..682e320 --- /dev/null +++ b/src/main/java/slimeknights/mantle/network/packet/UpdateSavedPagePacket.java @@ -0,0 +1,37 @@ +package slimeknights.mantle.network.packet; + +import net.minecraft.entity.player.PlayerEntity; +import net.minecraft.item.ItemStack; +import net.minecraft.network.PacketBuffer; +import net.minecraft.util.Hand; +import net.minecraftforge.fml.network.NetworkEvent.Context; +import slimeknights.mantle.client.book.BookHelper; + +public class UpdateSavedPagePacket implements IThreadsafePacket { + + private String pageName; + + public UpdateSavedPagePacket(String pageName) { + this.pageName = pageName; + } + + public UpdateSavedPagePacket(PacketBuffer buffer) { + this.pageName = buffer.readString(32767); + } + + @Override + public void encode(PacketBuffer buf) { + buf.writeString(this.pageName); + } + + @Override + public void handleThreadsafe(Context context) { + PlayerEntity player = context.getSender(); + if (player != null && this.pageName != null) { + ItemStack is = player.getHeldItem(Hand.MAIN_HAND); + if (!is.isEmpty()) { + BookHelper.writeSavedPage(is, this.pageName); + } + } + } +} diff --git a/src/main/java/slimeknights/mantle/network/book/package-info.java b/src/main/java/slimeknights/mantle/network/packet/package-info.java similarity index 78% rename from src/main/java/slimeknights/mantle/network/book/package-info.java rename to src/main/java/slimeknights/mantle/network/packet/package-info.java index e2c60af..b1a657f 100644 --- a/src/main/java/slimeknights/mantle/network/book/package-info.java +++ b/src/main/java/slimeknights/mantle/network/packet/package-info.java @@ -1,6 +1,6 @@ @ParametersAreNonnullByDefault @MethodsReturnNonnullByDefault -package slimeknights.mantle.network.book; +package slimeknights.mantle.network.packet; import mcp.MethodsReturnNonnullByDefault;