Struct Stream 

pub struct Stream { /* private fields */ }

An ICE Stream

Implementations

impl Stream

pub fn id(&self) -> usize

An agent-global unique identifier for the ICE stream.

pub fn agent(&self) -> Agent

The Agent that handles this Stream.

pub fn add_component(&self) -> Component

Add a Component to this stream.

pub fn component(&self, id: usize) -> Option<Component>

Retrieve a Component from this stream. If the index doesn’t exist or a component is not available at that index, None is returned

pub fn local_credentials(&self) -> Option<Credentials>

Retreive the previouly set local ICE credentials for this Stream.

pub fn remote_credentials(&self) -> Option<Credentials>

Retreive the previouly set remote ICE credentials for this Stream.

pub fn set_local_credentials(&self, credentials: &Credentials)

Set local ICE credentials for this Stream.

Examples

let mut agent = Agent::default();
let stream = agent.add_stream();
let credentials = Credentials::new("user", "pass");
stream.set_local_credentials(&credentials);
assert_eq!(stream.local_credentials(), Some(credentials));

pub fn set_remote_credentials(&self, credentials: &Credentials)

Set remote ICE credentials for this Stream.

Examples

let agent = Agent::default();
let stream = agent.add_stream();
let credentials = Credentials::new("user", "pass");
stream.set_remote_credentials(&credentials);
assert_eq!(stream.remote_credentials(), Some(credentials));

pub fn end_of_local_candidates(&self)

Signal the end of local candidates. Calling this function may allow ICE processing to complete.

pub fn add_remote_candidate(&self, cand: &Candidate)

Add a remote candidate for connection checks for use with this stream

pub fn end_of_remote_candidates(&self)

Indicate that no more candidates are expected from the peer. This may allow the ICE process to complete.

pub fn add_local_gathered_candidate(&self, gathered: GatheredCandidate) -> bool

Add a local candidate for this stream.

Returns whether the candidate was added internally.

pub fn allocated_socket( &self, component_id: usize, transport: TransportType, from: &Address, to: &Address, socket_addr: Option<Address>, )

Provide a reply to the AgentPoll::AllocateSocket request. The component_id, transport, from, and to values must match exactly with the request.

pub fn component_ids(&self) -> Vec<usize>

The list of component ids available in this stream

pub fn handle_incoming_data<'a>( &self, component_id: usize, transport: TransportType, from: Address, to: Address, data: &'a [u8], now: Instant, ) -> StreamIncomingDataReply<'a>

Provide the stream with data that has been received on an external socket. The returned value indicates what has been done with the data and any application data that has been received.

pub fn poll_recv(&self) -> Option<PollRecv>

Poll for any received data.

Must be called after handle_incoming_data if have_more_data is true.

Trait Implementations

impl Clone for Stream

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 Stream

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

Formats the value using the given formatter.

impl Drop for Stream

fn drop(&mut self)

Executes the destructor for this type.

impl Send for Stream

impl Sync for Stream