Struct ntex::server::ServerBuilder

pub struct ServerBuilder { /* fields omitted */ }

Server builder

Implementations

impl ServerBuilder

pub fn new() -> ServerBuilder

Create new Server builder instance

pub fn workers(self, num: usize) -> Self

Set number of workers to start.

By default server uses number of available logical cpu as workers count.

pub fn backlog(self, num: i32) -> Self

Set the maximum number of pending connections.

This refers to the number of clients that can be waiting to be served. Exceeding this number results in the client getting an error when attempting to connect. It should only affect servers under significant load.

Generally set in the 64-2048 range. Default value is 2048.

This method should be called before bind() method call.

pub fn maxconn(self, num: usize) -> Self

Sets the maximum per-worker number of concurrent connections.

All socket listeners will stop accepting connections when this limit is reached for each worker.

By default max connections is set to a 25k per worker.

pub fn stop_runtime(self) -> Self

Stop ntex runtime when server get dropped.

By default “stop runtime” is disabled.

pub fn disable_signals(self) -> Self

Disable signal handling.

By default signal handling is enabled.

pub fn shutdown_timeout<T: Into<Millis>>(self, timeout: T) -> Self

Timeout for graceful workers shutdown.

After receiving a stop signal, workers have this much time to finish serving requests. Workers still alive after the timeout are force dropped.

By default shutdown timeout sets to 30 seconds.

pub fn status_handler<F>(self, handler: F) -> Self where
    F: FnMut(ServerStatus) + Send + 'static, 

Set server status handler.

Server calls this handler on every inner status update.

pub fn configure<F>(self, f: F) -> Result<ServerBuilder> where
    F: Fn(&mut ServiceConfig) -> Result<()>, 

Execute external configuration as part of the server building process.

This function is useful for moving parts of configuration to a different module or even library.

pub fn on_worker_start<F, R, E>(self, f: F) -> Self where
    F: Fn(ServiceRuntime) -> R + Send + Clone + 'static,
    R: Future<Output = Result<(), E>> + 'static,
    E: Display + 'static, 

Register async service configuration function.

This function get called during worker runtime configuration stage. It get executed in the worker thread.

pub fn bind<F, U, N: AsRef<str>, R>(
    self,
    name: N,
    addr: U,
    factory: F
) -> Result<Self> where
    U: ToSocketAddrs,
    F: Fn(Config) -> R + Send + Clone + 'static,
    R: ServiceFactory<Io>, 

Add new service to the server.

pub fn bind_uds<F, U, N, R>(self, name: N, addr: U, factory: F) -> Result<Self> where
    N: AsRef<str>,
    U: AsRef<Path>,
    F: Fn(Config) -> R + Send + Clone + 'static,
    R: ServiceFactory<Io>, 

Add new unix domain service to the server.

pub fn listen_uds<F, N: AsRef<str>, R>(
    self,
    name: N,
    lst: UnixListener,
    factory: F
) -> Result<Self> where
    F: Fn(Config) -> R + Send + Clone + 'static,
    R: ServiceFactory<Io>, 

Add new unix domain service to the server. Useful when running as a systemd service and a socket FD can be acquired using the systemd crate.

pub fn listen<F, N: AsRef<str>, R>(
    self,
    name: N,
    lst: TcpListener,
    factory: F
) -> Result<Self> where
    F: Fn(Config) -> R + Send + Clone + 'static,
    R: ServiceFactory<Io>, 

Add new service to the server.

pub fn run(self) -> Server

Starts processing incoming connections and return server controller.

Trait Implementations

impl Default for ServerBuilder

fn default() -> Self

Returns the “default value” for a type.

impl Future for ServerBuilder

type Output = ()

The type of value produced on completion.

fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output>

Attempt to resolve the future to a final value, registering the current task for wakeup if the value is not yet available.