Struct Builder 

pub struct Builder { /* private fields */ }

Builder for an ntex runtime system.

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 name of the System.

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

Enables or disables process signal handling.

By default, signal handling is disabled.

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

Enables panic handling.

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. By default, panic handling is disabled.

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

Sets the size of the stack (in bytes) for the new worker thread.

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

Sets the ping interval for spawned arbiters.

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.

pub fn testing(self) -> Self

Configures the system for testing.

This disables signal and panic handling.

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.

Panics

Panics if the runtime cannot be created.

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

Creates a system runner from an existing system configuration.

Panics

Panics if the runtime cannot be created.

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.