Enum IceConnectionState

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

PeerConnection’s ICE connection state.

Variants

New

ICE agent is gathering addresses or is waiting to be given remote candidates.

Checking

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 PeerConnection to be made. It’s possible that gathering of candidates is also still underway.

Connected

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

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

Failed

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

Disconnected

Checks to ensure that components are still connected failed for at least one component of the PeerConnection. This is a less stringent test than IceConnectionState::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 IceConnectionState::Connected state.

Closed

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

Trait Implementations

impl Clone for IceConnectionState

fn clone(&self) -> IceConnectionState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IceConnectionState

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for IceConnectionState

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<IceConnectionState> for PeerConnectionState

fn from(ice_con_state: IceConnectionState) -> Self

Converts to this type from the input type.

impl PartialEq for IceConnectionState

fn eq(&self, other: &IceConnectionState) -> 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 IceConnectionState

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 IceConnectionState

impl Eq for IceConnectionState

impl StructuralPartialEq for IceConnectionState