Package com.amazonaws.ivs.broadcast

Enum Class RealTimeConnection.State

java.lang.Object

java.lang.Enum<RealTimeConnection.State>

com.amazonaws.ivs.broadcast.RealTimeConnection.State

All Implemented Interfaces:

Serializable, Comparable<RealTimeConnection.State>, Constable

Enclosing class:

RealTimeConnection

public static enum RealTimeConnection.State
extends Enum<RealTimeConnection.State>

The connection state of a RealTimeConnection.

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	The connection is active and ready for Stages to join.
CONNECTING	The connection is being established.
DISCONNECTED	The connection is not active.

Method Summary

Modifier and Type	Method	Description
static RealTimeConnection.State	valueOf(String name)	Returns the enum constant of this class with the specified name.
static RealTimeConnection.State[]	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

DISCONNECTED

public static final RealTimeConnection.State DISCONNECTED

The connection is not active.

CONNECTING

public static final RealTimeConnection.State CONNECTING

The connection is being established. Stages can join at this point.

CONNECTED

public static final RealTimeConnection.State CONNECTED

The connection is active and ready for Stages to join.

Method Details

values

public static RealTimeConnection.State[] 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 RealTimeConnection.State 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