com.twilio.video

Enum IceCandidatePairState

java.lang.Object

java.lang.Enum<IceCandidatePairState>

com.twilio.video.IceCandidatePairState

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<IceCandidatePairState>

public enum IceCandidatePairState
extends java.lang.Enum<IceCandidatePairState>

ICE candidate pair state as defined in RFC 5245.

Enum Constant Summary

Enum Constants

Enum Constant and Description
STATE_FAILED Failed: A check for this pair was already done and failed, either never producing any response or producing an unrecoverable failure response.
STATE_FROZEN Frozen: A check for this pair hasn't been performed, and it can't yet be performed until some other check succeeds, allowing this pair to unfreeze and move into the Waiting state.
STATE_IN_PROGRESS In-Progress: A check has been sent for this pair, but the transaction is in progress.
STATE_SUCCEEDED Succeeded: A check for this pair was already done and produced a successful result.
STATE_WAITING Waiting: A check has not been performed for this pair, and can be performed as soon as it is the highest-priority Waiting pair on the check list.

Method Summary

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

STATE_SUCCEEDED

public static final IceCandidatePairState STATE_SUCCEEDED

Succeeded: A check for this pair was already done and produced a successful result.

STATE_FROZEN

public static final IceCandidatePairState STATE_FROZEN

Frozen: A check for this pair hasn't been performed, and it can't yet be performed until some other check succeeds, allowing this pair to unfreeze and move into the Waiting state.

STATE_WAITING

public static final IceCandidatePairState STATE_WAITING

Waiting: A check has not been performed for this pair, and can be performed as soon as it is the highest-priority Waiting pair on the check list.

STATE_IN_PROGRESS

public static final IceCandidatePairState STATE_IN_PROGRESS

In-Progress: A check has been sent for this pair, but the transaction is in progress.

STATE_FAILED

public static final IceCandidatePairState STATE_FAILED

Failed: A check for this pair was already done and failed, either never producing any response or producing an unrecoverable failure response.

Method Detail

values

public static IceCandidatePairState[] 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 (IceCandidatePairState c : IceCandidatePairState.values())
    System.out.println(c);

Returns:

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

valueOf

public static IceCandidatePairState 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