Package io.github.mahmoudimus.quic.token

Record Class IncomingToken

java.lang.Object
java.lang.Record
io.github.mahmoudimus.quic.token.IncomingToken
Record Components:
retrySourceId - the Source Connection ID of the server's Retry, which the server echoes in retry_source_connection_id, or null without a Retry token
originalDestinationId - the Destination Connection ID of the client's first Initial, for original_destination_connection_id
validated - whether the client's address is validated, lifting the anti-amplification limit
public record IncomingToken(ConnectionId retrySourceId, ConnectionId originalDestinationId, boolean validated) extends Record
What the token in a client's first Initial packet establishes.

  • Constructor Details

    • IncomingToken

      public IncomingToken(ConnectionId retrySourceId, ConnectionId originalDestinationId, boolean validated)
      The result of validating a token.
      Parameters:
      retrySourceId - the Retry's Source Connection ID, or null
      originalDestinationId - the original Destination Connection ID
      validated - whether the address is validated

  • Method Details

    • unvalidated

      public static IncomingToken unvalidated(ConnectionId destinationId)
      No usable token: the address is not validated.
      Parameters:
      destinationId - the Destination Connection ID of the Initial packet
      Returns:
      the result

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

    • retrySourceId

      public ConnectionId retrySourceId()
      Returns the value of the retrySourceId record component.
      Returns:
      the value of the retrySourceId record component

    • originalDestinationId

      public ConnectionId originalDestinationId()
      Returns the value of the originalDestinationId record component.
      Returns:
      the value of the originalDestinationId record component

    • validated

      public boolean validated()
      Returns the value of the validated record component.
      Returns:
      the value of the validated record component