Packet250SpeedyIngameTester.java

package speedytools.common.network;


import net.minecraftforge.fml.common.network.simpleimpl.IMessage;
import net.minecraftforge.fml.common.network.simpleimpl.IMessageHandler;
import net.minecraftforge.fml.common.network.simpleimpl.MessageContext;
import net.minecraftforge.fml.relauncher.Side;
import io.netty.buffer.ByteBuf;
import speedytools.SpeedyToolsMod;
import speedytools.common.utilities.ErrorLog;

/**
* This class is used to inform the server to perform an in-game automated test
*/
public class Packet250SpeedyIngameTester extends Packet250Base
{
  /**
   * Packet sent from client to server, to indicate when the user has used the ingame tester tool
   * @param i_whichTest the number of the test to be performed
   * @param i_performTest false for erase results of test/ prepare for next test; true for perform
   */
  public Packet250SpeedyIngameTester(int i_whichTest, boolean i_performTest)
  {
    super();

    whichTest = i_whichTest;
    performTest = i_performTest;
    packetIsValid = true;
  }

//  /**
//   * Creates a Packet250SpeedyToolUse from Packet250CustomPayload
//   * @param sourcePacket250
//   * @return the converted packet, or null if failure
//   */
//  public static Packet250SpeedyIngameTester createPacket250SpeedyIngameTester(Packet250CustomPayload sourcePacket250)
//  {
//    Packet250SpeedyIngameTester newPacket = new Packet250SpeedyIngameTester();
//    newPacket.packet250 = sourcePacket250;
//    DataInputStream inputStream = new DataInputStream(new ByteArrayInputStream(sourcePacket250.data));
//
//    try {
//      byte packetID = inputStream.readByte();
//      if (packetID != Packet250Types.PACKET250_INGAME_TESTER.getPacketTypeID()) return null;
//
//      newPacket.whichTest = inputStream.readInt();
//      newPacket.performTest = inputStream.readBoolean();
//    } catch (IOException ioe) {
//      ErrorLog.defaultLog().warning("Exception while reading Packet250SpeedyIngameTester: " + ioe);
//      return null;
//    }
//    if (!newPacket.checkInvariants()) return null;
//    return newPacket;
//  }

   public Packet250SpeedyIngameTester()
  {
    packetIsValid = false;
  }

  /**
   * Register the handler for this packet
   * @param packetHandlerRegistry
   * @param packetHandlerMethod
   * @param side
   */
  public static void registerHandler(PacketHandlerRegistry packetHandlerRegistry,  PacketHandlerMethod packetHandlerMethod, Side side) {
    if (side != Side.SERVER) {
      assert false : "Tried to register Packet250SpeedyIngameTester on side " + side;
    }
    serverSideHandler = packetHandlerMethod;
    packetHandlerRegistry.getSimpleNetworkWrapper().registerMessage(ServerMessageHandler.class, Packet250SpeedyIngameTester.class,
                                                                    Packet250Types.PACKET250_INGAME_TESTER.getPacketTypeID(), side);
  }

  public interface PacketHandlerMethod
  {
    public boolean handlePacket(Packet250SpeedyIngameTester packet250SpeedyIngameTester, MessageContext ctx);
  }

  public static class ServerMessageHandler implements IMessageHandler<Packet250SpeedyIngameTester, IMessage> {
    /**
     * Called when a message is received of the appropriate type. You can optionally return a reply message, or null if no reply
     * is needed.
     *
     * @param message The message
     * @return an optional return message
     */
    public IMessage onMessage(final Packet250SpeedyIngameTester message, final MessageContext ctx)
    {
      if (serverSideHandler == null) {
        ErrorLog.defaultLog().severe("Packet250SpeedyIngameTester received but not registered.");
      } else if (ctx.side != Side.SERVER) {
        ErrorLog.defaultLog().severe("Packet250SpeedyIngameTester received on wrong side");
      } else {
        Runnable messageProcessor = new Runnable() {
          @Override
          public void run() {
            serverSideHandler.handlePacket(message, ctx);
          }
        };
        SpeedyToolsMod.proxy.enqueueMessageOnCorrectThread(ctx, messageProcessor);
      }
      return null;
    }
  }

  @Override
  protected void readFromBuffer(ByteBuf buf)
  {
    packetIsValid = false;
    try {
      whichTest = buf.readInt();
      performTest = buf.readBoolean();
    } catch (IndexOutOfBoundsException ioe) {
      ErrorLog.defaultLog().info("Exception while reading Packet250SpeedyIngameTester: " + ioe);
      return;
    }
    if (!checkInvariants()) return;
    packetIsValid = true;
  }

  @Override
  protected void writeToBuffer(ByteBuf buf)
  {
    if (!isPacketIsValid()) {
      ErrorLog.defaultLog().info("Invalid packet Packet250SpeedyIngameTester");
      return;
    }
    buf.writeInt(whichTest);
    buf.writeBoolean(performTest);
  }

  /**
   * Checks if the packet is internally consistent
   * @return true for success, false otherwise
   */
  private boolean checkInvariants()
  {
    return true;
  }

  public int getWhichTest() {
    return whichTest;
  }

  private int whichTest;

  public boolean isPerformTest() {
    return performTest;
  }

  private boolean performTest;

  private static PacketHandlerMethod serverSideHandler;

}