Struct LocalCandidate 

pub struct LocalCandidate { /* private fields */ }

Local candidate.

Implementations

impl LocalCandidate

pub const fn calculate_priority( component: u8, kind: CandidateKind, base: SocketAddr, ) -> u32

Calculate local candidate priority for a given component ID, candidate type and the candidate base address.

pub const fn host(channel: usize, component: u8, addr: SocketAddr) -> Self

Create a new host candidate.

pub const fn server_reflexive( channel: usize, component: u8, base: SocketAddr, addr: SocketAddr, ) -> Self

Create a new server-reflexive candidate.

pub const fn peer_reflexive( channel: usize, component: u8, base: SocketAddr, addr: SocketAddr, ) -> Self

Create a new peer-reflexive candidate.

pub const fn relayed(channel: usize, component: u8, addr: SocketAddr) -> Self

Create a new relayed candidate.

pub fn with_foundation(self, foundation: u32) -> Self

Create a new candidate with a given foundation value.

pub fn channel(&self) -> usize

Get index of the (media) channel this candidate belongs to.

pub fn component(&self) -> u8

Get component ID of the component this candidate belongs to.

Note

Unlike the component ID definition in RFC 5245, this component ID is zero-based. In order to get the RFC 5245 component ID (e.g. to create a session description), you need to add one to this number.

pub fn kind(&self) -> CandidateKind

Get type of the candidate.

pub fn base(&self) -> SocketAddr

Get the base address.

pub fn addr(&self) -> SocketAddr

Get the address.

pub fn priority(&self) -> u32

Get candidate priority.

pub fn foundation(&self) -> u32

Get the foundation.

Trait Implementations

impl Clone for LocalCandidate

fn clone(&self) -> LocalCandidate

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for LocalCandidate