Struct turnclient::TurnClientBuilder

pub struct TurnClientBuilder {
    pub turn_server: SocketAddr,
    pub username: String,
    pub password: String,
    pub max_retries: usize,
    pub retry_interval: Duration,
    pub refresh_interval: Duration,
    pub software: Option<&'static str>,
}

Options for connecting to TURN server

Fields

turn_server: SocketAddr

Address of the TURN server

username: String

Username for TURN authentication

password: String

Password for TURN authentication

max_retries: usize

Maximum number of retries for any request

retry_interval: Duration

How often to retry varions requests

refresh_interval: Duration

How often to renew the allocation

software: Option<&'static str>

SOFTWARE attribute value in requests None means no attribute

Implementations

impl TurnClientBuilder

pub fn new(turn_server: SocketAddr, username: String, password: String) -> Self

A constructor with obligatory parameters

pub fn build_and_send_request(self, udp: UdpSocket) -> TurnClient

Finish setting options and get object to be polled. Does not actually send the allocate request until returned TurnClient is polled.