Struct TurnConfig 

pub struct TurnConfig { /* private fields */ }

Configuration structure for handling TURN client configuration.

Holds the following information:

• Long term credentials for connecting to a TURN server.
• The TransportType of the requested allocation.
• A list of AddressFamilys the allocation should be attempted to be created with.

Implementations

impl TurnConfig

pub fn new(credentials: TurnCredentials) -> TurnConfig

Construct a new TurnConfig with the provided credentials.

By default a IPV4/UDP allocation is requested.

Examples

let credentials = TurnCredentials::new("user", "pass");
let config = TurnConfig::new(credentials.clone());
assert_eq!(config.credentials(), &credentials);
assert_eq!(config.allocation_transport(), TransportType::Udp);
assert_eq!(config.address_families(), &[AddressFamily::IPV4]);

pub fn set_allocation_transport(&mut self, allocation_transport: TransportType)

Set the allocation transport requested.

Examples

let credentials = TurnCredentials::new("user", "pass");
let mut config = TurnConfig::new(credentials.clone());
config.set_allocation_transport(TransportType::Tcp);
assert_eq!(config.allocation_transport(), TransportType::Tcp);

pub fn allocation_transport(&self) -> TransportType

Retrieve the allocation transport requested.

pub fn add_address_family(&mut self, family: AddressFamily)

Add an AddressFamily that will be requested.

Duplicate AddressFamilys are ignored.

Examples

let credentials = TurnCredentials::new("user", "pass");
let mut config = TurnConfig::new(credentials.clone());
assert_eq!(config.address_families(), &[AddressFamily::IPV4]);
// Duplicate AddressFamily is ignored.
config.add_address_family(AddressFamily::IPV4);
assert_eq!(config.address_families(), &[AddressFamily::IPV4]);
config.add_address_family(AddressFamily::IPV6);
assert_eq!(config.address_families(), &[AddressFamily::IPV4, AddressFamily::IPV6]);

pub fn set_address_family(&mut self, family: AddressFamily)

Set the AddressFamily that will be requested.

Examples

let credentials = TurnCredentials::new("user", "pass");
let mut config = TurnConfig::new(credentials.clone());
assert_eq!(config.address_families(), &[AddressFamily::IPV4]);
config.set_address_family(AddressFamily::IPV4);
assert_eq!(config.address_families(), &[AddressFamily::IPV4]);
config.set_address_family(AddressFamily::IPV6);
assert_eq!(config.address_families(), &[AddressFamily::IPV6]);

pub fn address_families(&self) -> &[AddressFamily]

Retrieve the AddressFamilys that are requested.

pub fn credentials(&self) -> &TurnCredentials

Retrieve the TurnCredentials used for authenticating with the TURN server.

pub fn add_supported_integrity(&mut self, integrity: IntegrityAlgorithm)

Add a supported integrity algorithm that could be used.

pub fn set_supported_integrity(&mut self, integrity: IntegrityAlgorithm)

Set the supported integrity algorithm used.

pub fn supported_integrity(&self) -> &[IntegrityAlgorithm]

The supported integrity algorithms used.

pub fn set_anonymous_username(&mut self, anon: Feature)

Set whether anonymous username usage is required.

A value of Required requires the server to support RFC 8489 and the Userhash attribute.

pub fn anonymous_username(&self) -> Feature

Whether anonymous username usage is required.

A value of Required requires the server to support RFC 8489 and the Userhash attribute.

Trait Implementations

impl Clone for TurnConfig

fn clone(&self) -> TurnConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TurnConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Eq for TurnConfig

impl PartialEq for TurnConfig

fn eq(&self, other: &TurnConfig) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for TurnConfig