Enum IceConnectionState

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

States the ICE connection can be in.

More details on connection states can be found in the ICE RFC.

Variants

New

The ICE agent is gathering addresses.

Checking

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

Connected

A usable pairing of local and remote candidates has been found, and the connection has been established. The agent is not in Completed because it is still gathering candidates or is still checking candidates against one another looking for a better connection to use.

Completed

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

Disconnected

Connection failed. 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.

Implementations

impl IceConnectionState

pub fn is_connected(&self) -> bool

Tells if this state is a connected state.

pub fn is_disconnected(&self) -> bool

Tells if this state is a disconnected state.

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 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 Copy for IceConnectionState

impl Eq for IceConnectionState

impl StructuralPartialEq for IceConnectionState