Struct Checklist 

pub struct Checklist { /* private fields */ }

One data stream’s checklist, its triggered-check queue and its valid list.

Implementations

impl Checklist

pub fn new(pairs: Vec<CandidatePair>) -> Self

A checklist over these pairs, before §6.1.2.6 has set any state.

pub fn pairs(&self) -> &[CandidatePair]

The pairs, in checklist order.

pub fn pair(&self, id: PairId) -> Option<&CandidatePair>

The pair with this identity.

pub fn pair_mut(&mut self, id: PairId) -> Option<&mut CandidatePair>

The pair with this identity, mutably.

pub fn state(&self) -> ChecklistState

The checklist’s state. Running until §6.1.2.6 has run.

pub fn set_state(&mut self, state: ChecklistState)

Set the checklist’s state (§7.2.5.4, §8.1.2).

pub fn valid(&self) -> &[ValidPair]

The valid list (§7.2.5.3.2).

pub fn add_valid(&mut self, pair: ValidPair) -> bool

Add a valid pair, or update the one already there for the same local and remote.

Returns whether it was new, which is what arms spec §8’s Tn: the stopping criterion counts from the first valid pair, and a retransmitted check that revalidates a pair already in the list must not restart it.

pub fn nominate_valid(&mut self, generated_by: PairId)

Mark the valid pair a check produced as nominated (§7.2.5.3.4).

pub fn remove_valid(&mut self, generated_by: PairId)

Drop a valid pair whose nominated check later failed (§7.2.5.3.4).

pub fn trigger(&mut self, id: PairId)

Enqueue a triggered check (§7.3.1.4). A pair already queued is not queued twice.

pub fn take_triggered(&mut self) -> Option<PairId>

Take the next triggered check. §6.1.4.1’s queue is FIFO, and §6.1.4.2 empties it before it looks at any Waiting pair — which is what makes ICE converge in the time it takes a peer’s check to arrive rather than in checklist order.

pub fn has_triggered(&self) -> bool

Whether anything at all is queued for a triggered check.

pub fn is_triggered(&self, id: PairId) -> bool

Whether a triggered check is queued for this pair.

pub fn find(&self, local: LocalId, remote: RemoteId) -> Option<PairId>

The pair joining these two candidates, if the checklist has one.

pub fn insert(&mut self, pair: CandidatePair)

Insert a pair §7.3.1.4 built from an inbound check, “based on its priority”.

pub fn sort(&mut self)

Sort into decreasing pair priority (§6.1.2.3).

Stable, so that equal priorities keep the order they were formed in: §6.1.2.3 says ties are ordered arbitrarily, and a test that asserts on a checklist needs the same arbitrary answer twice.

pub fn components(&self) -> Vec<ComponentId>

The components this checklist has pairs for.

pub fn keep_only_nominated(&mut self, component: ComponentId, keep: PairId)

Remove every pair for a component but the one just nominated (§8.1.2).

Trait Implementations

impl Debug for Checklist

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

Formats the value using the given formatter.

impl Default for Checklist

fn default() -> Checklist

Returns the “default value” for a type.