Module webrtc.java

Package dev.onvoid.webrtc

Enum RTCIceConnectionState

java.lang.Object

java.lang.Enum<RTCIceConnectionState>

dev.onvoid.webrtc.RTCIceConnectionState

All Implemented Interfaces:

Serializable, Comparable<RTCIceConnectionState>

public enum RTCIceConnectionState
extends Enum<RTCIceConnectionState>

Describes the current state of the ICE agent and its connection to the ICE server (that is, the STUN or TURN server).

Author:

Alex Andres

Enum Constant Summary

Enum Constants

Enum Constant	Description
CHECKING	None of the previous states apply and any RTCIceTransports are in the "NEW" or "CHECKING" state.
CLOSED	The RTCPeerConnection is closed.
COMPLETED	None of the previous states apply and all RTCIceTransports are in the "COMPLETED" or "CLOSED" state.
CONNECTED	None of the previous states apply and all RTCIceTransports are in the "CONNECTED", "COMPLETED" or "CLOSED" state.
DISCONNECTED	None of the previous states apply and any RTCIceTransports are in the "DISCONNECTED" state.
FAILED	The previous state doesn't apply and any RTCIceTransports are in the "FAILED" state.
NEW	None of the previous states apply and all RTCIceTransports are in the "NEW" or "CLOSED" state, or there are no transports.

Method Summary

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

NEW

public static final RTCIceConnectionState NEW

None of the previous states apply and all RTCIceTransports are in the "NEW" or "CLOSED" state, or there are no transports.

CHECKING

public static final RTCIceConnectionState CHECKING

None of the previous states apply and any RTCIceTransports are in the "NEW" or "CHECKING" state.

CONNECTED

public static final RTCIceConnectionState CONNECTED

None of the previous states apply and all RTCIceTransports are in the "CONNECTED", "COMPLETED" or "CLOSED" state.

COMPLETED

public static final RTCIceConnectionState COMPLETED

None of the previous states apply and all RTCIceTransports are in the "COMPLETED" or "CLOSED" state.

FAILED

public static final RTCIceConnectionState FAILED

The previous state doesn't apply and any RTCIceTransports are in the "FAILED" state.

DISCONNECTED

public static final RTCIceConnectionState DISCONNECTED

None of the previous states apply and any RTCIceTransports are in the "DISCONNECTED" state.

CLOSED

public static final RTCIceConnectionState CLOSED

The RTCPeerConnection is closed.

Method Detail

values

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

Returns:

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

valueOf

public static RTCIceConnectionState valueOf(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:

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

NullPointerException - if the argument is null