Struct RegistrationConfig

pub struct RegistrationConfig {
    pub server_uri: String,
    pub from_uri: String,
    pub contact_uri: String,
    pub expires: u32,
    pub username: Option<String>,
    pub password: Option<String>,
    pub realm: Option<String>,
}

Registration configuration for SIP server registration

Contains all necessary parameters to register with a SIP registrar server, including server details, user identity, authentication credentials, and registration timing parameters.

Examples

use rvoip_client_core::registration::RegistrationConfig;
 
let config = RegistrationConfig::new(
    "sip:registrar.example.com".to_string(),
    "sip:alice@example.com".to_string(), 
    "sip:alice@192.168.1.100:5060".to_string(),
)
.with_credentials("alice".to_string(), "password123".to_string())
.with_expires(1800);
 
assert_eq!(config.server_uri, "sip:registrar.example.com");
assert_eq!(config.username, Some("alice".to_string()));
assert_eq!(config.expires, 1800);

Fields

server_uri: String

SIP registrar server URI (e.g., “sip:registrar.example.com”)

The URI of the SIP registrar server where this client will register. This should include the scheme (sip: or sips:) and may include port.

from_uri: String

From URI representing the user identity (e.g., “sip:alice@example.com”)

The SIP address that identifies this user. This appears in the From header of REGISTER requests and represents the user’s public identity.

contact_uri: String

Contact URI for this client (e.g., “sip:alice@192.168.1.100:5060”)

The SIP URI where this client can be reached for incoming calls. Typically includes the client’s current IP address and port.

expires: u32

Registration expiration time in seconds

How long the registration should remain valid. The client will automatically refresh the registration before this time expires. Common values: 3600 (1 hour), 1800 (30 minutes), 300 (5 minutes).

username: Option<String>

Authentication username (optional)

Username for SIP digest authentication. Required if the registrar server requires authentication (most production servers do).

password: Option<String>

Authentication password (optional)

Password for SIP digest authentication. Should be kept secure and not logged or displayed in plain text.

realm: Option<String>

Authentication realm (optional)

Authentication realm provided by the server. Often the same as the domain portion of the server URI. Usually provided by the server in authentication challenges.

Implementations

impl RegistrationConfig

pub fn new(server_uri: String, from_uri: String, contact_uri: String) -> Self

Create a new registration configuration with default settings

Creates a basic registration configuration with a default expiration of 3600 seconds (1 hour) and no authentication credentials.

Arguments

• server_uri - URI of the SIP registrar server
• from_uri - SIP URI representing the user identity
• contact_uri - SIP URI where this client can be reached

Examples

use rvoip_client_core::registration::RegistrationConfig;
 
let config = RegistrationConfig::new(
    "sip:registrar.example.com".to_string(),
    "sip:alice@example.com".to_string(),
    "sip:alice@192.168.1.100:5060".to_string(),
);
 
assert_eq!(config.expires, 3600); // Default 1 hour
assert_eq!(config.username, None); // No auth by default

pub fn with_credentials(self, username: String, password: String) -> Self

Set authentication credentials for the registration

Configures username and password for SIP digest authentication. Most production SIP servers require authentication.

Arguments

• username - Authentication username
• password - Authentication password

Examples

use rvoip_client_core::registration::RegistrationConfig;
 
let config = RegistrationConfig::new(
    "sip:registrar.example.com".to_string(),
    "sip:alice@example.com".to_string(),
    "sip:alice@192.168.1.100:5060".to_string(),
)
.with_credentials("alice".to_string(), "secret123".to_string());
 
assert_eq!(config.username, Some("alice".to_string()));
assert_eq!(config.password, Some("secret123".to_string()));

pub fn with_realm(self, realm: String) -> Self

Set the authentication realm for the registration

The realm is usually provided by the server during authentication challenges, but can be set in advance if known.

Arguments

• realm - Authentication realm (often the server domain)

Examples

use rvoip_client_core::registration::RegistrationConfig;
 
let config = RegistrationConfig::new(
    "sip:registrar.example.com".to_string(),
    "sip:alice@example.com".to_string(),
    "sip:alice@192.168.1.100:5060".to_string(),
)
.with_realm("example.com".to_string());
 
assert_eq!(config.realm, Some("example.com".to_string()));

pub fn with_expires(self, expires: u32) -> Self

Set the registration expiration time

Controls how long the registration remains valid before requiring a refresh. Shorter times provide faster failover detection but increase network traffic.

Arguments

• expires - Expiration time in seconds

Examples

use rvoip_client_core::registration::RegistrationConfig;
 
let config = RegistrationConfig::new(
    "sip:registrar.example.com".to_string(),
    "sip:alice@example.com".to_string(),
    "sip:alice@192.168.1.100:5060".to_string(),
)
.with_expires(1800); // 30 minutes
 
assert_eq!(config.expires, 1800);

Trait Implementations

impl Clone for RegistrationConfig

fn clone(&self) -> RegistrationConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RegistrationConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RegistrationConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for RegistrationConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.