Package crow.game.codec

Record Class Packet

java.lang.Object
java.lang.Record
crow.game.codec.Packet
public record Packet(io.netty.buffer.ByteBuf buffer, PacketRule rule, int size) extends Record
The packet object pairs the byte stream with the matched rule.

The byte buffer does NOT contain the packet ID or length, that is already read.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Packet(io.netty.buffer.ByteBuf buffer, PacketRule rule, int size)
    Creates an instance of a Packet record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    io.netty.buffer.ByteBuf
    buffer()
    Returns the value of the buffer record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    PacketRule
    rule()
    Returns the value of the rule record component.
    int
    size()
    Returns the value of the size record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • Packet

      public Packet(io.netty.buffer.ByteBuf buffer, PacketRule rule, int size)
      Creates an instance of a Packet record class.
      Parameters:
      buffer - the value for the buffer record component
      rule - the value for the rule record component
      size - the value for the size record component

  • Method Details

    • 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      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.

    • buffer

      public io.netty.buffer.ByteBuf buffer()
      Returns the value of the buffer record component.
      Returns:
      the value of the buffer record component

    • rule

      public PacketRule rule()
      Returns the value of the rule record component.
      Returns:
      the value of the rule record component

    • size

      public int size()
      Returns the value of the size record component.
      Returns:
      the value of the size record component