1
0
mirror of https://github.com/actix/actix-website synced 2024-11-23 16:31:08 +01:00
actix-website/content/docs/server.md

131 lines
5.2 KiB
Markdown
Raw Normal View History

2018-05-22 23:15:08 +02:00
---
title: Server
menu: docs_basics
weight: 150
---
# The HTTP Server
The [**HttpServer**](https://docs.rs/actix-web/1.0.2/actix_web/struct.HttpServer.html) type is responsible for
2018-05-22 23:15:08 +02:00
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.
2018-05-24 05:56:58 +02:00
To bind to a specific socket address,
[`bind()`](../../actix-web/actix_web/server/struct.HttpServer.html#method.bind)
must be used, and it may be called multiple times. To bind ssl socket,
2018-05-24 05:56:58 +02:00
[`bind_ssl()`](../../actix-web/actix_web/server/struct.HttpServer.html#method.bind_ssl)
2019-06-13 23:10:51 +02:00
or [`bind_rustls()`](../../actix-web/1.0.0/actix_web/struct.HttpServer.html#method.bind_rustls)
2018-10-27 13:08:08 +02:00
should be used. To start the http server, use one of the start methods.
2018-05-22 23:15:08 +02:00
2018-05-24 06:04:32 +02:00
- use [`start()`](../../actix-web/actix_web/server/struct.HttpServer.html#method.start)
2018-05-24 05:56:58 +02:00
for a server
2018-05-22 23:15:08 +02:00
2018-05-24 05:39:15 +02:00
{{< include-example example="server" section="main" >}}
2018-05-22 23:15:08 +02:00
> 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
2018-05-24 05:39:15 +02:00
{{< include-example example="server" file="signals.rs" section="signals" >}}
2018-05-22 23:15:08 +02:00
## Multi-threading
2018-11-30 18:10:07 +01:00
`HttpServer` automatically starts a number of http workers, by default
2018-05-22 23:15:08 +02:00
this number is equal to number of logical CPUs in the system. This number
2018-05-24 05:56:58 +02:00
can be overridden with the
[`HttpServer::workers()`](../../actix-web/actix_web/server/struct.HttpServer.html#method.workers) method.
2018-05-22 23:15:08 +02:00
2018-05-24 05:39:15 +02:00
{{< include-example example="server" file="workers.rs" section="workers" >}}
2018-05-22 23:15:08 +02:00
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
2019-06-13 23:10:51 +02:00
There are two features for ssl server: `rust-tls` and `ssl`. The `tls` feature is
for `rust-tls` integration and `ssl` is for `openssl`.
2018-05-22 23:15:08 +02:00
```toml
[dependencies]
2019-06-13 23:10:51 +02:00
actix-web = { version = "{{< actix-version "actix-web" >}}", features = ["ssl"] }
2018-05-22 23:15:08 +02:00
```
2018-05-24 05:39:15 +02:00
{{< include-example example="server" file="ssl.rs" section="ssl" >}}
2018-05-22 23:15:08 +02:00
> **Note**: the *HTTP/2.0* protocol requires
> [tls alpn](https://tools.ietf.org/html/rfc7301).
> At the moment, only `openssl` has `alpn` support.
> For a full example, check out
> [examples/tls](https://github.com/actix/examples/tree/master/tls).
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"
```
2018-05-24 15:05:56 +02:00
To remove the password, then copy nopass.pem to key.pem
2018-05-22 23:15:08 +02:00
```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.
2019-06-13 23:10:51 +02:00
{{< include-example example="server" file="keep_alive.rs" section="keep-alive" >}}
2018-05-22 23:15:08 +02:00
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*.
2018-07-14 03:54:49 +02:00
*Connection type* can be changed with `HttpResponseBuilder::connection_type()` method.
2018-05-22 23:15:08 +02:00
2019-06-13 23:10:51 +02:00
{{< include-example example="server" file="keep_alive_tp.rs" section="example" >}}
2018-05-22 23:15:08 +02:00
## 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.
2018-05-24 06:04:32 +02:00
You can change this parameter with the
[`HttpServer::shutdown_timeout()`](../../actix-web/actix_web/server/struct.HttpServer.html#method.shutdown_timeout) method.
2018-05-22 23:15:08 +02:00
You can send a stop message to the server with the server address and specify if you want
2018-05-24 06:04:32 +02:00
graceful shutdown or not. The
[`start()`](../../actix-web/actix_web/server/struct.HttpServer.html#method.start)
2018-11-17 13:38:51 +01:00
method returns address of the server.
2018-05-22 23:15:08 +02:00
`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
2018-05-24 06:04:32 +02:00
> It is possible to disable signal handling with
> [`HttpServer::disable_signals()`](../../actix-web/actix_web/server/struct.HttpServer.html#method.disable_signals)
> method.