Struct ntex::server::ServerBuilder [−][src]
pub struct ServerBuilder { /* fields omitted */ }
Expand description
Server builder
Implementations
impl ServerBuilder
[src]
impl ServerBuilder
[src]pub fn new() -> ServerBuilderⓘNotable traits for ServerBuilder
impl Future for ServerBuilder type Output = ();
[src]
pub fn new() -> ServerBuilderⓘNotable traits for ServerBuilder
impl Future for ServerBuilder type Output = ();
[src]Create new Server builder instance
pub fn workers(self, num: usize) -> Self
[src]
pub fn workers(self, num: usize) -> Self
[src]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
[src]
pub fn backlog(self, num: i32) -> Self
[src]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
[src]
pub fn maxconn(self, num: usize) -> Self
[src]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
[src]
pub fn stop_runtime(self) -> Self
[src]Stop ntex runtime when server get dropped.
By default “stop runtime” is disabled.
pub fn disable_signals(self) -> Self
[src]
pub fn disable_signals(self) -> Self
[src]Disable signal handling.
By default signal handling is enabled.
pub fn shutdown_timeout(self, sec: u64) -> Self
[src]
pub fn shutdown_timeout(self, sec: u64) -> Self
[src]Timeout for graceful workers shutdown in seconds.
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 configure<F>(self, f: F) -> Result<ServerBuilder> where
F: Fn(&mut ServiceConfig) -> Result<()>,
[src]
pub fn configure<F>(self, f: F) -> Result<ServerBuilder> where
F: Fn(&mut ServiceConfig) -> Result<()>,
[src]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 bind<F, U, N: AsRef<str>>(
self,
name: N,
addr: U,
factory: F
) -> Result<Self> where
F: StreamServiceFactory<TcpStream>,
U: ToSocketAddrs,
[src]
pub fn bind<F, U, N: AsRef<str>>(
self,
name: N,
addr: U,
factory: F
) -> Result<Self> where
F: StreamServiceFactory<TcpStream>,
U: ToSocketAddrs,
[src]Add new service to the server.
pub fn bind_uds<F, U, N>(self, name: N, addr: U, factory: F) -> Result<Self> where
F: StreamServiceFactory<UnixStream>,
N: AsRef<str>,
U: AsRef<Path>,
[src]
pub fn bind_uds<F, U, N>(self, name: N, addr: U, factory: F) -> Result<Self> where
F: StreamServiceFactory<UnixStream>,
N: AsRef<str>,
U: AsRef<Path>,
[src]Add new unix domain service to the server.
pub fn listen_uds<F, N: AsRef<str>>(
self,
name: N,
lst: UnixListener,
factory: F
) -> Result<Self> where
F: StreamServiceFactory<UnixStream>,
[src]
pub fn listen_uds<F, N: AsRef<str>>(
self,
name: N,
lst: UnixListener,
factory: F
) -> Result<Self> where
F: StreamServiceFactory<UnixStream>,
[src]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>>(
self,
name: N,
lst: TcpListener,
factory: F
) -> Result<Self> where
F: StreamServiceFactory<TcpStream>,
[src]
pub fn listen<F, N: AsRef<str>>(
self,
name: N,
lst: TcpListener,
factory: F
) -> Result<Self> where
F: StreamServiceFactory<TcpStream>,
[src]Add new service to the server.
Trait Implementations
impl Default for ServerBuilder
[src]
impl Default for ServerBuilder
[src]impl Future for ServerBuilder
[src]
impl Future for ServerBuilder
[src]Auto Trait Implementations
impl !RefUnwindSafe for ServerBuilder
impl Send for ServerBuilder
impl !Sync for ServerBuilder
impl Unpin for ServerBuilder
impl !UnwindSafe for ServerBuilder
Blanket Implementations
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]pub fn borrow_mut(&mut self) -> &mut T
[src]
pub fn borrow_mut(&mut self) -> &mut T
[src]Mutably borrows from an owned value. Read more
impl<T> FutureExt for T where
T: Future + ?Sized,
impl<T> FutureExt for T where
T: Future + ?Sized,
fn map<U, F>(self, f: F) -> Map<Self, F> where
F: FnOnce(Self::Output) -> U,
fn map<U, F>(self, f: F) -> Map<Self, F> where
F: FnOnce(Self::Output) -> U,
Map this future’s output to a different type, returning a new future of the resulting type. Read more
fn map_into<U>(self) -> MapInto<Self, U> where
Self::Output: Into<U>,
fn map_into<U>(self) -> MapInto<Self, U> where
Self::Output: Into<U>,
Map this future’s output to a different type, returning a new future of the resulting type. Read more
fn then<Fut, F>(self, f: F) -> Then<Self, Fut, F> where
F: FnOnce(Self::Output) -> Fut,
Fut: Future,
fn then<Fut, F>(self, f: F) -> Then<Self, Fut, F> where
F: FnOnce(Self::Output) -> Fut,
Fut: Future,
Chain on a computation for when a future finished, passing the result of
the future to the provided closure f
. Read more
fn left_future<B>(self) -> Either<Self, B> where
B: Future<Output = Self::Output>,
fn left_future<B>(self) -> Either<Self, B> where
B: Future<Output = Self::Output>,
Wrap this future in an Either
future, making it the left-hand variant
of that Either
. Read more
fn right_future<A>(self) -> Either<A, Self> where
A: Future<Output = Self::Output>,
fn right_future<A>(self) -> Either<A, Self> where
A: Future<Output = Self::Output>,
Wrap this future in an Either
future, making it the right-hand variant
of that Either
. Read more
fn into_stream(self) -> IntoStream<Self>
fn into_stream(self) -> IntoStream<Self>
Convert this future into a single element stream. Read more
fn flatten(self) -> Flatten<Self> where
Self::Output: Future,
fn flatten(self) -> Flatten<Self> where
Self::Output: Future,
Flatten the execution of this future when the output of this future is itself another future. Read more
fn flatten_stream(self) -> FlattenStream<Self> where
Self::Output: Stream,
fn flatten_stream(self) -> FlattenStream<Self> where
Self::Output: Stream,
Flatten the execution of this future when the successful result of this future is a stream. Read more
fn fuse(self) -> Fuse<Self>
fn fuse(self) -> Fuse<Self>
Fuse a future such that poll
will never again be called once it has
completed. This method can be used to turn any Future
into a
FusedFuture
. Read more
fn inspect<F>(self, f: F) -> Inspect<Self, F> where
F: FnOnce(&Self::Output),
fn inspect<F>(self, f: F) -> Inspect<Self, F> where
F: FnOnce(&Self::Output),
Do something with the output of a future before passing it on. Read more
fn catch_unwind(self) -> CatchUnwind<Self> where
Self: UnwindSafe,
fn catch_unwind(self) -> CatchUnwind<Self> where
Self: UnwindSafe,
Catches unwinding panics while polling the future. Read more
fn shared(self) -> Shared<Self> where
Self::Output: Clone,
fn shared(self) -> Shared<Self> where
Self::Output: Clone,
Create a cloneable handle to this future where all handles will resolve to the same result. Read more
fn remote_handle(self) -> (Remote<Self>, RemoteHandle<Self::Output>)
fn remote_handle(self) -> (Remote<Self>, RemoteHandle<Self::Output>)
Turn this future into a future that yields ()
on completion and sends
its output to another future on a separate task. Read more
fn boxed<'a>(
self
) -> Pin<Box<dyn Future<Output = Self::Output> + 'a + Send, Global>> where
Self: Send + 'a,
fn boxed<'a>(
self
) -> Pin<Box<dyn Future<Output = Self::Output> + 'a + Send, Global>> where
Self: Send + 'a,
Wrap the future in a Box, pinning it. Read more
fn boxed_local<'a>(
self
) -> Pin<Box<dyn Future<Output = Self::Output> + 'a, Global>> where
Self: 'a,
fn boxed_local<'a>(
self
) -> Pin<Box<dyn Future<Output = Self::Output> + 'a, Global>> where
Self: 'a,
Wrap the future in a Box, pinning it. Read more
fn unit_error(self) -> UnitError<Self>
fn unit_error(self) -> UnitError<Self>
Turns a Future<Output = T>
into a
TryFuture<Ok = T, Error = ()
>. Read more
fn never_error(self) -> NeverError<Self>
fn never_error(self) -> NeverError<Self>
Turns a Future<Output = T>
into a
TryFuture<Ok = T, Error = Never
>. Read more
fn poll_unpin(&mut self, cx: &mut Context<'_>) -> Poll<Self::Output> where
Self: Unpin,
fn poll_unpin(&mut self, cx: &mut Context<'_>) -> Poll<Self::Output> where
Self: Unpin,
A convenience for calling Future::poll
on Unpin
future types.
fn now_or_never(self) -> Option<Self::Output>
fn now_or_never(self) -> Option<Self::Output>
Evaluates and consumes the future, returning the resulting output if
the future is ready after the first call to Future::poll
. Read more
impl<T> Instrument for T
[src]
impl<T> Instrument for T
[src]fn instrument(self, span: Span) -> Instrumented<Self>
[src]
fn instrument(self, span: Span) -> Instrumented<Self>
[src]Instruments this type with the provided Span
, returning an
Instrumented
wrapper. Read more
fn in_current_span(self) -> Instrumented<Self>
[src]
fn in_current_span(self) -> Instrumented<Self>
[src]impl<F> IntoFuture for F where
F: Future,
[src]
impl<F> IntoFuture for F where
F: Future,
[src]type Output = <F as Future>::Output
type Output = <F as Future>::Output
into_future
)The output that the future will produce on completion.
type Future = F
type Future = F
into_future
)Which kind of future are we turning this into?
pub fn into_future(self) -> <F as IntoFuture>::Future
[src]
pub fn into_future(self) -> <F as IntoFuture>::Future
[src]into_future
)Creates a future from a value.
impl<T> Same<T> for T
impl<T> Same<T> for T
type Output = T
type Output = T
Should always be Self