Trait webrtc_ice::candidate::Candidate[−][src]

pub trait Candidate: Display {

Show methods    fn foundation(&self) -> String;

    fn id(&self) -> String;

    fn component(&self) -> u16;

    fn set_component(&self, c: u16);

    fn last_received(&self) -> SystemTime;

    fn last_sent(&self) -> SystemTime;

    fn network_type(&self) -> NetworkType;

    fn address(&self) -> String;

    fn port(&self) -> u16;

    fn priority(&self) -> u32;

    fn related_address(&self) -> Option<CandidateRelatedAddress>;

    fn candidate_type(&self) -> CandidateType;

    fn tcp_type(&self) -> TcpType;

    fn marshal(&self) -> String;

    #[must_use]
    fn addr<'life0, 'async_trait>(
        &'life0 self
    ) -> Pin<Box<dyn Future<Output = SocketAddr> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait;

    #[must_use]
    fn close<'life0, 'async_trait>(
        &'life0 self
    ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait;

    fn seen(&self, outbound: bool);

    #[must_use]
    fn write_to<'life0, 'life1, 'life2, 'async_trait>(
        &'life0 self, 
        raw: &'life1 [u8], 
        dst: &'life2 (dyn Candidate + Send + Sync)
    ) -> Pin<Box<dyn Future<Output = Result<usize, Error>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        'life1: 'async_trait,
        'life2: 'async_trait,
        Self: 'async_trait;

    fn equal(&self, other: &dyn Candidate) -> bool;

    #[must_use]
    fn set_ip<'life0, 'life1, 'async_trait>(
        &'life0 self, 
        ip: &'life1 IpAddr
    ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        'life1: 'async_trait,
        Self: 'async_trait;

    fn get_conn(&self) -> Option<&Arc<dyn Conn + Send + Sync>>;

    fn get_agent(&self) -> Option<&Arc<Mutex<AgentInternal>>>;

    fn get_closed_ch(&self) -> Arc<Mutex<Option<Sender<()>>>>;

}
Expand description

Candidate represents an ICE candidate

Required methods

An arbitrary string used in the freezing algorithm to group similar candidates. It is the same for two candidates that have the same type, base IP address, protocol (UDP, TCP, etc.), and STUN or TURN server.

A unique identifier for just this candidate Unlike the foundation this is different for each candidate.

A component is a piece of a data stream. An example is one for RTP, and one for RTCP

The last time this candidate received traffic

The last time this candidate sent traffic

A transport address related to candidate, which is useful for diagnostics and other purposes.

Implementors

Returns Candidate ID.

Returns candidate component.

Returns a time indicating the last time this candidate was received.

Returns a time indicating the last time this candidate was sent.

Returns candidate NetworkType.

Returns Candidate Address.

Returns Candidate Port.

Computes the priority for this ICE Candidate.

Returns Option<CandidateRelatedAddress>.

Returns candidate type.

Returns the string representation of the ICECandidate.

Stops the recvLoop.

Used to compare two candidateBases.