Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

docs: add notes about pipelining #408

Merged
merged 2 commits into from
Sep 6, 2020
Merged

docs: add notes about pipelining #408

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f294919
docs: add notes about pipelining
ronag Sep 6, 2020
3e8487c
Apply suggestions from code review
ronag Sep 6, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,8 @@ The benchmark is a simple `hello world` [example](benchmarks/index.js) without p
<a name='client'></a>
### `new undici.Client(url, opts)`

A basic HTTP/1.1 client, mapped on top a single TCP/TLS connection.
A basic HTTP/1.1 client, mapped on top a single TCP/TLS connection. Pipelining is disabled
by default.

`url` can be a string or a [`URL`](https://nodejs.org/api/url.html#url_class_url) object.
It should only include the protocol, hostname, and the port.
Expand Down Expand Up @@ -69,8 +70,10 @@ Options:
Default: `1e3` milliseconds (1s).

- `pipelining: Number`, the amount of concurrent requests to be sent over the
single TCP/TLS connection according to
[RFC7230](https://tools.ietf.org/html/rfc7230#section-6.3.2).
single TCP/TLS connection according to [RFC7230](https://tools.ietf.org/html/rfc7230#section-6.3.2).
Carefully consider your workload and environment before enabling concurrent requests
as pipelining may reduce performance if used incorrectly. Pipelining is sensitive
to network stack settings as well as head of line blocking caused by long running requests.
ronag marked this conversation as resolved.
Show resolved Hide resolved
Default: `1`.

- `tls: Object|Null`, an options object which in the case of `https` will be passed to
Expand Down