Struct Agent 

pub struct Agent { /* private fields */ }

Represents the ICE agent.

Implementations

impl Agent

pub fn get_candidate_pairs_stats(&self) -> Vec<CandidatePairStats>

Returns a list of candidate pair stats.

pub fn get_local_candidates_stats(&self) -> Vec<CandidateStats>

Returns a list of local candidates stats.

pub fn get_remote_candidates_stats(&self) -> Vec<CandidateStats>

Returns a list of remote candidates stats.

impl Agent

pub fn new(config: Arc<AgentConfig>) -> Result<Self>

Creates a new Agent.

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.

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, 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, is_controlling: bool, remote_ufrag: String, remote_pwd: String, ) -> Result<()>

start connectivity checks

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

Restarts the ICE Agent with the provided ufrag/pwd If no ufrag/pwd is provided the Agent will generate one itself.

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

Returns the local candidates.

Trait Implementations

impl Default for Agent

fn default() -> Self

Returns the “default value” for a type.

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

type Rout = TransportMessage<BytesMut>

Output read message type

type Wout = TransportMessage<BytesMut>

Output write message type

type Eout = Event

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.