Record Class MessageOutSuccessEvent

java.lang.Object
java.lang.Record
pt.unl.fct.di.novasys.babel2.events.MessageOutSuccessEvent
Record Components:
message - the message that was successfully sent
receiver - the remote node that received the message
All Implemented Interfaces:
BabelEvent, MessageEvent
public record MessageOutSuccessEvent(BabelMessage message, BabelNode receiver) extends Record implements MessageEvent
MessageEvent delivered when a previously sent BabelMessage was successfully handed off to the remote node.

Protocols handle these confirmations by annotating methods with @UponMessageOutSuccess.

  • Constructor Details

    • MessageOutSuccessEvent

      public MessageOutSuccessEvent(BabelMessage message, BabelNode receiver)
      Creates an instance of a MessageOutSuccessEvent record class.
      Parameters:
      message - the value for the message record component
      receiver - the value for the receiver 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.

    • message

      public BabelMessage message()
      Returns the value of the message record component.
      Specified by:
      message in interface MessageEvent
      Returns:
      the value of the message record component

    • receiver

      public BabelNode receiver()
      Returns the value of the receiver record component.
      Returns:
      the value of the receiver record component