Package com.inductiveautomation.historian.gateway.api.storage.strategy

Class DebounceStorageStrategy

java.lang.Object
com.inductiveautomation.historian.gateway.api.storage.strategy.PointStorageStrategy
com.inductiveautomation.historian.gateway.api.storage.strategy.DebounceStorageStrategy
public class DebounceStorageStrategy extends PointStorageStrategy
A strategy for debouncing and batching temporal point storage operations.

This class extends PointStorageStrategy and provides mechanisms for managing temporal point queues, scheduling debounced processing, and handling shutdown scenarios.

  • Method Details

    • create

      public static DebounceStorageStrategy create(DebounceBatchConfig config)
      Creates a new instance of DebounceStorageStrategy with the specified configuration.

      This method initializes the strategy using the provided DebounceBatchConfig.

      Parameters:
      config - The configuration for the debounce batch strategy.
      Returns:
      A new DebounceStorageStrategy instance.

    • createDefault

      public static DebounceStorageStrategy createDefault(String processorName)
      Creates a default instance of DebounceStorageStrategy with a specified processor name.

      This method uses a default configuration generated for the given processor name.

      Parameters:
      processorName - The name of the processor for which the default configuration is created.
      Returns:
      A new DebounceStorageStrategy instance with the default configuration.

    • processAtomic

      public CompletionStage<StorageResult<AtomicPoint<?>>> processAtomic(List<AtomicPoint<?>> atomicPoints)
      Description copied from class: PointStorageStrategy
      Processes a list of atomic points asynchronously.
      Specified by:
      processAtomic in class PointStorageStrategy
      Parameters:
      atomicPoints - The list of atomic points to process.
      Returns:
      A CompletionStage representing the result of the storage operation.

    • processComplex

      public <C extends ComplexPoint<?>> CompletionStage<StorageResult<C>> processComplex(List<C> complexPoints)
      Description copied from class: PointStorageStrategy
      Processes a list of complex points asynchronously.
      Specified by:
      processComplex in class PointStorageStrategy
      Type Parameters:
      C - The type of complex points.
      Parameters:
      complexPoints - The list of complex points to process.
      Returns:
      A CompletionStage representing the result of the storage operation.

    • processChanges

      public <C extends ChangePoint<?>> CompletionStage<StorageResult<C>> processChanges(List<C> changePoints)
      Description copied from class: PointStorageStrategy
      Processes a list of change points asynchronously.
      Specified by:
      processChanges in class PointStorageStrategy
      Type Parameters:
      C - The type of change points.
      Parameters:
      changePoints - The list of change points to process.
      Returns:
      A CompletionStage representing the result of the storage operation.

    • shutdown

      public void shutdown()
      Description copied from class: PointStorageStrategy
      Shuts down the storage strategy, preventing further processing of points.
      Specified by:
      shutdown in class PointStorageStrategy