Package devs.beer.nativepackets.api

Record Class PacketSendResult

java.lang.Object
java.lang.Record
devs.beer.nativepackets.api.PacketSendResult
public record PacketSendResult(PacketSendOutcome outcome, Throwable failure) extends Record
Immutable result of one tracked outbound write.

  • Constructor Details

    • PacketSendResult

      public PacketSendResult(PacketSendOutcome outcome, Throwable failure)
      Creates an instance of a PacketSendResult record class.
      Parameters:
      outcome - the value for the outcome record component
      failure - the value for the failure record component

  • Method Details

    • success

      public static PacketSendResult success()
      Returns a successful actual write.

    • cancelled

      public static PacketSendResult cancelled()
      Returns a listener-cancelled no-write outcome.

    • failed

      public static PacketSendResult failed(Throwable failure)
      Returns a failed dispatch or actual write.

    • aborted

      public static PacketSendResult aborted()
      Returns lifecycle cleanup before transport completion.

    • successful

      public boolean successful()
      Reports actual successful downstream completion.

    • 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.

    • outcome

      public PacketSendOutcome outcome()
      Returns the value of the outcome record component.
      Returns:
      the value of the outcome record component

    • failure

      public Throwable failure()
      Returns the value of the failure record component.
      Returns:
      the value of the failure record component