Struct webrtc_ice::agent::Agent

pub struct Agent { /* fields omitted */ }

Represents the ICE agent.

Implementations

impl Agent

pub async fn dial(
    &self,
    cancel_rx: Receiver<()>,
    remote_ufrag: String,
    remote_pwd: String
) -> Result<Arc<impl Conn>>

Connects to the remote agent, acting as the controlling ice agent. The method blocks until at least one ice candidate pair has successfully connected.

pub async fn accept(
    &self,
    cancel_rx: Receiver<()>,
    remote_ufrag: String,
    remote_pwd: String
) -> Result<Arc<impl Conn>>

Connects to the remote agent, acting as the controlled ice agent. The method blocks until at least one ice candidate pair has successfully connected.

impl Agent

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

Creates a new Agent.

pub async fn on_connection_state_change(&self, f: OnConnectionStateChangeHdlrFn)

Sets a handler that is fired when the connection state changes.

pub async fn on_selected_candidate_pair_change(
    &self,
    f: OnSelectedCandidatePairChangeHdlrFn
)

Sets a handler that is fired when the final candidate pair is selected.

pub async fn on_candidate(&self, f: OnCandidateHdlrFn)

Sets a handler that is fired when new candidates gathered. When the gathering process complete the last candidate is nil.

pub async fn add_remote_candidate(
    &self,
    c: &Arc<dyn Candidate + Send + Sync>
) -> Result<()>

Adds a new remote candidate.

pub async fn get_local_candidates(
    &self
) -> Result<Vec<Arc<dyn Candidate + Send + Sync>>>

Returns the local candidates.

pub async fn get_local_user_credentials(&self) -> (String, String)

Returns the local user credentials.

pub async fn get_remote_user_credentials(&self) -> (String, String)

Returns the remote user credentials.

pub async fn close(&self) -> Result<()>

Cleans up the Agent.

pub async fn get_selected_candidate_pair(&self) -> Option<Arc<CandidatePair>>

Returns the selected pair or nil if there is none

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

Sets the credentials of the remote agent.

pub async fn restart(&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.

Restart must only be called when GatheringState is GatheringStateComplete a user must then call GatherCandidates explicitly to start generating new ones.

pub async fn gather_candidates(&self) -> Result<()>

Initiates the trickle based gathering process.

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

Returns a list of candidate pair stats.

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

Returns a list of local candidates stats.

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

Returns a list of remote candidates stats.

pub async fn unmarshal_remote_candidate(
    &self,
    raw: String
) -> Result<impl Candidate>

Creates a Remote Candidate from its string representation.