Skip to content

Commit

Permalink
Add --thread-limit README description.
Browse files Browse the repository at this point in the history
  • Loading branch information
bneradt authored and bneradt committed Feb 4, 2021
1 parent 7bb8995 commit 087df16
Showing 1 changed file with 19 additions and 5 deletions.
24 changes: 19 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ Table of Contents
* [--strict](#--strict)
* [--rate <requests/second>](#--rate-requestssecond)
* [--repeat <number>](#--repeat-number)
* [--thread-limit <number>](#--thread-limit-number)
* [Contribute](#contribute)
* [License](#license)

Expand Down Expand Up @@ -115,10 +116,12 @@ which is a sequence where each item in the sequence describes the
characteristics of each connection. For each session the protocol stack can be
specified via the `protocol` node. This node describes the protocol
characteristics of the connection such as what version of HTTP to use, whether
to use TLS and what the characteristics of the TLS handshake should be. In
the absence of a `protocol` node the default protocol is HTTP/1 over TCP.
See [Protocol Specification](#protocol-specification) below for details about the
`protocol` node. Each session is run in parallel by the verifier-client.
to use TLS and what the characteristics of the TLS handshake should be. In the
absence of a `protocol` node the default protocol is HTTP/1 over TCP. See
[Protocol Specification](#protocol-specification) below for details about the
`protocol` node. Each session is run in parallel by the verifier-client
(although see [--thread-limit <number>](#--thread-limit-number) below for
a way to serialize them).

In addition to protocol specification, each session in the `sessions`
sequence contains a `transactions` node. This itself is a sequence of
Expand Down Expand Up @@ -1257,11 +1260,22 @@ This is a client-side only option.
By default, the client will replay all the transactions once in the set of
input replay files. If the user would like the client to automatically repeat
this set a number of times, they can provide the `--repeat` argument. The
this set a number of times, they can provide the `--repeat` option. The
argument takes the number of times the client should replay the entire dataset.
This is a client-side only option.
#### --thread-limit \<number\>
Each connection, corresponding to a `session` in a replay file, is dispatched
on the client in parallel. Likewise, each accepted connection on the server is
handled in parallel. Each of these sessions is handled via a single thread of
execution. By default, Proxy Verifier limits the number of threads for handling
these connections to 2,000. This limit can be changed via the `--thread-limit`
option. Setting a value of `1` on the client will effectively cause sessions
to be replayed in serial.
## Contribute
Please refer to [CONTRIBUTING](CONTRIBUTING.md) for information about how to get involved. We welcome issues, questions, and pull requests.
Expand Down

0 comments on commit 087df16

Please sign in to comment.