Struct Component 

pub struct Component { /* private fields */ }

A Component in an ICE Stream

Implementations

impl Component

pub fn id(&self) -> usize

The component identifier within a particular ICE Stream

pub fn stream(&self) -> Stream

Retrieve the Stream for this component.

pub fn state(&self) -> ComponentConnectionState

Retrieve the current state of a Component

pub fn selected_pair(&self) -> Option<CandidatePair>

The CandidatePair this component has selected to send/receive data with. This will not be valid until the Component has reached ComponentConnectionState::Connected

pub fn gather_candidates<'a, 'b>( &self, sockets: impl IntoIterator<Item = (TransportType, &'a Address)>, turn_servers: impl IntoIterator<Item = (&'b Address, TurnConfig)>, ) -> Result<(), AgentError>

Start gathering candidates for this component. The parent Agent::poll is used to progress the gathering.

pub fn set_selected_pair(&self, pair: CandidatePair) -> Result<(), AgentError>

Set the pair that will be used to send/receive data. This will override the ICE negotiation chosen value.

pub fn send( &self, data: &[u8], now: Instant, ) -> Result<AgentTransmit, AgentError>

Send data to the peer using the selected pair. This will not succeed until the Component has reached ComponentConnectionState::Connected

Trait Implementations

impl Clone for Component

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Component

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Drop for Component

fn drop(&mut self)

Executes the destructor for this type.

impl Send for Component

impl Sync for Component