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

Enum Class ChannelState

java.lang.Object

java.lang.Enum<ChannelState>

com.inductiveautomation.ignition.gateway.redundancy.types.ChannelState

All Implemented Interfaces:

Serializable, Comparable<ChannelState>, Constable

public enum ChannelState
extends Enum<ChannelState>

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

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

Modifier and Type	Method	Description
static ChannelState	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ChannelState[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

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 Details

values

public static ChannelState[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static ChannelState valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null