Package com.framed.communicator.driver.protocol.replay

Record Class ReplayProtocol.ReplayStats

java.lang.Object
java.lang.Record
com.framed.communicator.driver.protocol.replay.ReplayProtocol.ReplayStats
Record Components:
events - number of events published
wallSeconds - wall-clock duration of the replay
achievedHz - events published per wall-clock second
targetHz - events per second the schedule called for (0 when free-running)
meanLagMs - mean of actualEmit − scheduledEmit; negligible when the replay keeps pace
maxLagMs - largest single such lag
Enclosing class:
ReplayProtocol
public static record ReplayProtocol.ReplayStats(long events, double wallSeconds, double achievedHz, double targetHz, double meanLagMs, long maxLagMs) extends Record
Figures describing one completed replay: how much was published, how fast, and how far behind its own schedule the replay thread ran.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final ReplayProtocol.ReplayStats
    EMPTY
    The figures of a replay that has not published anything yet.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ReplayStats(long events, double wallSeconds, double achievedHz, double targetHz, double meanLagMs, long maxLagMs)
    Creates an instance of a ReplayStats record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    double
    achievedHz()
    Returns the value of the achievedHz record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    long
    events()
    Returns the value of the events record component.
    final int
    hashCode()
    Returns a hash code value for this object.
    long
    maxLagMs()
    Returns the value of the maxLagMs record component.
    double
    meanLagMs()
    Returns the value of the meanLagMs record component.
    double
    targetHz()
    Returns the value of the targetHz record component.
    String
    toString()
    Returns a string representation of this record class.
    double
    wallSeconds()
    Returns the value of the wallSeconds record component.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Field Details

  • Constructor Details

    • ReplayStats

      public ReplayStats(long events, double wallSeconds, double achievedHz, double targetHz, double meanLagMs, long maxLagMs)
      Creates an instance of a ReplayStats record class.
      Parameters:
      events - the value for the events record component
      wallSeconds - the value for the wallSeconds record component
      achievedHz - the value for the achievedHz record component
      targetHz - the value for the targetHz record component
      meanLagMs - the value for the meanLagMs record component
      maxLagMs - the value for the maxLagMs record component

  • Method Details

    • toString

      public 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 '=='.
      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.

    • events

      public long events()
      Returns the value of the events record component.
      Returns:
      the value of the events record component

    • wallSeconds

      public double wallSeconds()
      Returns the value of the wallSeconds record component.
      Returns:
      the value of the wallSeconds record component

    • achievedHz

      public double achievedHz()
      Returns the value of the achievedHz record component.
      Returns:
      the value of the achievedHz record component

    • targetHz

      public double targetHz()
      Returns the value of the targetHz record component.
      Returns:
      the value of the targetHz record component

    • meanLagMs

      public double meanLagMs()
      Returns the value of the meanLagMs record component.
      Returns:
      the value of the meanLagMs record component

    • maxLagMs

      public long maxLagMs()
      Returns the value of the maxLagMs record component.
      Returns:
      the value of the maxLagMs record component