Struct ScServerBuilder

Source

pub struct ScServerBuilder { /* private fields */ }

Available on crate feature sc-tls only.

Expand description

SC-specific server builder.

Created by BACnetServer::sc_builder(). Requires the sc-tls feature. A caller-provisioned, nonzero device_uuid and validated tls_config are required before build can connect.

Implementations§

Source §

impl ScServerBuilder

Source

pub fn mutation_policy(self, policy: MutationPolicy) -> Self

Select local mutation authorization (default: MutationPolicy::Permissive). SC mTLS channel/peer authentication is not service authorization.

Source

pub fn policy(self, policy: impl ServerPolicy) -> Self

Install the server’s authorization policy; see ServerPolicy, or FnPolicy to build one from closures. It replaces any policy set before; put every decision in one policy (one FnPolicy chain) rather than calling this twice.

Source §

impl ScServerBuilder

Source

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

Set the password required for ReinitializeDevice requests.

Source

pub fn on_reinitialize<F>(self, handler: F) -> Self
where F: Fn(&ReinitializeContext, &mut ObjectDatabase) -> Result<(), Error> + Send + Sync + 'static,

Set the ReinitializeDevice handler. It must reply before restarting and stay quick; see ReinitializeHandler.

Source §

impl ScServerBuilder

Source

pub fn time_sync_policy(self, policy: TimeSyncPolicy) -> Self

Configure inbound clock restrictions on claimed SC VMAC / routed sources. Dispatch does not expose certificate principals; see TimeSyncSource.

Source §

impl ScServerBuilder

Source

pub fn hub_url(self, url: &str) -> Self

Set the hub WebSocket URL (e.g. wss://hub.example.com/bacnet).

Source

pub fn tls_config(self, config: ScNodeTlsConfig) -> Self

Set the validated local node TLS policy, shared across initial and reconnect attempts (including normal TLS resumption).

use bacnet_server::server::{BACnetServer, ScServerBuilder};
use bacnet_transport::sc_tls::ScNodeTlsConfig;
fn configured(tls: ScNodeTlsConfig) -> ScServerBuilder {
    BACnetServer::sc_builder().tls_config(tls)
}

use bacnet_server::server::BACnetServer;
fn raw(config: std::sync::Arc<tokio_rustls::rustls::ClientConfig>) {
    let _ = BACnetServer::sc_builder().tls_config(config);
}

Source

pub fn vmac(self, vmac: [u8; 6]) -> Self

Set the local VMAC address.

Source

pub fn device_uuid(self, uuid: [u8; 16]) -> Self

Set the caller-provisioned, persistent BACnet/SC device UUID.

The caller must generate it before deployment, store it durably, and reuse the same bytes for the device’s lifetime, including restarts. Distinct devices must not share a UUID. This builder neither generates nor stores identities across lifecycles and cannot detect a changed provisioned UUID. build rejects missing/all-zero UUIDs before dialing; it does not enforce UUID version or variant bits.

Source

pub fn device(self, identity: DeviceIdentity) -> Self

Set the one Device identity. With no supplied database, startup creates a stock Device after resolving the owned transport’s receive capacity.

Source

pub fn database(self, db: ObjectDatabase) -> Self

Set the object database (transfers ownership).

Source

pub fn device_binding(self, binding: DeviceBinding) -> Result<Self, Error>

Register one explicit unicast route for a Device recipient.

Source

pub fn heartbeat_interval_ms(self, ms: u64) -> Self

Set the heartbeat interval in milliseconds (default 30 000).

Source

pub fn heartbeat_timeout_ms(self, ms: u64) -> Self

Set the heartbeat timeout in milliseconds (default 60 000).

Source

pub fn reconnect(self, config: ScReconnectConfig) -> Self

Enable automatic reconnection with the given configuration.

Source

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

Set the password required for DeviceCommunicationControl requests.

Source

pub fn dcc_policy(self, policy: DccPolicy) -> Self

Select explicit local DCC authorization (default: deny all).

Source

pub fn dcc_source_restriction( self, restriction: Option<DccSourceRestriction>, ) -> Self

Restrict claimed DCC sources; requires explicit RequirePassword policy.

Source

pub fn dcc_disable_rate_limit(self, limit: Option<DccDisableRateLimit>) -> Self

Limit authorized DISABLE_INITIATION globally; None (default) disables it.

Source

pub fn audit_notification_sink(self, sink: ObjectIdentifier) -> Self

Select the only local Audit Log that receives authorized notifications.

Source

pub fn enable_fault_detection(self, enabled: bool) -> Self

Enable periodic fault detection / reliability evaluation.

When enabled, every object’s opt-in reliability hook runs every 10 seconds; the default hook is a no-op.

Source

pub fn enable_event_enrollment(self, enabled: bool) -> Self

Enable periodic Event Enrollment evaluation (default true).

Source

pub fn event_enrollment_interval_secs(self, secs: u64) -> Self

Set the interval in seconds between Event Enrollment evaluation passes.

Source

pub fn cov_policy(self, policy: CovPolicy) -> Self

Set the COV quota and notification work budget policy, checked by CovPolicy::validate before SC dialing.

Source

pub async fn build( self, ) -> Result<BACnetServer<ScTransport<TlsWebSocket>>, Error>

Connect to the hub and start the server.

Reconnect configuration is validated before UUID validation, binding-table construction, TLS lookup, or dialing, and again when the transport starts. An error still consumes this builder and drops its inputs; this does not promise generic endpoint rollback.

Source §