Enum KnownRtcIceTransportState 

pub enum KnownRtcIceTransportState {
    Closed,
    Failed,
    Disconnected,
    New,
    Checking,
    Completed,
    Connected,
}

Possible states of the underlying ICE transport used by a RTCPeerConnection.

Variants

Closed

RTCIceTransport has shut down and is no longer responding to STUN requests.

Failed

RTCIceTransport has finished gathering, received an indication that there are no more remote candidates, finished checking all candidate pairs, and all pairs have either failed connectivity checks or lost consent, and either zero local candidates were gathered or the PAC timer has expired (see RFC8863).

This is a terminal state until ICE is restarted. Since an ICE restart may cause connectivity to resume, entering the Failed state doesn’t cause DTLS transports, SCTP associations or the data channels that run over them to close, or tracks to mute.

Disconnected

ICE Agent has determined that connectivity is currently lost for thw RTCIceTransport.

This is a transient state that may trigger intermittently (and resolve itself without action) on a flaky network. The way this state is determined is implementation dependent. Examples include:

• Losing the network interface for the connection in use.
• Repeatedly failing to receive a response to STUN requests.

Alternatively, the RTCIceTransport has finished checking all existing candidates pairs and not found a connection (or consent checks RFC7675 once successful, have now failed), but it is still gathering and/or waiting for additional remote candidates.

New

RTCIceTransport is gathering candidates and/or waiting for remote candidates to be supplied, and has not yet started checking.

Checking

RTCIceTransport has received at least one remote candidate (by means of addIceCandidate() or discovered as a peer-reflexive candidate when receiving a STUN binding request) and is checking candidate pairs and has either not yet found a connection or consent checks RFC7675 have failed on all previously successful candidate pairs.

In addition to checking, it may also still be gathering.

Completed

RTCIceTransport has finished gathering, received an indication that there are no more remote candidates, finished checking all candidate pairs and found a connection.

If consent checks RFC7675 subsequently fail on all successful candidate pairs, the state transitions to Failed.

Connected

RTCIceTransport has found a usable connection, but is still checking other candidate pairs to see if there is a better connection.

It may also still be gathering and/or waiting for additional remote candidates. If consent checks RFC7675 fail on the connection in use, and there are no other successful candidate pairs available, then the state transitions to Checking (if there are candidate pairs remaining to be checked) or Disconnected (if there are no candidate pairs to check, but the peer is still gathering and/or waiting for additional remote candidates).

Trait Implementations

impl Clone for KnownRtcIceTransportState

fn clone(&self) -> KnownRtcIceTransportState

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for KnownRtcIceTransportState

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for KnownRtcIceTransportState

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for KnownRtcIceTransportState

fn fmt(&self, __derive_more_f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Hash for KnownRtcIceTransportState

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for KnownRtcIceTransportState

fn eq(&self, other: &KnownRtcIceTransportState) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for KnownRtcIceTransportState

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for KnownRtcIceTransportState

impl Eq for KnownRtcIceTransportState

impl StructuralPartialEq for KnownRtcIceTransportState