Skip to content

Commit

Permalink
[=] Added parameter descriptions (#291)
Browse files Browse the repository at this point in the history
* [~] Added parameter descriptions

* Update tests/test_client.c

Co-authored-by: Zhou <[email protected]>

* Update docs/docs-zh/Testing-zh.md

Co-authored-by: Zhou <[email protected]>

---------

Co-authored-by: Zhou <[email protected]>
  • Loading branch information
derekwin and ruiqizhou authored Mar 15, 2023
1 parent 4ff9ee6 commit 9f17e54
Show file tree
Hide file tree
Showing 3 changed files with 36 additions and 0 deletions.
18 changes: 18 additions & 0 deletions docs/docs-zh/Testing-zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ openssl req -newkey rsa:2048 -x509 -nodes -keyout "$keyfile" -new -out "$certfil
| -T | Transport layer. No HTTP3. |
| -1 | Force 1RTT. |
| -s | Body size to send. |
| -F | Abs_timeout to close conn. >=0. |
| -w | Write received body to file. |
| -r | Read sending body from file. priority s > r |
| -l | Log level. e:error d:debug. |
Expand All @@ -53,18 +54,31 @@ openssl req -newkey rsa:2048 -x509 -nodes -keyout "$keyfile" -new -out "$certfil
| -x | Test case ID |
| -N | No encryption |
| -6 | IPv6 |
| -M | Enable multi-path on. |
| -i | Multi-path interface. e.g. -i interface1 -i interface2. |
| -R | Enable reinjection. Default is 0, no reinjection |
| -V | Force cert verification. 0: don't allow self-signed cert. 1: allow self-signed cert. |
| -q | name-value pair num of request header, default and larger than 6 |
| -o | Output log file path, default ./clog |
| -f | Debug endless loop. |
| -e | Epoch, default is 0. |
| -D | Process num. default is 2. |
| -b | Create connection per second. default is 100. |
| -B | Max connection num. default is 1000. |
| -J | Random CID. default is 0. |
| -Q | Multipath backup path standby, set backup_mode on(1). default backup_mode is 0(off). |
| -A | Multipath request accelerate on. default is 0(off). |

### test_server

| Option | Usage |
| :----: | ---- |
| -a | Server addr. |
| -p | Server port. |
| -e | Echo. Send received body. |
| -c | Congestion Control Algorithm. r:reno b:bbr c:cubic B:bbr2 bbr+ bbr2+ |
| -C | Pacing on. |
| -L | Endless_sending on. default is off. |
| -s | Body size to send. |
| -w | Write received body to file. |
| -r | Read sending body from file. priority e > s > r |
Expand All @@ -74,6 +88,10 @@ openssl req -newkey rsa:2048 -x509 -nodes -keyout "$keyfile" -new -out "$certfil
| -6 | IPv6 |
| -b | batch |
| -S | server sid |
| -M | Enable multi-path on. |
| -R | Enable reinjection. Default is 0, no reinjection |
| -E | load balance id encryption on |
| -K | load balance id encryption key |
| -o | Output log file path, default ./slog |
| -m | Set mpshell on |
| -Q | Multipath backup path standby, set backup_mode on(1). default backup_mode is 0(off). |
12 changes: 12 additions & 0 deletions tests/test_client.c
Original file line number Diff line number Diff line change
Expand Up @@ -2871,6 +2871,7 @@ void usage(int argc, char *argv[]) {
" -T Transport layer. No HTTP3.\n"
" -1 Force 1RTT.\n"
" -s Body size to send.\n"
" -F Abs_timeout to close conn. >=0.\n"
" -w Write received body to file.\n"
" -r Read sending body from file. priority s > r\n"
" -l Log level. e:error d:debug.\n"
Expand All @@ -2883,9 +2884,20 @@ void usage(int argc, char *argv[]) {
" -x Test case ID\n"
" -N No encryption\n"
" -6 IPv6\n"
" -M Enable multi-path on. |\n"
" -i Multi-path interface. e.g. -i interface1 -i interface2.\n"
" -R Enable reinjection. Default is 0, no reinjection.\n"
" -V Force cert verification. 0: don't allow self-signed cert. 1: allow self-signed cert.\n"
" -q name-value pair num of request header, default and larger than 6\n"
" -o Output log file path, default ./clog\n"
" -f Debug endless loop.\n"
" -e Epoch, default is 0.\n"
" -D Process num. default is 2.\n"
" -b Create connection per second. default is 100.\n"
" -B Max connection num. default is 1000.\n"
" -J Random CID. default is 0.\n"
" -Q Multipath backup path standby, set backup_mode on(1). default backup_mode is 0(off).\n"
" -A Multipath request accelerate on. default is 0(off).\n"
, prog);
}

Expand Down
6 changes: 6 additions & 0 deletions tests/test_server.c
Original file line number Diff line number Diff line change
Expand Up @@ -1383,10 +1383,12 @@ void usage(int argc, char *argv[]) {
"Usage: %s [Options]\n"
"\n"
"Options:\n"
" -a Server addr.\n"
" -p Server port.\n"
" -e Echo. Send received body.\n"
" -c Congestion Control Algorithm. r:reno b:bbr c:cubic B:bbr2 bbr+ bbr2+\n"
" -C Pacing on.\n"
" -L Endless_sending. default is 0(off).\n"
" -s Body size to send.\n"
" -w Write received body to file.\n"
" -r Read sending body from file. priority e > s > r\n"
Expand All @@ -1396,9 +1398,13 @@ void usage(int argc, char *argv[]) {
" -6 IPv6\n"
" -b batch\n"
" -S server sid\n"
" -M Enable multi-path on.\n"
" -R Enable reinjection. Default is 0, no reinjection.\n"
" -E load balance id encryption on\n"
" -K load balance id encryption key\n"
" -o Output log file path, default ./slog\n"
" -m Set mpshell on.\n"
" -Q Multipath backup path standby, set backup_mode on(1). default backup_mode is 0(off).\n"
, prog);
}

Expand Down

0 comments on commit 9f17e54

Please sign in to comment.