Struct ClientConfig

pub struct ClientConfig {
    pub dialog: DialogConfig,
    pub from_uri: Option<String>,
    pub auto_auth: bool,
    pub credentials: Option<Credentials>,
}

Client-specific configuration

Extends DialogConfig with client-specific settings including default URI configuration, authentication settings, and client behavior options. Used by DialogClient to configure client-side SIP operations.

Examples

Basic Client Setup

use rvoip_dialog_core::api::ClientConfig;

let config = ClientConfig::new("127.0.0.1:0".parse().unwrap())
    .with_from_uri("sip:alice@example.com");

assert_eq!(config.from_uri.unwrap(), "sip:alice@example.com");
assert!(!config.auto_auth);  // Default disabled

Client with Authentication

use rvoip_dialog_core::api::ClientConfig;

let config = ClientConfig::new("192.168.1.100:5060".parse().unwrap())
    .with_from_uri("sip:user@domain.com")
    .with_auth("username", "password");

assert!(config.auto_auth);
assert!(config.credentials.is_some());
assert!(config.validate().is_ok());

Fields

dialog: DialogConfig

Base dialog configuration

from_uri: Option<String>

Default from URI for outgoing requests

The URI that will be used in the From header of outgoing requests when not explicitly specified. Should represent the client’s SIP identity (e.g., “sip:alice@example.com”).

auto_auth: bool

Enable automatic authentication

When true, the client automatically handles 401/407 authentication challenges using the configured credentials. When false, authentication challenges are forwarded to the application.

credentials: Option<Credentials>

Default credentials for authentication

Username and password used for automatic authentication when auto_auth is enabled. Should be set when enabling auto_auth.

Implementations

impl ClientConfig

pub fn new(local_address: SocketAddr) -> Self

Create a new client configuration with a local address

Creates a ClientConfig with the specified local address and sensible defaults for client operation.

Arguments

• local_address - Local address for the client to bind to

Returns

New ClientConfig with defaults

Examples

use rvoip_dialog_core::api::ClientConfig;

let config = ClientConfig::new("127.0.0.1:0".parse().unwrap());
assert_eq!(config.dialog.local_address.ip().to_string(), "127.0.0.1");
assert!(!config.auto_auth);  // Default disabled

pub fn with_from_uri(self, from_uri: impl Into<String>) -> Self

Set the default from URI

Configures the default From header URI for outgoing requests. This should represent the client’s SIP identity.

Arguments

• from_uri - SIP URI (e.g., “sip:alice@example.com”)

Returns

Self for method chaining

Examples

use rvoip_dialog_core::api::ClientConfig;

let config = ClientConfig::new("127.0.0.1:0".parse().unwrap())
    .with_from_uri("sip:test@localhost");

assert_eq!(config.from_uri.unwrap(), "sip:test@localhost");

pub fn with_auth( self, username: impl Into<String>, password: impl Into<String>, ) -> Self

Enable automatic authentication with credentials

Configures the client to automatically handle SIP authentication challenges using the provided username and password.

Arguments

• username - Authentication username
• password - Authentication password

Returns

Self for method chaining

Examples

use rvoip_dialog_core::api::ClientConfig;

let config = ClientConfig::new("127.0.0.1:0".parse().unwrap())
    .with_auth("user123", "secret456");

assert!(config.auto_auth);
assert!(config.credentials.is_some());
assert_eq!(config.credentials.unwrap().username, "user123");

pub fn validate(&self) -> Result<(), String>

Validate the client configuration

Validates both the client-specific settings and the underlying dialog configuration to ensure everything is properly configured.

Returns

Ok(()) if valid, Err(message) if invalid

Examples

use rvoip_dialog_core::api::ClientConfig;

let valid_config = ClientConfig::new("127.0.0.1:0".parse().unwrap())
    .with_from_uri("sip:test@example.com");
assert!(valid_config.validate().is_ok());

let mut invalid_config = ClientConfig::new("127.0.0.1:0".parse().unwrap())
    .with_auth("user", "pass");
// Note: with_auth() actually sets up credentials properly,
// so this example shows a working auth configuration
assert!(invalid_config.validate().is_ok());

Trait Implementations

impl Clone for ClientConfig

fn clone(&self) -> ClientConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ClientConfig

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

Formats the value using the given formatter.

impl Default for ClientConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ClientConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<ClientConfig> for DialogManagerConfig

fn from(client_config: ClientConfig) -> Self

Converts to this type from the input type.

impl Serialize for ClientConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.