mediastreamer2 5.2.0
Data Fields
_IceCandidatePair Struct Reference

#include <ice.h>

Collaboration diagram for _IceCandidatePair:
Collaboration graph
[legend]

Data Fields

IceRole role
 
IceCandidatelocal
 
IceCandidateremote
 
IceCandidatePairState state
 
uint64_t priority
 
MSTimeSpec transmission_time
 
int32_t rto
 
uint8_t retransmissions
 
bool_t is_default
 
bool_t use_candidate
 
bool_t is_nominated
 
bool_t nomination_pending
 
bool_t has_canceled_transaction
 
bool_t nomination_failing
 
bool_t retry_with_dummy_message_integrity
 
bool_t use_dummy_hmac
 

Detailed Description

Structure representing an ICE candidate pair.

Field Documentation

◆ has_canceled_transaction

bool_t _IceCandidatePair::has_canceled_transaction

Boolean value telling whether this candidate pair was nominated by the remote (in controlled mode), but we could not yet complete the check Boolean value telling that the pair has a cancelled transaction, see RFC5245 7.2.1.4. Triggered Checks

◆ is_default

bool_t _IceCandidatePair::is_default

Boolean value telling whether this candidate pair is a default candidate pair or not

◆ is_nominated

bool_t _IceCandidatePair::is_nominated

Boolean value telling whether this candidate pair is nominated or not

◆ local

IceCandidate* _IceCandidatePair::local

Pointer to the local candidate of the pair

◆ nomination_failing

bool_t _IceCandidatePair::nomination_failing

Boolean that indicates that this pair was nominated but it is apparently failing because no response is received.

◆ priority

uint64_t _IceCandidatePair::priority

Priority of the candidate pair

◆ remote

IceCandidate* _IceCandidatePair::remote

Pointer to the remote candidate of the pair

◆ retransmissions

uint8_t _IceCandidatePair::retransmissions

Number of retransmissions for the connectivity check sent for the candidate pair

◆ role

IceRole _IceCandidatePair::role

Role of the agent when the connectivity check has been sent for the candidate pair

◆ rto

int32_t _IceCandidatePair::rto

Duration of the retransmit timer for the connectivity check sent for the candidate pair in ms

◆ state

IceCandidatePairState _IceCandidatePair::state

State of the candidate pair

◆ transmission_time

MSTimeSpec _IceCandidatePair::transmission_time

Time when the connectivity check for the candidate pair has been sent

◆ use_candidate

bool_t _IceCandidatePair::use_candidate

Boolean value telling if the USE-CANDIDATE attribute must be set for the connectivity checks send for the candidate pair

◆ use_dummy_hmac

bool_t _IceCandidatePair::use_dummy_hmac

use to tell to retry with dummy message integrity. Useful to keep backward compatibility with older version


The documentation for this struct was generated from the following file: