mirror of
https://github.com/actix/actix-website
synced 2024-11-30 19:14:36 +01:00
129 lines
5.4 KiB
Markdown
129 lines
5.4 KiB
Markdown
---
|
|
title: Server
|
|
menu: docs_basics
|
|
weight: 150
|
|
---
|
|
|
|
# The HTTP Server
|
|
|
|
The [**HttpServer**][httpserverstruct] type is responsible for serving http requests.
|
|
|
|
`HttpServer` accepts an application factory as a parameter, and the application factory
|
|
must have `Send` + `Sync` boundaries. More about that in the *multi-threading* section.
|
|
|
|
To bind to a specific socket address, [`bind()`][bindmethod] must be used, and it may be
|
|
called multiple times. To bind ssl socket, [`bind_ssl()`][bindsslmethod] or
|
|
[`bind_rustls()`][bindrusttls] should be used. To start the http server, use one of the
|
|
start methods.
|
|
|
|
- use [`start()`] for a server
|
|
|
|
{{< include-example example="server" section="main" >}}
|
|
|
|
> It is possible to start a server in a separate thread with the `run()` method. In that
|
|
> case the server spawns a new thread and creates a new actix system in it. To stop
|
|
> this server, send a `StopServer` message.
|
|
|
|
`HttpServer` is implemented as an actix actor. It is possible to communicate with the server
|
|
via a messaging system. Start method, e.g. `start()`, returns the address of the started
|
|
http server. It accepts several messages:
|
|
|
|
- `PauseServer` - Pause accepting incoming connections
|
|
- `ResumeServer` - Resume accepting incoming connections
|
|
- `StopServer` - Stop incoming connection processing, stop all workers and exit
|
|
|
|
{{< include-example example="server" file="signals.rs" section="signals" >}}
|
|
|
|
## Multi-threading
|
|
|
|
`HttpServer` automatically starts a number of http workers, by default this number is
|
|
equal to number of logical CPUs in the system. This number can be overridden with the
|
|
[`HttpServer::workers()`][workers] method.
|
|
|
|
{{< include-example example="server" file="workers.rs" section="workers" >}}
|
|
|
|
The server creates a separate application instance for each created worker. Application state
|
|
is not shared between threads. To share state, `Arc` could be used.
|
|
|
|
> Application state does not need to be `Send` and `Sync`, but factories must be `Send` + `Sync`.
|
|
|
|
## SSL
|
|
|
|
There are two features for ssl server: `rust-tls` and `ssl`. The `tls` feature is
|
|
for `rust-tls` integration and `ssl` is for `openssl`.
|
|
|
|
```toml
|
|
[dependencies]
|
|
actix-web = { version = "{{< actix-version "actix-web" >}}", features = ["ssl"] }
|
|
```
|
|
|
|
{{< include-example example="server" file="ssl.rs" section="ssl" >}}
|
|
|
|
> **Note**: the *HTTP/2.0* protocol requires [tls alpn][tlsalpn].
|
|
> At the moment, only `openssl` has `alpn` support.
|
|
> For a full example, check out [examples/tls][exampletls].
|
|
|
|
To create the key.pem and cert.pem use the command. **Fill in your own subject**
|
|
```bash
|
|
$ openssl req -x509 -newkey rsa:4096 -keyout key.pem -out cert.pem \
|
|
-days 365 -sha256 -subj "/C=CN/ST=Fujian/L=Xiamen/O=TVlinux/OU=Org/CN=muro.lxd"
|
|
```
|
|
To remove the password, then copy nopass.pem to key.pem
|
|
```bash
|
|
$ openssl rsa -in key.pem -out nopass.pem
|
|
```
|
|
|
|
## Keep-Alive
|
|
|
|
Actix can wait for requests on a keep-alive connection.
|
|
|
|
> *keep alive* connection behavior is defined by server settings.
|
|
|
|
- `75`, `Some(75)`, `KeepAlive::Timeout(75)` - enable 75 second *keep alive* timer.
|
|
- `None` or `KeepAlive::Disabled` - disable *keep alive*.
|
|
- `KeepAlive::Tcp(75)` - use `SO_KEEPALIVE` socket option.
|
|
|
|
{{< include-example example="server" file="keep_alive.rs" section="keep-alive" >}}
|
|
|
|
If the first option is selected, then *keep alive* state is calculated based on the
|
|
response's *connection-type*. By default `HttpResponse::connection_type` is not
|
|
defined. In that case *keep alive* is defined by the request's http version.
|
|
|
|
> *keep alive* is **off** for *HTTP/1.0* and is **on** for *HTTP/1.1* and *HTTP/2.0*.
|
|
|
|
*Connection type* can be changed with `HttpResponseBuilder::connection_type()` method.
|
|
|
|
{{< include-example example="server" file="keep_alive_tp.rs" section="example" >}}
|
|
|
|
## Graceful shutdown
|
|
|
|
`HttpServer` supports graceful shutdown. After receiving a stop signal, workers
|
|
have a specific amount of time to finish serving requests. Any workers still alive after the
|
|
timeout are force-dropped. By default the shutdown timeout is set to 30 seconds. You
|
|
can change this parameter with the [`HttpServer::shutdown_timeout()`][shutdowntimeout]
|
|
method.
|
|
|
|
You can send a stop message to the server with the server address and specify if you want
|
|
graceful shutdown or not. The [`start()`][startmethod] method returns address of the server.
|
|
|
|
`HttpServer` handles several OS signals. *CTRL-C* is available on all OSs, other signals
|
|
are available on unix systems.
|
|
|
|
- *SIGINT* - Force shutdown workers
|
|
- *SIGTERM* - Graceful shutdown workers
|
|
- *SIGQUIT* - Force shutdown workers
|
|
|
|
> It is possible to disable signal handling with
|
|
[`HttpServer::disable_signals()`][disablesignals] method.
|
|
|
|
[httpserverstruct]: https://docs.rs/actix-web/1.0.2/actix_web/struct.HttpServer.html
|
|
[bindmethod]: https://docs.rs/actix-web/1.0.2/actix_web/struct.HttpServer.html#method.bind
|
|
[bindsslmethod]: https://docs.rs/actix-web/1.0.2/actix_web/struct.HttpServer.html#method.bind_ssl
|
|
[bindrusttls]: https://docs.rs/actix-web/1.0.2/actix_web/struct.HttpServer.html#method.bind_rustls
|
|
[startmethod]: https://docs.rs/actix-web/1.0.2/actix_web/struct.HttpServer.html#method.start
|
|
[workers]: https://docs.rs/actix-web/1.0.2/actix_web/struct.HttpServer.html#method.workers
|
|
[tlsalpn]: https://tools.ietf.org/html/rfc7301
|
|
[exampletls]: https://github.com/actix/examples/tree/master/tls
|
|
[shutdowntimeout]: https://docs.rs/actix-web/1.0.2/actix_web/struct.HttpServer.html#method.shutdown_timeout
|
|
[disablesignals]: https://docs.rs/actix-web/1.0.2/actix_web/struct.HttpServer.html#method.disable_signals
|