Struct msf_ice::Agent

pub struct Agent { /* private fields */ }

ICE agent.

Usage

0. Get all components and prepare them for data/media transmission.
1. Get the local credentials for all channels and send them over to a remote agent.
2. Get all local candidates and send them over to the remote agent.
3. Set remote credentials for all channels (required to be done before adding remote candidates).
4. Add remote candidates.
5. If there are no more remote candidates, conclude connectivity checks.

Implementations

impl Agent

pub fn builder(agent_role: AgentRole) -> AgentBuilder

Get an ICE agent builder.

pub fn poll_next_local_candidate(
    &mut self,
    cx: &mut Context<'_>
) -> Poll<Option<LocalCandidate>>

Get the next local candidate.

pub async fn next_local_candidate(&mut self) -> Option<LocalCandidate>

Get the next local candidate.

pub fn channels(&self) -> usize

Get the number of channels.

pub fn get_local_credentials(&self, channel: usize) -> Credentials

Get local credentials of a given channel.

pub fn get_remote_credentials(&self, channel: usize) -> Option<Credentials>

Get remote credentials of a given channel (if known).

pub fn set_remote_credentials(
    &mut self,
    channel: usize,
    credentials: Credentials
)

Set remote credentials for a given channel.

pub fn add_remote_candidate(
    &mut self,
    candidate: RemoteCandidate,
    username_fragment: Option<&str>
)

Add a given remote candidate.

Panics

The method will panic if the remote credentials for the corresponding channel have not been set.