Struct actix_server::ServerBuilder [−][src]
Server builder
Implementations
impl ServerBuilder
[src]
pub fn new() -> ServerBuilderⓘNotable traits for ServerBuilder
impl Future for ServerBuilder type Output = ();
[src]
Notable traits for ServerBuilder
impl Future for ServerBuilder type Output = ();
Create new Server builder instance
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. Workers must be greater than 0.
pub fn worker_max_blocking_threads(self, num: usize) -> Self
[src]
Set max number of threads for each worker’s blocking task thread pool.
One thread pool is set up per worker; not shared across workers.
Examples:
let builder = ServerBuilder::new() .workers(4) // server has 4 worker thread. .worker_max_blocking_threads(4); // every worker has 4 max blocking threads.
See tokio::runtime::Builder::max_blocking_threads for behavior reference.
pub fn backlog(self, num: u32) -> 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]
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 system_exit(self) -> Self
[src]
Stop Actix system.
pub fn disable_signals(self) -> Self
[src]
Disable signal handling.
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]
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 bind<F, U, N: AsRef<str>>(
self,
name: N,
addr: U,
factory: F
) -> Result<Self> where
F: ServiceFactory<TcpStream>,
U: ToSocketAddrs,
[src]
self,
name: N,
addr: U,
factory: F
) -> Result<Self> where
F: ServiceFactory<TcpStream>,
U: ToSocketAddrs,
Add new service to the server.
pub fn listen<F, N: AsRef<str>>(
self,
name: N,
lst: StdTcpListener,
factory: F
) -> Result<Self> where
F: ServiceFactory<TcpStream>,
[src]
self,
name: N,
lst: StdTcpListener,
factory: F
) -> Result<Self> where
F: ServiceFactory<TcpStream>,
Add new service to the server.
pub fn run(self) -> Serverⓘ
[src]
Starts processing incoming connections and return server controller.
Trait Implementations
impl Default 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> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<F> IntoFuture for F where
F: Future,
[src]
F: Future,
type Output = <F as Future>::Output
into_future
)The output that the future will produce on completion.
type Future = F
into_future
)Which kind of future are we turning this into?
pub fn into_future(self) -> <F as IntoFuture>::Future
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,