Interface IPacketGCMsg

  • All Known Implementing Classes:
    PacketClientGCMsg, PacketClientGCMsgProtobuf

    public interface IPacketGCMsg
    Represents a simple unified interface into game coordinator messages recieved from the network. This is contrasted with IClientGCMsg in that this interface is packet body agnostic and only allows simple access into the header. This interface is also immutable, and the underlying data cannot be modified.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      byte[] getData()
      Gets the underlying data that represents this client message.
      int getMsgType()
      Gets the network message type of this packet message.
      JobID getSourceJobID()
      Gets the source job id for this packet message.
      JobID getTargetJobID()
      Gets the target job id for this packet message.
      boolean isProto()
      Gets a value indicating whether this packet message is protobuf backed.
    • Method Detail

      • isProto

        boolean isProto()
        Gets a value indicating whether this packet message is protobuf backed.
        Returns:
        true if this instance is protobuf backed; otherwise, false.
      • getMsgType

        int getMsgType()
        Gets the network message type of this packet message.
        Returns:
        The message type.
      • getTargetJobID

        JobID getTargetJobID()
        Gets the target job id for this packet message.
        Returns:
        The target job id.
      • getSourceJobID

        JobID getSourceJobID()
        Gets the source job id for this packet message.
        Returns:
        The source job id.
      • getData

        byte[] getData()
        Gets the underlying data that represents this client message.
        Returns:
        The data.