Struct Agent 

pub struct Agent { /* private fields */ }

The sans-IO ICE agent.

One agent per data stream, which is one checklist. The checklist set it holds is still a set — see super::checklist — because §6.1.2.6’s unfreezing rule is stated over the set.

Implementations

impl Agent

pub fn new( config: Config, offerer: bool, credentials: Credentials, tiebreaker: u64, ) -> Self

A new agent.

offerer is whether sipx sent the initial offer, which is §6.1.1’s role determination for two full agents; tiebreaker is §7.1.3’s 64-bit value, chosen at random per ICE session.

The initial tiebreaker is the caller’s so that a test can choose it — §7.3.1.1’s T = V row is not reachable otherwise. The redraw after a 487 is not, and cannot be: §7.2.5.1 requires the value to change, and in the symmetric conflict both ends apply the same rule to the same old value, so anything derived from it leaves them equal and oscillating (see this module’s fresh_tiebreaker). That one path reaches for the process RNG, as stun::new_transaction_id already does for every check’s transaction ID. Randomness is not I/O — no clock is read and no socket is touched — but it does mean the 487 path is the one place a test can pin only that the value changed, not what it became.

pub const fn role(&self) -> Role

Our role (§6.1.1), which §7.3.1.1 and §7.2.5.1 may change.

pub const fn tiebreaker(&self) -> u64

Our tiebreaker (§7.1.3). It changes when a 487 does (§7.2.5.1).

pub const fn credentials(&self) -> &Credentials

Our short-term credentials — what a later offer or answer must put in a=ice-ufrag and a=ice-pwd for this stream (spec §13.5).

Read rather than remembered by the caller: these change under Input::LocalCredentials, and a signalling layer holding its own copy is a second place for them to be right.

pub const fn checklists(&self) -> &ChecklistSet

The checklist set.

pub fn local_candidates(&self) -> &[LocalCandidate]

The local candidates, including any peer-reflexive one §7.2.5.3.1 learned.

pub fn remote_candidates(&self) -> &[RemoteCandidate]

The remote candidates, including any peer-reflexive one §7.3.1.3 learned.

pub fn selected( &self, component: ComponentId, ) -> Option<(LocalBase, SocketAddr)>

The selected pair for a component, once there is one (§8.1.1).

pub fn handle(&mut self, input: Input) -> Vec<Output>

Feed the agent an event and get back what the driver must do.

Trait Implementations

impl Debug for Agent

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

Formats the value using the given formatter.