Struct StunClienteBuilder

pub struct StunClienteBuilder(/* private fields */);

Builder for the STUN client. It allows to configure the client with the required parameters for the STUN usage.

// Next example shows how to create a STUN client that uses
// long-term credentials to authenticate with the server over
// an unreliable transport and mandates the use of the FINGERPRINT
// attribute.
let client = StunClienteBuilder::new(
    TransportReliability::Unreliable(RttConfig::default()))
        .with_mechanism("user", "password", CredentialMechanism::LongTerm)
        .with_fingerprint()
        .build()?;

Implementations

impl StunClienteBuilder

pub fn new(reliability: TransportReliability) -> StunClienteBuilder

Creates a new STUN client builder with the given TransportReliability.

pub fn with_max_transactions(self, max_transactions: usize) -> Self

Sets the maximum number of outstanding transactions to the same server. The default value is 10.

pub fn with_mechanism<U, P>( self, user_name: U, password: P, mechanism: CredentialMechanism, ) -> Self

where U: Into<String>, P: Into<String>,

Sets the credentials for the STUN client.

pub fn with_fingerprint(self) -> Self

Sets the use of the FINGERPRINT attribute in the STUN messages. The FINGERPRINT mechanism is not backwards compatible with RFC3489 and cannot be used in environments where such compatibility is required.

pub fn build(self) -> Result<StunClient, StunAgentError>

Builds the STUN client with the given parameters.

Trait Implementations

impl Debug for StunClienteBuilder

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

Formats the value using the given formatter.