Record Class SubscriptionStats

java.lang.Object
java.lang.Record
com.loomcache.server.journal.SubscriptionStats
Record Components:
delivered - Number of entries successfully delivered to the listener
pending - Number of entries waiting in the backpressure buffer
lag - Difference between journal head and subscription head
dropped - Number of entries dropped due to subscription queue overflow
public record SubscriptionStats(long delivered, long pending, long lag, long dropped) extends Record
Statistics for a journal subscription.
Since:
1.0

  • Constructor Summary

    Constructors
    Constructor
    Description
    SubscriptionStats(long delivered, long pending, long lag, long dropped)
    Creates an instance of a SubscriptionStats record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    long
    delivered()
    Returns the value of the delivered record component.
    long
    dropped()
    Returns the value of the dropped record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    long
    lag()
    Returns the value of the lag record component.
    long
    pending()
    Returns the value of the pending record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class Object

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

  • Constructor Details

    • SubscriptionStats

      public SubscriptionStats(long delivered, long pending, long lag, long dropped)
      Creates an instance of a SubscriptionStats record class.
      Parameters:
      delivered - the value for the delivered record component
      pending - the value for the pending record component
      lag - the value for the lag record component
      dropped - the value for the dropped 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 the compare method from their corresponding wrapper classes.
      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.

    • delivered

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

    • pending

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

    • lag

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

    • dropped

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