Struct Builder 

pub struct Builder { /* private fields */ }

Builder for an ntex runtime system.

Obtain a builder from System::build. Use build to create a SystemRunner, then run the event loop or block on a future.

Implementations

impl Builder

pub fn name<N: AsRef<str>>(self, name: N) -> Self

Sets the system name, used when naming its threads.

The default is "ntex".

pub fn signals(self, eanbled: bool) -> Self

Enables or disables process signal handling.

By default, signal handling is disabled. At startup the system attempts to acquire process-wide ownership; another system’s existing registration is not replaced. See System::enable_signals.

pub fn panic_handling(self, eanbled: bool) -> Self

Enables or disables installation of the process-wide panic hook at startup.

When panic handling is enabled, the application can receive Signal::Panic(PanicSource::App(..)) signals while signal handling is enabled. The previously installed panic hook is still called. The hook is installed once and remains installed for the process lifetime; false does not remove a hook installed earlier. By default, installation is disabled.

pub fn stack_size(self, size: usize) -> Self

Sets the stack size, in bytes, for newly spawned arbiter threads.

The default is zero, which uses the standard library’s thread stack size. This does not change the primary arbiter’s or blocking pool workers’ stacks.

pub fn ping_interval(self, interval: usize) -> Self

Sets the ping interval for all registered arbiters, including the primary.

The interval is specified in milliseconds and defaults to 2,000. Set it to zero to disable pings.

pub fn ping_threshold(self, interval: usize) -> Self

Sets the arbiter stall threshold.

A watchdog thread marks an arbiter as stalled when it records no latency sample for longer than the latency_interval plus this threshold, see LatencyMetrics::stalls. On Linux and Windows an attempt is made to create a backtrace for the stalled arbiter.

The threshold is specified in milliseconds and defaults to 1,000.

pub fn latency_interval(self, interval: usize) -> Self

Sets the scheduling latency sampling interval for arbiters.

Each arbiter runs a task that sleeps for the interval and records how late it wakes up, see Arbiter::latency.

The interval is specified in milliseconds and defaults to 100. Set it to zero to disable sampling and stall detection.

pub fn thread_pool_limit(self, value: usize) -> Self

Sets the maximum number of blocking thread-pool workers.

The default is 256. Zero is treated as one; excess work is queued.

pub fn testing(self) -> Self

Configures the system for testing.

Sets the testing flag and disables signal and panic handling on this builder. Subsequent calls can enable either again.

pub fn thread_pool_recv_timeout<T>(self, timeout: T) -> Self

where Duration: From<T>,

Sets how long an idle blocking worker waits before exiting.

The default is 60 seconds.

pub fn build<R: Runner>(self, runner: R) -> SystemRunner

Creates a system runner using the specified runtime runner.

This stores configuration only; the system starts when the returned SystemRunner is driven.

pub fn build_with(self, config: SystemConfig) -> SystemRunner

Creates a system runner from an existing system configuration.

The supplied configuration determines the name, runtime runner, and all other system settings. Only this builder’s signal and panic-handling settings are used. No event loop is started by this method.

Trait Implementations

impl Clone for Builder

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Builder

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

Formats the value using the given formatter.