Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mafintosh/turbo-http
Blazing fast low level http server
https://github.com/mafintosh/turbo-http
Last synced: 23 days ago
JSON representation
Blazing fast low level http server
- Host: GitHub
- URL: https://github.com/mafintosh/turbo-http
- Owner: mafintosh
- License: mit
- Created: 2018-03-01T17:08:07.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2019-05-09T20:18:48.000Z (over 5 years ago)
- Last Synced: 2024-10-16T23:27:24.230Z (28 days ago)
- Language: JavaScript
- Size: 41 KB
- Stars: 1,001
- Watchers: 36
- Forks: 46
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-blazingly-fast - turbo-http - Blazing fast low level http server (JavaScript)
- awesome-list - turbo-http
README
# turbo-http
A low level http library for Node.js based on [turbo-net](https://github.com/mafintosh/turbo-net)
```
npm i turbo-http
```
[](https://travis-ci.org/mafintosh/turbo-http)
WIP, this module is already *really* fast but there are some HTTP features
missing and easy performance gains to be had. :D :D :D
On my laptop I can serve simple hello world payloads at around 100k requests/seconds compared to 10k requests/second using node core.
## Usage
``` js
const turbo = require('turbo-http')
const server = turbo.createServer(function (req, res) {
res.setHeader('Content-Length', '11')
res.write(Buffer.from('hello world'))
})
server.listen(8080)
```
## API
#### `server = turbo.createServer([onrequest])`
Create a new http server. Inherits from [the turbo-net tcp server](https://github.com/mafintosh/turbo-net#server--turbocreateserveroptions-onsocket)
#### `server.on('request', req, res)`
Emitted when a new http request is received.
#### `res.statusCode = code`
Set the http status
#### `res.setHeader(name, value)`
Set a http header
#### `res.write(buf, [length], [callback])`
Write a buffer. When the callback is called, the buffer
has been *completely* flushed to the underlying socket and is safe to
reuse for other purposes
#### `res.writev(buffers, [lengths], [callback])`
Write more that one buffer at once.
#### `res.end([buf], [length], [callback]`)
End the request. Only needed if you do not provide a `Content-Length`.
#### `req.url`
Request url
#### `req.method`
Request method
#### `req.socket`
Request [turbo-net](https://github.com/mafintosh/turbo-net) socket
#### `value = req.getHeader(name)`
Get a request header.
#### `headers = req.getAllHeaders()`
Get all request headers as a map.
#### `req.ondata(buffer, start, length)`
Called when there is data read. If you use the buffer outside of this function
you should copy it.
#### `req.onend()`
Called when the request is fully read.
## Benchmarks
Comparing `turbo-http` to other frameworks is like comparing oranges to apples.
`turbo-http` could be thought of as a replacement of Node's native [http](https://nodejs.org/api/http.html) module, while all available frameworks actually use it.
Benchmark it:
- `clone this repo`,
- `npm i`
- `npm run bench`
Benchmark averages are taken after one warm-up round.
| Requests/s | Latency | Throughput/Mb
------------- | ---------- | ------- | --------------
turbo-http.js | 32592 | 3.03 | 2.43
bare-node.js | 18396 | 5.32 | 1.98
rayo.js | 16249.6 | 6.03 | 1.77
polka.js | 15802.4 | 6.2 | 1.71
fastify.js | 15141.6 | 6.47 | 2.26
express.js | 13408.8 | 7.31 | 1.46
hapi.js | 9675.6 | 10.15 | 1.42
> **Note:** Nevermind these numbers, this benchmark was run on a slow computer and the above table is for illustrative purposes only.
Optionally, you may also define your test's parameters:
```
$> npm run bench -- -u http://localhost:5050 -c 100 -p 10 -d 5
```
* `-u` (_url_) -Defaults to `http://localhost:5050`
* `-c` (_connections_) -Defaults to `100`
* `-p` (_pipelines_) -Defaults to `10`
* `-d` (_duration_) -Defaults to `5` (seconds)
## Acknowledgements
This project was kindly sponsored by [nearForm](http://nearform.com).
## License
MIT