Struct PvaServerBuilder 

pub struct PvaServerBuilder { /* private fields */ }

Builder for PvaServer.

let server = PvaServer::builder()
    .ai("TEMP:READBACK", 22.5)
    .ao("TEMP:SETPOINT", 25.0)
    .bo("HEATER:ON", false)
    .port(5075)
    .build();

Implementations

impl PvaServerBuilder

pub fn ai(self, name: impl Into<String>, initial: f64) -> Self

Add an ai (analog input, read-only) record.

pub fn ao(self, name: impl Into<String>, initial: f64) -> Self

Add an ao (analog output, writable) record.

pub fn bi(self, name: impl Into<String>, initial: bool) -> Self

Add a bi (binary input, read-only) record.

pub fn bo(self, name: impl Into<String>, initial: bool) -> Self

Add a bo (binary output, writable) record.

pub fn string_in( self, name: impl Into<String>, initial: impl Into<String>, ) -> Self

Add a stringin (string input, read-only) record.

pub fn string_out( self, name: impl Into<String>, initial: impl Into<String>, ) -> Self

Add a stringout (string output, writable) record.

pub fn waveform(self, name: impl Into<String>, data: ScalarArrayValue) -> Self

Add a waveform record (array) with the given initial data.

pub fn aai(self, name: impl Into<String>, data: ScalarArrayValue) -> Self

Add an aai (analog array input, read-only) record.

pub fn aao(self, name: impl Into<String>, data: ScalarArrayValue) -> Self

Add an aao (analog array output, writable) record.

pub fn sub_array( self, name: impl Into<String>, data: ScalarArrayValue, indx: usize, nelm: usize, ) -> Self

Add a subarray record — a view into part of an array.

pub fn nt_table( self, name: impl Into<String>, columns: Vec<(String, ScalarArrayValue)>, ) -> Self

Add an NTTable record.

pub fn nt_ndarray( self, name: impl Into<String>, data: ScalarArrayValue, dims: Vec<(i32, i32)>, ) -> Self

Add an NTNDArray record.

pub fn mbbi( self, name: impl Into<String>, choices: Vec<String>, initial: i32, ) -> Self

Add an mbbi (multi-bit binary input, read-only) NTEnum record.

pub fn mbbo( self, name: impl Into<String>, choices: Vec<String>, initial: i32, ) -> Self

Add an mbbo (multi-bit binary output, writable) NTEnum record.

pub fn generic( self, name: impl Into<String>, struct_id: impl Into<String>, fields: Vec<(String, PvValue)>, ) -> Self

Add a generic structure record with a custom struct ID and fields.

pub fn db_file(self, path: impl AsRef<str>) -> Self

Load records from an EPICS .db file.

A malformed .db is a startup configuration error, not a runtime condition to log and shrug off: build() returns PvaServer, not a Result, so there is no channel to report the failure through other than refusing to start. Silently continuing with zero records from this file would leave the server up and answering PVA requests while serving none of the PVs its .db was supposed to define, which is worse than failing loudly at startup. load_db’s error already names the file and the line that failed to parse (see DbParseError’s Display), so that detail reaches the panic message unmodified.

pub fn db_string(self, content: &str) -> Self

Parse records from an EPICS .db string.

See Self::db_file’s doc comment for why a parse failure panics here rather than logging and continuing with zero records.

pub fn on_put<F>(self, name: impl Into<String>, callback: F) -> Self

where F: Fn(&str, &DecodedValue) + Send + Sync + 'static,

Register a callback invoked when a PUT is applied to the named PV.

pub fn scan<F>( self, name: impl Into<String>, period: Duration, callback: F, ) -> Self

where F: Fn(&str) -> ScalarValue + Send + Sync + 'static,

Register a periodic scan callback that produces a new value for a PV.

pub fn on_start<F>(self, hook: F) -> Self

where F: Fn(Arc<SimplePvStore>) -> Pin<Box<dyn Future<Output = ()> + Send>> + Send + Sync + 'static,

Register a hook to run once at startup, before the server serves.

Hooks run in registration order, each to completion, before scan tasks spawn and before the listener accepts. A hook that panics aborts startup.

.on_start(|store| Box::pin(async move {
    store.set_value("SETPOINT", ScalarValue::F64(22.5)).await;
}))

pub fn on_event<F>(self, event: impl Into<String>, handler: F) -> Self

where F: Fn(Arc<SimplePvStore>, String) -> Pin<Box<dyn Future<Output = ()> + Send>> + Send + Sync + 'static,

Register a handler for a named event.

Handlers are deferred: post_event queues them and returns. They run one at a time, in registration order, on the dispatcher.

.on_event("SHUTTER", |store, event| Box::pin(async move { /* ... */ }))

pub fn event_sink(self, sink: Arc<dyn EventSink>) -> Self

Register an EventSink — an inline consumer awaited by post_event before any handler is queued.

Sinks were previously reachable only through PvaServer::events on an already-built server, which leaves no seam for callers that only ever hold a builder (or a ServeBuilder/RunningServer). Registration order across builder-registered and post-build sinks is call order.

pub fn link<F>( self, output: impl Into<String>, inputs: &[&str], compute: F, ) -> Self

where F: Fn(&[ScalarValue]) -> ScalarValue + Send + Sync + 'static,

Link an output PV to one or more input PVs.

Whenever any input PV changes (via set_value, protocol PUT, or another link), the compute callback is invoked with the current values of all inputs (in order) and the result is written to the output PV.

.link("CALC:SUM", &["INPUT:A", "INPUT:B"], |values| {
    let a = values[0].as_f64().unwrap_or(0.0);
    let b = values[1].as_f64().unwrap_or(0.0);
    ScalarValue::F64(a + b)
})

pub fn source( self, label: impl Into<String>, order: i32, source: Arc<dyn Source>, ) -> Self

Register an additional Source at the given priority.

Lower order values are checked first during PV name resolution. The built-in SimplePvStore (records added via .ai(), .ao(), etc.) is always registered at order 0.

.source("hardware", -10, Arc::new(HardwareSource::new()))

pub fn ioc<S: StoreSource + 'static>(self, ioc: Arc<S>) -> Self

Register a processing engine as a second store.

Unlike PvaServerBuilder::source, this asserts the engine owns its record names outright: build panics if any of them collide with a record added to the builtin store (.ai(), .db_file() and friends), or if a .scan, .link or on_put handler names one of them. Those callbacks drive the builtin store’s direct-write semantics and would be silently inert against an engine record.

Generic rather than Arc<dyn StoreSource> so the names can be read before the value is erased to Arc<dyn Source>.

Panics

If called more than once.

pub fn port(self, port: u16) -> Self

Set the TCP port (default 5075).

pub fn udp_port(self, port: u16) -> Self

Set the UDP search port (default 5076).

pub fn listen_ip(self, ip: IpAddr) -> Self

Set the IP address to listen on.

pub fn advertise_ip(self, ip: IpAddr) -> Self

Set the IP address to advertise in search responses.

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

Enable alarm computation from limits.

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

Set the beacon broadcast period in seconds (default 15).

pub fn conn_timeout(self, timeout: Duration) -> Self

Set the idle connection timeout (default ~18 hours).

pub fn pvlist_mode(self, mode: PvListMode) -> Self

Set the PV list mode (default PvListMode::List).

pub fn pvlist_max(self, max: usize) -> Self

Set the maximum number of PV names in pvlist responses (default 1024).

pub fn pvlist_allow_pattern(self, pattern: Regex) -> Self

Set a regex filter for PV names exposed by pvlist.

pub fn build(self) -> PvaServer

Build the PvaServer.