Package com.inductiveautomation.ignition.gateway.redundancy.types

Interface RestoreAware

All Known Implementing Classes:
AbstractSynchronizedStateProvider, SnapshotStateProvider
public interface RestoreAware
Interface to indicate that the implementing class needs to implement a flag that indicates whether the redundant backup is in the midst of a gateway restore. This indicates that partial updates do not need to be accumulated while the flag is true. This behavior can differ across redundant providers. Some providers don't accumulate partial updates (such as the project redundant provider) and thus don't need to pay attention when a restore is in progress.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    isRestoreInProgress()
    If true, this indicates that the backup is in the midst of a gateway restore.
    void
    setRestoreInProgress(boolean inProgress)
     

  • Method Details

    • isRestoreInProgress

      boolean isRestoreInProgress()
      If true, this indicates that the backup is in the midst of a gateway restore. This can indicate that partial updates do not need to be accumulated if a full sync will be performed later when the other side reconnects. Each redundant provider can use this information as it sees fit.

    • setRestoreInProgress

      void setRestoreInProgress(boolean inProgress)
      Parameters:
      inProgress - Set to true to indicate that the backup is currently processing a gateway restore