Package net.minestom.server.network.packet.server

Record Class FramedPacket

java.lang.Object
java.lang.Record
net.minestom.server.network.packet.server.FramedPacket
All Implemented Interfaces:
SendablePacket
@Internal public record FramedPacket(@NotNull ServerPacket packet, @NotNull ByteBuffer body) extends Record implements SendablePacket
Represents a packet which is already framed. (packet id+payload) + optional compression Can be used if you want to send the exact same buffer to multiple clients without processing it more than once.

The ByteBuffer will ultimately become a MemorySegment once out of incubation.

  • Constructor Summary

    Constructors
    Constructor
    Description
    FramedPacket(@NotNull ServerPacket packet, @NotNull ByteBuffer body)
    Creates an instance of a FramedPacket record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    @NotNull ByteBuffer
    body()
    Returns the value of the body 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.
    @NotNull ServerPacket
    packet()
    Returns the value of the packet 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

    • FramedPacket

      public FramedPacket(@NotNull @NotNull ServerPacket packet, @NotNull @NotNull ByteBuffer body)
      Creates an instance of a FramedPacket record class.
      Parameters:
      packet - the value for the packet record component
      body - the value for the body 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. All components in this record class are compared with Objects::equals(Object,Object).
      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.

    • packet

      @NotNull public @NotNull ServerPacket packet()
      Returns the value of the packet record component.
      Returns:
      the value of the packet record component

    • body

      @NotNull public @NotNull ByteBuffer body()
      Returns the value of the body record component.
      Returns:
      the value of the body record component