Record Class PacketHeader

java.lang.Object
java.lang.Record
com.quietterminal.neon.core.PacketHeader
public record PacketHeader(short magic, byte version, byte packetType, short sequence, byte clientId, byte destinationId) extends Record

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    HEADER_SIZE
     
    static final short
    MAGIC
     
    static final byte
    VERSION
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    PacketHeader(short magic, byte version, byte packetType, short sequence, byte clientId, byte destinationId)
    Creates an instance of a PacketHeader record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    byte
    clientId()
    Returns the value of the clientId record component.
    static PacketHeader
    create(byte packetType, short sequence, byte clientId, byte destinationId)
     
    byte
    destinationId()
    Returns the value of the destinationId record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    static PacketHeader
    fromBytes(byte[] data)
     
    final int
    hashCode()
    Returns a hash code value for this object.
    short
    magic()
    Returns the value of the magic record component.
    byte
    packetType()
    Returns the value of the packetType record component.
    short
    sequence()
    Returns the value of the sequence record component.
    byte[]
    toBytes()
     
    final String
    toString()
    Returns a string representation of this record class.
    byte
    version()
    Returns the value of the version record component.

    Methods inherited from class Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Field Details

  • Constructor Details

    • PacketHeader

      public PacketHeader(short magic, byte version, byte packetType, short sequence, byte clientId, byte destinationId)
      Creates an instance of a PacketHeader record class.
      Parameters:
      magic - the value for the magic record component
      version - the value for the version record component
      packetType - the value for the packetType record component
      sequence - the value for the sequence record component
      clientId - the value for the clientId record component
      destinationId - the value for the destinationId record component

  • Method Details

    • create

      public static PacketHeader create(byte packetType, short sequence, byte clientId, byte destinationId)

    • toBytes

      public byte[] toBytes()

    • fromBytes

      public static PacketHeader fromBytes(byte[] data)

    • 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 the compare method from their corresponding wrapper classes.
      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.

    • magic

      public short magic()
      Returns the value of the magic record component.
      Returns:
      the value of the magic record component

    • version

      public byte version()
      Returns the value of the version record component.
      Returns:
      the value of the version record component

    • packetType

      public byte packetType()
      Returns the value of the packetType record component.
      Returns:
      the value of the packetType record component

    • sequence

      public short sequence()
      Returns the value of the sequence record component.
      Returns:
      the value of the sequence record component

    • clientId

      public byte clientId()
      Returns the value of the clientId record component.
      Returns:
      the value of the clientId record component

    • destinationId

      public byte destinationId()
      Returns the value of the destinationId record component.
      Returns:
      the value of the destinationId record component