Struct webrtc::ice_transport::ice_gatherer::RTCIceGatherer

pub struct RTCIceGatherer { /* private fields */ }

ICEGatherer gathers local host, server reflexive and relay candidates, as well as enabling the retrieval of local Interactive Connectivity Establishment (ICE) parameters which can be exchanged in signaling.

Implementations

impl RTCIceGatherer

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

Gather ICE candidates.

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

Close prunes all local candidates, and closes the ports.

pub async fn get_local_parameters(&self) -> Result<RTCIceParameters>

get_local_parameters returns the ICE parameters of the ICEGatherer.

pub async fn get_local_candidates(&self) -> Result<Vec<RTCIceCandidate>>

get_local_candidates returns the sequence of valid local candidates associated with the ICEGatherer.

pub fn on_local_candidate(&self, f: OnLocalCandidateHdlrFn)

on_local_candidate sets an event handler which fires when a new local ICE candidate is available Take note that the handler is gonna be called with a nil pointer when gathering is finished.

pub fn on_state_change(&self, f: OnICEGathererStateChangeHdlrFn)

on_state_change sets an event handler which fires any time the ICEGatherer changes

pub fn on_gathering_complete(&self, f: OnGatheringCompleteHdlrFn)

on_gathering_complete sets an event handler which fires any time the ICEGatherer changes

pub fn state(&self) -> RTCIceGathererState

State indicates the current state of the ICE gatherer.

pub async fn set_state(&self, s: RTCIceGathererState)

Trait Implementations

impl Default for RTCIceGatherer

fn default() -> RTCIceGatherer

Returns the “default value” for a type.