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

Enum ChannelState

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<ChannelState>
    public enum ChannelState
extends java.lang.Enum<ChannelState>

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      CONNECTED
      Channel is up.
      DISCONNECTED
      The channel is down.
      ERRORED
      An error occured establishing the channel.
      INCOMPATIBLE
      The channel can connect, but the other side isn't compatible.
      UNSURE
      The channel is in the process of connecting- the failover timeout hasn't been surpassed yet.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static ChannelState valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static ChannelState[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • ERRORED

        public static final ChannelState ERRORED
        An error occured establishing the channel.

      • INCOMPATIBLE

        public static final ChannelState INCOMPATIBLE
        The channel can connect, but the other side isn't compatible.

      • DISCONNECTED

        public static final ChannelState DISCONNECTED
        The channel is down. The other side is "dead". This means that any applicable timeouts have been passed.

      • UNSURE

        public static final ChannelState UNSURE
        The channel is in the process of connecting- the failover timeout hasn't been surpassed yet.

      • CONNECTED

        public static final ChannelState CONNECTED
        Channel is up.

    • Method Detail

      • values

        public static ChannelState[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (ChannelState c : ChannelState.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static ChannelState valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null