Package com.inductiveautomation.eventstream.config

Record Class BatchConfig

java.lang.Object
java.lang.Record
com.inductiveautomation.eventstream.config.BatchConfig
Record Components:
debounceMs - Amount of time to wait after event arrives to forward events. Incoming events will reset the debounce time.
maxWaitMs - Max time to wait before forwarding events
maxQueueSize - Max amount of items to batch before dropping based on overflow. -1 for no limit.
overflow - Determines behavior when maxQueueSize has been hit
public record BatchConfig(long debounceMs, long maxWaitMs, int maxQueueSize, BatchConfig.Overflow overflow) extends Record
Configuration for batching

  • Field Details

    • DEFAULT

      public static BatchConfig DEFAULT
      Default batching settings. Should be used on initial EventStreamConfig creation

    • NO_BATCHING

      public static BatchConfig NO_BATCHING
      Prevent batching, items will be forwarded one at a time on a separate thread from previous stage.

  • Constructor Details

    • BatchConfig

      public BatchConfig(long debounceMs, long maxWaitMs, int maxQueueSize, BatchConfig.Overflow overflow)
      Creates an instance of a BatchConfig record class.
      Parameters:
      debounceMs - the value for the debounceMs record component
      maxWaitMs - the value for the maxWaitMs record component
      maxQueueSize - the value for the maxQueueSize record component
      overflow - the value for the overflow 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. 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.

    • debounceMs

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

    • maxWaitMs

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

    • maxQueueSize

      public int maxQueueSize()
      Returns the value of the maxQueueSize record component.
      Returns:
      the value of the maxQueueSize record component

    • overflow

      public BatchConfig.Overflow overflow()
      Returns the value of the overflow record component.
      Returns:
      the value of the overflow record component