Struct rtc_ice::agent::agent_config::AgentConfig

pub struct AgentConfig {

    pub urls: Vec<Url>,
    pub local_ufrag: String,
    pub local_pwd: String,
    pub disconnected_timeout: Option<Duration>,
    pub failed_timeout: Option<Duration>,
    pub keepalive_interval: Option<Duration>,
    pub candidate_types: Vec<CandidateType>,
    pub check_interval: Duration,
    pub max_binding_requests: Option<u16>,
    pub is_controlling: bool,
    pub lite: bool,
    pub host_acceptance_min_wait: Option<Duration>,
    pub srflx_acceptance_min_wait: Option<Duration>,
    pub prflx_acceptance_min_wait: Option<Duration>,
    pub relay_acceptance_min_wait: Option<Duration>,
    pub insecure_skip_verify: bool,
}

Collects the arguments to ice::Agent construction into a single structure, for future-proofness of the interface.

Fields

urls: Vec<Url>

local_ufrag: String

It is used to perform connectivity checks. The values MUST be unguessable, with at least 128 bits of random number generator output used to generate the password, and at least 24 bits of output to generate the username fragment.

local_pwd: String

It is used to perform connectivity checks. The values MUST be unguessable, with at least 128 bits of random number generator output used to generate the password, and at least 24 bits of output to generate the username fragment.

disconnected_timeout: Option<Duration>

Defaults to 5 seconds when this property is nil. If the duration is 0, the ICE Agent will never go to disconnected.

failed_timeout: Option<Duration>

Defaults to 25 seconds when this property is nil. If the duration is 0, we will never go to failed.

keepalive_interval: Option<Duration>

Determines how often should we send ICE keepalives (should be less then connectiontimeout above) when this is nil, it defaults to 10 seconds. A keepalive interval of 0 means we never send keepalive packets

candidate_types: Vec<CandidateType>

An optional configuration for disabling or enabling support for specific candidate types.

check_interval: Duration

Controls how often our internal task loop runs when in the connecting state. Only useful for testing.

max_binding_requests: Option<u16>

The max amount of binding requests the agent will send over a candidate pair for validation or nomination, if after max_binding_requests the candidate is yet to answer a binding request or a nomination we set the pair as failed.

is_controlling: bool

lite: bool

lite agents do not perform connectivity check and only provide host candidates.

host_acceptance_min_wait: Option<Duration>

Specify a minimum wait time before selecting host candidates.

srflx_acceptance_min_wait: Option<Duration>

Specify a minimum wait time before selecting srfl candidates.

prflx_acceptance_min_wait: Option<Duration>

Specify a minimum wait time before selecting prfl candidates.

relay_acceptance_min_wait: Option<Duration>

Specify a minimum wait time before selecting relay candidates.

insecure_skip_verify: bool

Controls if self-signed certificates are accepted when connecting to TURN servers via TLS or DTLS.

Trait Implementations

impl Default for AgentConfig

fn default() -> AgentConfig

Returns the “default value” for a type.