Struct ServerConfig

Source
pub struct ServerConfig {
    pub dialog: DialogConfig,
    pub auto_options_response: bool,
    pub auto_register_response: bool,
    pub domain: Option<String>,
}
Expand description

Server-specific configuration

Extends DialogConfig with server-specific settings including automatic response handling, domain configuration, and server behavior options. Used by DialogServer to configure server-side SIP operations.

§Examples

§Basic Server Setup

use rvoip_dialog_core::api::ServerConfig;

let config = ServerConfig::new("0.0.0.0:5060".parse().unwrap())
    .with_domain("sip.example.com")
    .with_auto_options();

assert_eq!(config.domain.unwrap(), "sip.example.com");
assert!(config.auto_options_response);

§Production Server Configuration

use rvoip_dialog_core::api::ServerConfig;
use std::time::Duration;

let mut config = ServerConfig::new("0.0.0.0:5060".parse().unwrap())
    .with_domain("sip.production.com")
    .with_auto_options()
    .with_auto_register();

// Customize for production load
config.dialog = config.dialog
    .with_timeout(Duration::from_secs(300))
    .with_max_dialogs(100000)
    .with_user_agent("ProductionSIP/1.0");

assert!(config.validate().is_ok());

Fields§

§dialog: DialogConfig

Base dialog configuration

§auto_options_response: bool

Enable automatic response to OPTIONS requests

When true, the server automatically responds to OPTIONS requests with a 200 OK including supported methods. When false, OPTIONS requests are forwarded to the application for custom handling.

§auto_register_response: bool

Enable automatic response to REGISTER requests

When true, the server automatically handles REGISTER requests for basic registration functionality. When false, REGISTER requests are forwarded to the application.

§domain: Option<String>

Server domain name

The domain name this server represents. Used in Contact headers and for routing decisions. Should match your SIP domain.

Implementations§

Source§

impl ServerConfig

Source

pub fn new(local_address: SocketAddr) -> Self

Create a new server configuration with a local address

Creates a ServerConfig with the specified local address and sensible defaults for server operation.

§Arguments
  • local_address - Address to bind the server to
§Returns

New ServerConfig with defaults

§Examples
use rvoip_dialog_core::api::ServerConfig;

let config = ServerConfig::new("0.0.0.0:5060".parse().unwrap());
assert_eq!(config.dialog.local_address.port(), 5060);
assert!(config.auto_options_response);  // Default enabled
assert!(!config.auto_register_response); // Default disabled
Source

pub fn with_domain(self, domain: impl Into<String>) -> Self

Set the server domain

Configures the domain name that this server represents. Used for Contact header generation and routing decisions.

§Arguments
  • domain - Server domain name (e.g., “sip.example.com”)
§Returns

Self for method chaining

§Examples
use rvoip_dialog_core::api::ServerConfig;

let config = ServerConfig::new("0.0.0.0:5060".parse().unwrap())
    .with_domain("sip.mycompany.com");

assert_eq!(config.domain.unwrap(), "sip.mycompany.com");
Source

pub fn with_auto_options(self) -> Self

Enable automatic OPTIONS response

Configures the server to automatically respond to OPTIONS requests with a 200 OK including supported SIP methods. This is useful for capability discovery and keep-alive mechanisms.

§Returns

Self for method chaining

§Examples
use rvoip_dialog_core::api::ServerConfig;

let config = ServerConfig::new("0.0.0.0:5060".parse().unwrap())
    .with_auto_options();

assert!(config.auto_options_response);
Source

pub fn with_auto_register(self) -> Self

Enable automatic REGISTER response

Configures the server to automatically handle REGISTER requests for basic SIP registration functionality. Use this for simple registrar services or disable for custom registration handling.

§Returns

Self for method chaining

§Examples
use rvoip_dialog_core::api::ServerConfig;

let config = ServerConfig::new("0.0.0.0:5060".parse().unwrap())
    .with_auto_register();

assert!(config.auto_register_response);
Source

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

Validate the server configuration

Validates both the server-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::ServerConfig;

let config = ServerConfig::new("0.0.0.0:5060".parse().unwrap())
    .with_domain("test.com");

assert!(config.validate().is_ok());

Trait Implementations§

Source§

impl Clone for ServerConfig

Source§

fn clone(&self) -> ServerConfig

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ServerConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for ServerConfig

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for ServerConfig

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl From<ServerConfig> for DialogManagerConfig

Source§

fn from(server_config: ServerConfig) -> Self

Converts to this type from the input type.
Source§

impl Serialize for ServerConfig

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> SipJson for T

Source§

fn to_sip_value(&self) -> Result<SipValue, SipJsonError>

Convert this type to a SipValue. Read more
Source§

fn from_sip_value(value: &SipValue) -> Result<T, SipJsonError>

Create this type from a SipValue. Read more
Source§

impl<T> SipJsonExt for T

Source§

fn path(&self, path: impl AsRef<str>) -> Option<SipValue>

Simple path accessor that returns an Option directly

Source§

fn path_str(&self, path: impl AsRef<str>) -> Option<String>

Get a string value at the given path

Source§

fn path_str_or(&self, path: impl AsRef<str>, default: &str) -> String

Get a string value at the given path, or return the default value if not found

Source§

fn to_sip_value(&self) -> Result<SipValue, SipJsonError>

Convert to a SipValue. Read more
Source§

fn from_sip_value(value: &SipValue) -> Result<T, SipJsonError>

Convert from a SipValue. Read more
Source§

fn get_path(&self, path: impl AsRef<str>) -> SipValue

Access a value via path notation (e.g., “headers.from.tag”). Read more
Source§

fn path_accessor(&self) -> PathAccessor

Get a PathAccessor for chained access to fields. Read more
Source§

fn query(&self, query_str: impl AsRef<str>) -> Vec<SipValue>

Query for values using a JSONPath-like syntax. Read more
Source§

fn to_json_string(&self) -> Result<String, SipJsonError>

Convert to a JSON string. Read more
Source§

fn to_json_string_pretty(&self) -> Result<String, SipJsonError>

Convert to a pretty-printed JSON string. Read more
Source§

fn from_json_str(json_str: &str) -> Result<T, SipJsonError>

Create from a JSON string. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> SipMessageJson for T
where T: SipJsonExt,