Struct Agent 

pub struct Agent { /* private fields */ }

Represents the ICE agent.

Implementations

impl Agent

pub fn get_candidate_pairs_stats(&self, now: Instant) -> Vec<CandidatePairStats>

Returns a list of candidate pair stats.

pub fn get_local_candidates_stats(&self, now: Instant) -> Vec<CandidateStats>

Returns a list of local candidates stats.

pub fn get_remote_candidates_stats(&self, now: Instant) -> Vec<CandidateStats>

Returns a list of remote candidates stats.

impl Agent

pub fn new( now: Instant, config: Arc<AgentConfig>, crypto_provider: Arc<dyn RTCCryptoProvider>, ) -> Result<Self>

Creates a new Agent.

The crypto provider is supplied by the caller; this crate never resolves a default. Builds an agent whose clock starts at now.

now is a constructor argument rather than an AgentConfig field because it is a value consumed once at construction, not a setting that persists for the agent’s lifetime — and because Instant has no Default, so a config field would force AgentConfig to drop #[derive(Default)] and break every ..Default::default() in its 31 call sites.

pub fn add_local_candidate(&mut self, c: Candidate) -> Result<bool>

Adds a new local candidate.

pub fn add_remote_candidate(&mut self, c: Candidate) -> Result<bool>

Adds a new remote candidate.

pub fn set_remote_credentials( &mut self, remote_ufrag: String, remote_pwd: String, ) -> Result<()>

Sets the credentials of the remote agent.

pub fn get_remote_credentials(&self) -> Option<&Credentials>

Returns the remote credentials.

pub fn get_local_credentials(&self) -> &Credentials

Returns the local credentials. The credentials to advertise, which is what SDP generation wants.

Returns credentials staged by Agent::generate_restart_credentials when an ICE restart is pending, so an offer carries the new ufrag/pwd. Inbound STUN validation deliberately does not go through here — it reads local_credentials directly, so the live session keeps working until Agent::apply_restart installs the new pair.

pub fn role(&self) -> bool

Whether this agent is the controlling one, which decides nomination.

pub fn set_role(&mut self, is_controlling: bool)

Sets the controlling role.

Determined by which side offered; the two agents must not agree, or nomination stalls.

pub fn state(&self) -> ConnectionState

The agent’s current connection state.

pub fn is_valid_non_stun_traffic( &mut self, now: Instant, transport: TransportContext, ) -> bool

Whether a non-STUN datagram on transport should be accepted as media.

Guards against accepting media from an address that has not passed a connectivity check.

pub fn get_selected_candidate_pair(&self) -> Option<(&Candidate, &Candidate)>

Returns the selected pair (local_candidate, remote_candidate) or none

pub fn get_best_available_candidate_pair( &self, ) -> Option<(&Candidate, &Candidate)>

The highest-priority pair that is still usable, whether or not it has been nominated.

pub fn start_connectivity_checks( &mut self, now: Instant, is_controlling: bool, remote_ufrag: String, remote_pwd: String, ) -> Result<()>

start connectivity checks

pub fn generate_restart_credentials( &mut self, ufrag: String, pwd: String, ) -> Result<()>

Restarts the ICE Agent with the provided ufrag/pwd If no ufrag/pwd is provided the Agent will generate one itself. Stages new local credentials for an ICE restart, without disturbing the live session.

This is the half of an ICE restart that an offerer needs before generating SDP: the offer must carry the new ufrag/pwd. It deliberately does not touch local_credentials, candidate pairs, or connection state, because JSEP requires createOffer to be free of side effects — and because inbound STUN is still being validated against the current credentials until the local description is applied.

Empty ufrag / pwd are filled from the crypto provider’s RNG. Call Agent::apply_restart to install them.

pub fn has_pending_restart(&self) -> bool

Whether Agent::generate_restart_credentials has staged a restart that is not yet applied.

pub fn apply_restart( &mut self, now: Instant, keep_local_candidates: bool, ) -> Result<()>

Applies a staged ICE restart, tearing down the old session and starting a new one at now.

Installs the credentials staged by Agent::generate_restart_credentials, if any, then discards the remote credentials, pending binding requests, candidate pairs and selected pair, and restarts the agent’s timers. With nothing staged, the current credentials are kept and only the session is restarted.

pub fn restart( &mut self, now: Instant, ufrag: String, pwd: String, keep_local_candidates: bool, ) -> Result<()>

Generates and immediately applies an ICE restart.

Equivalent to Agent::generate_restart_credentials followed by Agent::apply_restart. A JSEP-conformant offerer wants the two halves separately — credentials at createOffer, application at setLocalDescription — but this remains the right call for anything that restarts in one step.

pub fn get_local_candidates(&self) -> &[Candidate]

Returns the local candidates.

pub fn get_remote_candidates(&self) -> &[Candidate]

The remote candidates this agent has been given, in the order they were added.

Trait Implementations

impl Protocol<TransportMessage<BytesMut>, (), ()> for Agent

type Rout = TransportMessage<BytesMut>

Output read message type

type Wout = TransportMessage<BytesMut>

Output write message type

type Eout = TaggedEvent

Output event type

type Error = Error

Error type for protocol operations

type Time = Instant

Time/Instant type for timeout handling

fn handle_read(&mut self, msg: TaggedBytesMut) -> Result<()>

Handle an incoming read message.

fn poll_read(&mut self) -> Option<Self::Rout>

Poll for a processed read message.

fn handle_write(&mut self, _msg: ()) -> Result<(), Self::Error>

Handle an outgoing write message.

fn poll_write(&mut self) -> Option<Self::Wout>

Poll for a processed write message.

fn handle_event(&mut self, _evt: ()) -> Result<(), Self::Error>

Handle a custom event.

fn poll_event(&mut self) -> Option<Self::Eout>

Poll for a generated event.

fn handle_timeout(&mut self, now: Self::Time) -> Result<(), Self::Error>

Handle a timeout event.

fn poll_timeout(&mut self) -> Option<Self::Time>

Poll for the next timeout deadline.

fn close(&mut self) -> Result<(), Self::Error>

Close the protocol.