Struct Component

#[repr(C)]
pub struct Component<'a> { /* private fields */ }

A Component in an ICE Stream

Implementations

impl<'a> Component<'a>

pub fn id(&self) -> usize

The component identifier within a particular ICE Stream

pub fn state(&self) -> ComponentConnectionState

Retrieve the current state of a Component

Examples

The initial state is ComponentState::New

let mut agent = Agent::default();
let stream_id = agent.add_stream();
let mut stream = agent.mut_stream(stream_id).unwrap();
let component_id = stream.add_component().unwrap();
let component = stream.component(component_id).unwrap();
assert_eq!(component.state(), ComponentConnectionState::New);

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