1
0
Fork 0
mirror of https://github.com/actix/actix-web.git synced 2024-06-12 10:19:36 +00:00

update readme

This commit is contained in:
Nikolay Kim 2017-12-14 20:12:28 -08:00
parent c37565cc4a
commit a2dff8a0b9
5 changed files with 38 additions and 8 deletions

View file

@ -59,6 +59,37 @@ and tls connection. [rfc section 3.4](https://http2.github.io/http2-spec/#rfc.se
[tls example](https://github.com/actix/actix-web/tree/master/examples/tls)
## Benchmarks
This is totally unscientific and probably pretty useless. In real world business
logic would dominate on performance side. But in any case. i took several web frameworks
for rust and used theirs *hello world* example. All projects are compiled with
`--release` parameter. I didnt test single thread performance for iron and rocket.
As a testing tool i used `wrk` and following commands
`wrk -t20 -c100 -d10s http://127.0.0.1:8080/`
`wrk -t20 -c100 -d10s http://127.0.0.1:8080/ -s ./pipeline.lua --latency -- / 128`
I ran all tests on localhost on MacBook Pro late 2017. It has 4 cpu and 8 logical cpus.
Each result is best of five runs. All measurements are req/sec.
Name | 1 thread | 1 pipeline | 3 thread | 3 pipeline | 8 thread | 8 pipeline |
--- | --- | --- | --- | --- | --- |
Actix | 81400 | 710200 | 121000 | 1684000 | 106300 | 2206000 |
Gotham | 61000 | 178000 | | | | |
Iron | | | | | 94500 | 78000 |
Rocket | | | | | 95500 | failed |
Shio | 71800 | 317800 | | | | |
tokio-minihttp | 106900 | 1047000 | | | | |
Some notes on results. Iron and Rocket got tested with 8 threads,
which showed best results. Gothan and tokio-minihttp seem does not support
multithreading, or at least i couldn't figured out. I manually enabled pipelining
for *Shio* and Gotham*. While shio seems support multithreading, but it showed
absolutly same results for any how number of threads (maybe macos?)
Rocket completely failed in pipelined tests.
## Examples
* [Basic](https://github.com/actix/actix-web/tree/master/examples/basic.rs)

View file

@ -1,4 +1,4 @@
# Quickstart
# Quick start
Before you can start writing a actix web application, youll need a version of Rust installed.
We recommend you use rustup to install or configure such a version.

View file

@ -6,7 +6,7 @@ websocket protcol handling, multipart streams, etc.
All actix web server is built around `Application` instance.
It is used for registering routes for resources, middlewares.
Also it stores application specific state that is shared accross all handlers
Also it stores application specific state that is shared across all handlers
within same application.
Application acts as namespace for all routes, i.e all routes for specific application

View file

@ -5,7 +5,7 @@
Http server automatically starts number of http workers, by default
this number is equal to number of logical cpu in the system. This number
could be overriden with `HttpServer::threads()` method.
could be overridden with `HttpServer::threads()` method.
```rust
# extern crate actix_web;
@ -53,7 +53,7 @@ fn main() {
}
```
Note on *HTTP/2.0* protocol over tls without prior knowlage, it requires
Note on *HTTP/2.0* protocol over tls without prior knowledge, it requires
[tls alpn](https://tools.ietf.org/html/rfc7301). At the moment only
`openssl` has `alpn ` support.
@ -62,7 +62,7 @@ for concrete example.
## Keep-Alive
Actix can wait for requesta on a keep-alive connection. *Keep alive*
Actix can wait for requests on a keep-alive connection. *Keep alive*
connection behavior is defined by server settings.
* `Some(75)` - enable 75 sec *keep alive* timer according request and response settings.

View file

@ -41,9 +41,8 @@ fn index(req: HttpRequest) -> Box<Future<Item=HttpResponse, Error=Error>> {
## Response with custom type
To return custom type directly from handler function `FromResponse` trait should be
implemented for this type. Let's create response for custom type that
serializes to `application/json` response:
To return custom type directly from handler function type needs to implement `Responder` trait.
Let's create response for custom type that serializes to `application/json` response:
```rust
# extern crate actix;