Package dan200.computercraft.api.network

Record Class Packet

java.lang.Object
java.lang.Record
dan200.computercraft.api.network.Packet
Record Components:
channel - The channel to send the packet along. Receiving devices should only process packets from on channels they are listening to.
replyChannel - The channel to reply on.
payload - The contents of this packet. This should be a "valid" Lua object, safe for queuing as an event or returning from a peripheral call.
sender - The object which sent this packet.
public record Packet(int channel, int replyChannel, Object payload, PacketSender sender) extends Record
Represents a packet which may be sent across a PacketNetwork.
See Also:

  • Constructor Details

    • Packet

      public Packet(int channel, int replyChannel, Object payload, PacketSender sender)
      Creates an instance of a Packet record class.
      Parameters:
      channel - the value for the channel record component
      replyChannel - the value for the replyChannel record component
      payload - the value for the payload record component
      sender - the value for the sender 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.

    • channel

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

    • replyChannel

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

    • payload

      public Object payload()
      Returns the value of the payload record component.
      Returns:
      the value of the payload record component

    • sender

      public PacketSender sender()
      Returns the value of the sender record component.
      Returns:
      the value of the sender record component