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

Interface RedundancySettings

public interface RedundancySettings
These are all of the redundancy settings for both master and backup. Some settings will only apply to one or the other.

  • Method Details

    • getNodeRole

      NodeRole getNodeRole()
      Desired role of node. This may be overridden by the system license.

    • setNodeRole

      void setNodeRole(NodeRole value)

    • getBackupHistoryLevel

      HistoryLevel getBackupHistoryLevel()
      How history should be treated when backup is active.

    • setBackupHistoryLevel

      void setBackupHistoryLevel(HistoryLevel value)

    • getStandbyActivityLevel

      ActivityLevel getStandbyActivityLevel()
      How the backup should run when not active.

    • setStandbyActivityLevel

      void setStandbyActivityLevel(ActivityLevel value)

    • getMasterRecoveryMode

      RecoveryMode getMasterRecoveryMode()

    • setMasterRecoveryMode

      void setMasterRecoveryMode(RecoveryMode value)

    • getStartupJoinWaitTime

      int getStartupJoinWaitTime()
      Returns how long, in milliseconds, we should wait after startup before determining our state. This gives the nodes a chance to connect and negotiate their roles, preventing unnecessary switching and potential dual-execution.

    • setStartupJoinWaitTime

      void setStartupJoinWaitTime(int value)

    • getAutoDetectLocalInterface

      boolean getAutoDetectLocalInterface()

    • setAutoDetectLocalInterface

      void setAutoDetectLocalInterface(boolean value)

    • getLocalInterfaceBind

      String getLocalInterfaceBind()

    • setLocalInterfaceBind

      void setLocalInterfaceBind(String value)

    • getAutoDetectHttp

      @Deprecated boolean getAutoDetectHttp()
      Deprecated.

    • setAutoDetectHttp

      @Deprecated void setAutoDetectHttp(boolean value)
      Deprecated.

    • getHttpAddresses

      @Deprecated List<HttpURL> getHttpAddresses()
      Deprecated.

    • setHttpAddresses

      @Deprecated void setHttpAddresses(List<HttpURL> addresses)
      Deprecated.

    • getSystemStateUID

      String getSystemStateUID()

    • getSystemStateRevision

      long getSystemStateRevision()

    • setSystemStateInformation

      void setSystemStateInformation(String uid, long rev)

    • copyFrom

      void copyFrom(RedundancySettings settings)

    • getMaxDiskMB

      long getMaxDiskMB()
      The size of all config update .tsk files in the redundant_state folder ideally should not exceed this value. If they do, the master will give up on saving config updates and kick over a full gwbk to the backup instead.

    • setMaxDiskMB

      void setMaxDiskMB(long maxDiskMB)

    • setGanHost

      void setGanHost(String host)

    • getGanHost

      String getGanHost()
      Returns:
      Master server address

    • setGanPort

      void setGanPort(int port)

    • getGanPort

      int getGanPort()
      Returns:
      Master's gateway network connection port

    • setGanEnableSsl

      void setGanEnableSsl(boolean enableSsl)

    • getGanEnableSsl

      boolean getGanEnableSsl()
      Returns:
      true if the outgoing connection should use SSL to connect to the master

    • setGanPingRate

      void setGanPingRate(int pingRateMillis)

    • getGanPingRate

      int getGanPingRate()
      Returns:
      how often to ping the master

    • setGanPingTimeout

      void setGanPingTimeout(int pingTimeoutMillis)

    • getGanPingTimeout

      int getGanPingTimeout()
      How long to wait in milliseconds before giving up on waiting for a ping response

    • setGanPingMaxMissed

      void setGanPingMaxMissed(int pingMaxMissed)

    • getGanPingMaxMissed

      int getGanPingMaxMissed()
      The acceptable number of pings to miss before the gateway network connection is declared as faulted

    • setGanWebsocketTimeout

      void setGanWebsocketTimeout(int timeoutMillis)

    • getGanWebsocketTimeout

      int getGanWebsocketTimeout()
      Returns:
      How long to wait in milliseconds for the websocket to connect

    • setGanHttpConnectTimeout

      void setGanHttpConnectTimeout(int timeoutMillis)

    • getGanHttpConnectTimeout

      int getGanHttpConnectTimeout()
      Returns:
      How long to wait in milliseconds for the http data channel to connect

    • setGanHttpReadTimeout

      void setGanHttpReadTimeout(int timeoutMillis)

    • getGanHttpReadTimeout

      int getGanHttpReadTimeout()
      Returns:
      How long to wait in milliseconds for the http data channel to receive a response to a read request

    • getSyncTimeoutSecs

      int getSyncTimeoutSecs()
      Returns:
      The redundancy GAN queue timeout value. Any redundancy sync request or pull operation that takes longer than this value will be killed by the queue system.

    • setSyncTimeoutSecs

      void setSyncTimeoutSecs(int timeoutSecs)

    • useActiveUptimeToResolveConflict

      boolean useActiveUptimeToResolveConflict()
      Returns:
      true if the user has enabled the setting. The setting allows data on the backup to overwrite data on the master when there is a conflict and the backup is known to be active for longer.

    • setUseActiveUptimeToResolveConflict

      void setUseActiveUptimeToResolveConflict(boolean useActiveUptime)

    • getSendThreadCount

      int getSendThreadCount()
      Returns:
      number of threads to be used for sending messages

    • setSendThreadCount

      void setSendThreadCount(int threads)
      Parameters:
      threads - number of threads to be used for sending messages

    • getReceiveThreadCount

      int getReceiveThreadCount()
      Returns:
      number of threads to be used for receiving messages

    • setReceiveThreadCount

      void setReceiveThreadCount(int threads)
      Parameters:
      threads - number of threads to be used for receiving messages