IceConnectionState enum

Current state of an ICE agent and its connection.

Inheritance

• Object
• Enum
• IceConnectionState

Constructors

IceConnectionState()

const

Values

new_ → const IceConnectionState

ICE agent is gathering addresses or is waiting to be given remote candidates through calls to PeerConnection.addIceCandidate() (or both).

checking → const IceConnectionState

ICE agent has been given one or more remote candidates and is checking pairs of local and remote candidates against one another to try to find a compatible match, but hasn't yet found a pair which will allow the peer connection to be made. It's possible that gathering of candidates is also still underway.

connected → const IceConnectionState

Usable pairing of local and remote candidates has been found for all components of the connection, and the connection has been established. It's possible that gathering is still underway, and it's also possible that the ICE agent is still checking candidates against one another looking for a better connection to use.

completed → const IceConnectionState

ICE agent has finished gathering candidates, has checked all pairs against one another, and has found a connection for all components.

failed → const IceConnectionState

ICE candidate has checked all candidates pairs against one another and has failed to find compatible matches for all components of the connection. It's, however, possible that the ICE agent did find compatible connections for some components.

disconnected → const IceConnectionState

Checks to ensure that components are still connected failed for at least one component of the peer connection. This is a less stringent test than failed and may trigger intermittently and resolve just as spontaneously on less reliable networks, or during temporary disconnections. When the problem resolves, the connection may return to the connected state.

closed → const IceConnectionState

ICE agent for this peer connection has shut down and is no longer handling requests.

Properties

hashCode → int

The hash code for this object.

no setter, inherited

index → int

A numeric identifier for the enumerated value.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Constants

values → const List<IceConnectionState>

A constant List of the values in this enum, in order of their declaration.