1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
use std::{fmt, io, marker::PhantomData, net, sync::Arc, sync::Mutex};
#[cfg(feature = "openssl")]
use tls_openssl::ssl::{AlpnError, SslAcceptor, SslAcceptorBuilder};
#[cfg(feature = "rustls")]
use tls_rustls::ServerConfig as RustlsServerConfig;
use crate::http::{HttpService, Request, Response, ResponseError, body::MessageBody};
use crate::server::{Server, ServerBuilder};
use crate::service::{IntoServiceFactory, ServiceFactory, cfg::SharedCfg};
use crate::time::Seconds;
struct Config {
host: Option<String>,
cfg: SharedCfg,
}
/// An HTTP Server.
///
/// Create new http server with application factory.
///
/// ```rust,no_run
/// use ntex::web::{self, App, HttpResponse, HttpServer};
///
/// #[ntex::main]
/// async fn main() -> std::io::Result<()> {
/// HttpServer::new(
/// async || App::new()
/// .service(web::resource("/").to(|| async { HttpResponse::Ok() })))
/// .bind("127.0.0.1:59090")?
/// .run()
/// .await
/// }
/// ```
#[derive(derive_more::Debug)]
#[debug("HttpServer")]
pub struct HttpServer<F, I, S, B>
where
F: AsyncFn() -> I + Send + Clone + 'static,
I: IntoServiceFactory<S, Request, SharedCfg>,
S: ServiceFactory<Request, SharedCfg>,
S::Error: ResponseError,
S::InitError: fmt::Debug,
S::Response: Into<Response<B>>,
B: MessageBody,
{
pub(super) factory: F,
config: Arc<Mutex<Config>>,
backlog: i32,
builder: ServerBuilder,
_t: PhantomData<(S, B)>,
}
impl<F, I, S, B> HttpServer<F, I, S, B>
where
F: AsyncFn() -> I + Send + Clone + 'static,
I: IntoServiceFactory<S, Request, SharedCfg>,
S: ServiceFactory<Request, SharedCfg> + 'static,
S::Error: ResponseError,
S::InitError: fmt::Debug,
S::Response: Into<Response<B>>,
B: MessageBody + 'static,
{
#[must_use]
/// Create new http server with application factory
pub fn new(factory: F) -> Self {
HttpServer {
factory,
config: Arc::new(Mutex::new(Config {
host: None,
cfg: SharedCfg::default(),
})),
backlog: 1024,
builder: ServerBuilder::default(),
_t: PhantomData,
}
}
#[must_use]
/// Set number of workers to start.
///
/// By default http server uses number of available logical cpu as threads
/// count.
pub fn workers(mut self, num: usize) -> Self {
self.builder = self.builder.workers(num);
self
}
#[must_use]
/// 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 backlog(mut self, backlog: i32) -> Self {
self.backlog = backlog;
self.builder = self.builder.backlog(backlog);
self
}
#[must_use]
/// 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.
pub fn maxconn(mut self, num: usize) -> Self {
self.builder = self.builder.maxconn(num);
self
}
#[must_use]
/// Sets the maximum per-worker concurrent connection establish process.
///
/// All listeners will stop accepting connections when this limit is reached. It
/// can be used to limit the global SSL CPU usage.
///
/// By default max connections is set to a 256.
pub fn maxconnrate(self, num: usize) -> Self {
ntex_tls::max_concurrent_ssl_accept(num);
self
}
#[must_use]
/// Set server host name.
///
/// Host name is used by application router as a hostname for url generation.
/// Check [`ConnectionInfo`](./dev/struct.ConnectionInfo.html#method.host)
/// documentation for more information.
///
/// By default host name is set to a "localhost" value.
pub fn server_hostname<T: AsRef<str>>(self, val: T) -> Self {
self.config.lock().unwrap().host = Some(val.as_ref().to_owned());
self
}
#[must_use]
/// Stop ntex runtime when server get dropped.
///
/// By default "stop runtime" is disabled.
pub fn stop_runtime(mut self) -> Self {
self.builder = self.builder.stop_runtime();
self
}
#[must_use]
/// Disable signal handling.
///
/// By default signal handling is enabled.
pub fn disable_signals(mut self) -> Self {
self.builder = self.builder.disable_signals();
self
}
#[must_use]
/// 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 shutdown_timeout(mut self, sec: Seconds) -> Self {
self.builder = self.builder.shutdown_timeout(sec);
self
}
#[must_use]
/// Enable cpu affinity.
///
/// By default affinity is disabled.
pub fn enable_affinity(mut self) -> Self {
self.builder = self.builder.enable_affinity();
self
}
#[must_use]
/// Set io config for named service.
pub fn config<T: Into<SharedCfg>>(self, cfg: T) -> Self {
self.config.lock().unwrap().cfg = cfg.into();
self
}
/// Use listener for accepting incoming connection requests
///
/// `HttpServer` does not change any configuration for `TcpListener`,
/// it needs to be configured before passing it to `listen()` method.
pub fn listen(mut self, lst: net::TcpListener) -> io::Result<Self> {
let cfg = self.config.clone();
let factory = self.factory.clone();
let addr = lst.local_addr().unwrap();
self.builder = self.builder.listen(
format!("ntex-web-service-{addr}"),
lst,
async move |r| {
r.config(cfg.lock().unwrap().cfg.clone());
HttpService::new(factory().await)
},
)?;
Ok(self)
}
#[cfg(feature = "openssl")]
/// Use listener for accepting incoming tls connection requests.
///
/// This method sets alpn protocols to "h2" and "http/1.1"
pub fn listen_openssl(
self,
lst: net::TcpListener,
builder: SslAcceptorBuilder,
) -> io::Result<Self> {
self.listen_ssl_inner(lst, openssl_acceptor(builder)?)
}
#[cfg(feature = "openssl")]
fn listen_ssl_inner(
mut self,
lst: net::TcpListener,
acceptor: SslAcceptor,
) -> io::Result<Self> {
let factory = self.factory.clone();
let cfg = self.config.clone();
let addr = lst.local_addr().unwrap();
self.builder = self.builder.listen(
format!("ntex-web-service-{addr}"),
lst,
async move |r| {
r.config(cfg.lock().unwrap().cfg.clone());
HttpService::new(factory().await).openssl(acceptor.clone())
},
)?;
Ok(self)
}
#[cfg(feature = "rustls")]
/// Use listener for accepting incoming tls connection requests.
///
/// This method sets alpn protocols to "h2" and "http/1.1"
pub fn listen_rustls(
self,
lst: net::TcpListener,
config: RustlsServerConfig,
) -> io::Result<Self> {
self.listen_rustls_inner(lst, config)
}
#[cfg(feature = "rustls")]
fn listen_rustls_inner(
mut self,
lst: net::TcpListener,
config: RustlsServerConfig,
) -> io::Result<Self> {
let factory = self.factory.clone();
let cfg = self.config.clone();
let addr = lst.local_addr().unwrap();
self.builder = self.builder.listen(
format!("ntex-web-rustls-service-{addr}"),
lst,
async move |r| {
r.config(cfg.lock().unwrap().cfg.clone());
HttpService::new(factory().await).rustls(config.clone())
},
)?;
Ok(self)
}
/// The socket address to bind.
///
/// To bind multiple addresses this method can be called multiple times.
pub fn bind<A: net::ToSocketAddrs>(mut self, addr: A) -> io::Result<Self> {
let sockets = self.bind2(addr)?;
for lst in sockets {
self = self.listen(lst)?;
}
Ok(self)
}
fn bind2<A: net::ToSocketAddrs>(&self, addr: A) -> io::Result<Vec<net::TcpListener>> {
let mut err = None;
let mut succ = false;
let mut sockets = Vec::new();
for addr in addr.to_socket_addrs()? {
match crate::server::create_tcp_listener(addr, self.backlog) {
Ok(lst) => {
succ = true;
sockets.push(lst);
}
Err(e) => err = Some(e),
}
}
if succ {
Ok(sockets)
} else if let Some(e) = err.take() {
Err(e)
} else {
Err(io::Error::new(
io::ErrorKind::InvalidInput,
"Cannot bind to address.",
))
}
}
#[cfg(feature = "openssl")]
/// Start listening for incoming tls connections.
///
/// This method sets alpn protocols to "h2" and "http/1.1"
pub fn bind_openssl<A>(
mut self,
addr: A,
builder: SslAcceptorBuilder,
) -> io::Result<Self>
where
A: net::ToSocketAddrs,
{
let sockets = self.bind2(addr)?;
let acceptor = openssl_acceptor(builder)?;
for lst in sockets {
self = self.listen_ssl_inner(lst, acceptor.clone())?;
}
Ok(self)
}
#[cfg(feature = "rustls")]
/// Start listening for incoming tls connections.
///
/// This method sets alpn protocols to "h2" and "http/1.1"
pub fn bind_rustls<A: net::ToSocketAddrs>(
mut self,
addr: A,
config: &RustlsServerConfig,
) -> io::Result<Self> {
let sockets = self.bind2(addr)?;
for lst in sockets {
self = self.listen_rustls_inner(lst, config.clone())?;
}
Ok(self)
}
#[cfg(unix)]
/// Start listening for unix domain connections on existing listener.
///
/// This method is available with `uds` feature.
pub fn listen_uds(mut self, lst: std::os::unix::net::UnixListener) -> io::Result<Self> {
let cfg = self.config.clone();
let factory = self.factory.clone();
let addr = format!("ntex-web-service-{:?}", lst.local_addr()?);
self.builder = self.builder.listen_uds(addr, lst, async move |r| {
r.config(cfg.lock().unwrap().cfg.clone());
HttpService::new(factory().await)
})?;
Ok(self)
}
#[cfg(unix)]
/// Start listening for incoming unix domain connections.
///
/// This method is available with `uds` feature.
pub fn bind_uds<A>(mut self, addr: A) -> io::Result<Self>
where
A: AsRef<std::path::Path>,
{
let cfg = self.config.clone();
let factory = self.factory.clone();
self.builder = self.builder.bind_uds(
format!("ntex-web-service-{:?}", addr.as_ref().display()),
addr,
async move |r| {
r.config(cfg.lock().unwrap().cfg.clone());
HttpService::new(factory().await)
},
)?;
Ok(self)
}
}
impl<F, I, S, B> HttpServer<F, I, S, B>
where
F: AsyncFn() -> I + Send + Clone + 'static,
I: IntoServiceFactory<S, Request, SharedCfg>,
S: ServiceFactory<Request, SharedCfg>,
S::Error: ResponseError,
S::InitError: fmt::Debug,
S::Response: Into<Response<B>>,
S::Service: 'static,
B: MessageBody,
{
/// Start listening for incoming connections.
///
/// This method starts number of http workers in separate threads.
/// For each address this method starts separate thread which does
/// `accept()` in a loop.
///
/// This methods panics if no socket address can be bound or an ntex system
/// is not yet configured.
///
/// ```rust,no_run
/// use ntex::web::{self, App, HttpResponse, HttpServer};
///
/// #[ntex::main]
/// async fn main() -> std::io::Result<()> {
/// HttpServer::new(
/// async || App::new().service(web::resource("/").to(|| async { HttpResponse::Ok() }))
/// )
/// .bind("127.0.0.1:0")?
/// .run()
/// .await
/// }
/// ```
pub fn run(self) -> Server {
self.builder.run()
}
}
#[cfg(feature = "openssl")]
/// Configure `SslAcceptorBuilder` with custom server flags.
fn openssl_acceptor(mut builder: SslAcceptorBuilder) -> io::Result<SslAcceptor> {
builder.set_alpn_select_callback(|_, protos| {
const H2: &[u8] = b"\x02h2";
const H11: &[u8] = b"\x08http/1.1";
if protos.windows(3).any(|window| window == H2) {
Ok(b"h2")
} else if protos.windows(9).any(|window| window == H11) {
Ok(b"http/1.1")
} else {
Err(AlpnError::NOACK)
}
});
builder.set_alpn_protos(b"\x08http/1.1\x02h2")?;
Ok(builder.build())
}