Update docs/getting_started/demo.md (#97)

Tencent · Dec 14, 2023 · 37315f3 · 37315f3
1 parent 1e42fd5
commit 37315f3
Show file tree

Hide file tree

Showing 2 changed files with 196 additions and 44 deletions.
diff --git a/website/docs/getting_started/demo.md b/website/docs/getting_started/demo.md
@@ -39,18 +39,48 @@ The output is as follows:
 Usage: tquic_server [OPTIONS]
 
 Options:
-  -c, --cert <FILE>              TLS certificate in PEM format [default: ./cert.crt]
-  -k, --key <FILE>               TLS private key in PEM format [default: ./cert.key]
-      --log-level <LOG_LEVEL>    Log level, support OFF/ERROR/WARN/INFO/DEBUG/TRACE [default: TRACE]
-  -l, --listen <ADDR>            Address to listen [default: 0.0.0.0:4433]
-      --root <DIR>               Document root directory [default: ./]
-      --index <FILE>             Index file name [default: index.html]
-      --ticket-key <STR>         Session ticket key
-      --address-token-key <STR>  Key for generating address token
-      --handshake-only           Handshake only
-      --handshake-timeout <MS>   Handshake timeout in microseconds [default: 5000]
-      --keylog-file <FILE>       Save TLS key log into the given file
-  -h, --help                     Print help
+  -c, --cert <FILE>
+          TLS certificate in PEM format [default: ./cert.crt]
+  -k, --key <FILE>
+          TLS private key in PEM format [default: ./cert.key]
+      --log-level <LOG_LEVEL>
+          Log level, support OFF/ERROR/WARN/INFO/DEBUG/TRACE [default: INFO]
+  -l, --listen <ADDR>
+          Address to listen [default: 0.0.0.0:4433]
+      --root <DIR>
+          Document root directory [default: ./]
+      --ticket-key <STR>
+          Session ticket key [default: "tquic key"]
+      --address-token-key <STR>
+          Key for generating address token
+      --enable-retry
+          Enable stateless retry
+      --disable-stateless-reset
+          Disable stateless reset
+      --congestion-control-algor <CONGESTION_CONTROL_ALGOR>
+          Congestion control algorithm [default: CUBIC]
+      --enable-multipath
+          Enable multipath transport
+      --multipath-algor <MULTIPATH_ALGOR>
+          Multipath scheduling algorithm [default: MINRTT]
+      --recv-udp-payload-size <NUM>
+          Set max_udp_payload_size transport parameter [default: 65527]
+      --send-udp-payload-size <NUM>
+          Set the maximum outgoing UDP payload size [default: 1200]
+      --handshake-timeout <TIME>
+          Handshake timeout in microseconds [default: 10000]
+      --idle-timeout <TIME>
+          Connection idle timeout in microseconds [default: 30000]
+      --initial-rtt <TIME>
+          Initial RTT in milliseconds [default: 333]
+      --keylog-file <FILE>
+          Save TLS key log into the given file
+      --qlog-file <FILE>
+          Save QUIC qlog into the given file
+      --send-batch-size <NUM>
+          Batch size for sending packets [default: 16]
+  -h, --help
+          Print help
 ```
 
 
@@ -79,14 +109,60 @@ Arguments:
   [URLS]...  Request URLs. The host of the first one is used as SNI in Client Hello
 
 Options:
-      --log-level <LOG_LEVEL>   Log level, support OFF/ERROR/WARN/INFO/DEBUG/TRACE [default: TRACE]
-      --connect-to <ADDR>       Override server's address
-      --alpn <STR>              ALPN, support "http/0.9", "hq-interop" and "h3", separated by "," [default: h3]
-      --dump-path <DIR>         Dump response body into the given directory
-      --session-file <FILE>     File used for session resumption
-      --enable-early-data       Enable early data
-      --handshake-only          Handshake only
-      --handshake-timeout <MS>  Handshake timeout in microseconds [default: 5000]
-      --keylog-file <FILE>      Save TLS key log into the given file
-  -h, --help                    Print help
+  -t, --threads <NUM>
+          Number of threads [default: 1]
+      --max-concurrent-conns <NUM>
+          Number of concurrent connections per thread [default: 1]
+      --max-requests-per-thread <NUM>
+          Number of requests per thread. "0" means infinity mode [default: 1]
+      --max-requests-per-conn <NUM>
+          Number of max requests per connection. "0" means infinity mode [default: 1]
+      --max-concurrent-requests <NUM>
+          Number of max concurrent requests per connection [default: 1]
+  -d, --duration <TIME>
+          Benchmarking duration in seconds. "0" means infinity mode. Client will exit if either the max_requests or duration is reached [default: 0]
+      --max-sample <NUM>
+          Number of max samples per thread used for request time statistics [default: 100000]
+  -p, --print-res
+          Print response header and body to stdout
+      --log-level <STR>
+          Log level, support OFF/ERROR/WARN/INFO/DEBUG/TRACE [default: INFO]
+  -c, --connect-to <ADDR>
+          Override server's address
+  -a, --alpn <STR>
+          ALPN, support "http/0.9", "hq-interop" and "h3", separated by "," [default: h3,http/0.9,hq-interop]
+      --dump-path <DIR>
+          Dump response body into the given directory. If the specified directory does not exist, a new directory will be created
+  -s, --session-file <FILE>
+          File used for session resumption
+  -e, --enable-early-data
+          Enable early data
+      --disable-stateless-reset
+          Disable stateless reset
+      --congestion-control-algor <CONGESTION_CONTROL_ALGOR>
+          Congestion control algorithm [default: CUBIC]
+      --enable-multipath
+          Enable multipath transport
+      --multipath-algor <MULTIPATH_ALGOR>
+          Multipath scheduling algorithm [default: MINRTT]
+      --local-addresses <ADDR>
+          Extra local addresses for client
+      --recv-udp-payload-size <NUM>
+          Set max_udp_payload_size transport parameter [default: 65527]
+      --send-udp-payload-size <NUM>
+          Set the maximum outgoing UDP payload size [default: 1200]
+      --handshake-timeout <TIME>
+          Handshake timeout in microseconds [default: 10000]
+      --idle-timeout <TIME>
+          Connection idle timeout in microseconds [default: 30000]
+      --initial-rtt <TIME>
+          Initial RTT in milliseconds [default: 333]
+  -k, --keylog-file <FILE>
+          Save TLS key log into the given file
+      --qlog-file <FILE>
+          Save QUIC qlog into the given file
+      --send-batch-size <NUM>
+          Batch size for sending packets [default: 1]
+  -h, --help
+          Print help
 ```
diff --git a/website/i18n/zh/docusaurus-plugin-content-docs/current/getting_started/demo.md b/website/i18n/zh/docusaurus-plugin-content-docs/current/getting_started/demo.md
@@ -40,18 +40,48 @@ openssl x509 -req -in cert.csr -signkey cert.key -out cert.crt
 Usage: tquic_server [OPTIONS]
 
 Options:
-  -c, --cert <FILE>              TLS certificate in PEM format [default: ./cert.crt]
-  -k, --key <FILE>               TLS private key in PEM format [default: ./cert.key]
-      --log-level <LOG_LEVEL>    Log level, support OFF/ERROR/WARN/INFO/DEBUG/TRACE [default: TRACE]
-  -l, --listen <ADDR>            Address to listen [default: 0.0.0.0:4433]
-      --root <DIR>               Document root directory [default: ./]
-      --index <FILE>             Index file name [default: index.html]
-      --ticket-key <STR>         Session ticket key
-      --address-token-key <STR>  Key for generating address token
-      --handshake-only           Handshake only
-      --handshake-timeout <MS>   Handshake timeout in microseconds [default: 5000]
-      --keylog-file <FILE>       Save TLS key log into the given file
-  -h, --help                     Print help
+  -c, --cert <FILE>
+          TLS certificate in PEM format [default: ./cert.crt]
+  -k, --key <FILE>
+          TLS private key in PEM format [default: ./cert.key]
+      --log-level <LOG_LEVEL>
+          Log level, support OFF/ERROR/WARN/INFO/DEBUG/TRACE [default: INFO]
+  -l, --listen <ADDR>
+          Address to listen [default: 0.0.0.0:4433]
+      --root <DIR>
+          Document root directory [default: ./]
+      --ticket-key <STR>
+          Session ticket key [default: "tquic key"]
+      --address-token-key <STR>
+          Key for generating address token
+      --enable-retry
+          Enable stateless retry
+      --disable-stateless-reset
+          Disable stateless reset
+      --congestion-control-algor <CONGESTION_CONTROL_ALGOR>
+          Congestion control algorithm [default: CUBIC]
+      --enable-multipath
+          Enable multipath transport
+      --multipath-algor <MULTIPATH_ALGOR>
+          Multipath scheduling algorithm [default: MINRTT]
+      --recv-udp-payload-size <NUM>
+          Set max_udp_payload_size transport parameter [default: 65527]
+      --send-udp-payload-size <NUM>
+          Set the maximum outgoing UDP payload size [default: 1200]
+      --handshake-timeout <TIME>
+          Handshake timeout in microseconds [default: 10000]
+      --idle-timeout <TIME>
+          Connection idle timeout in microseconds [default: 30000]
+      --initial-rtt <TIME>
+          Initial RTT in milliseconds [default: 333]
+      --keylog-file <FILE>
+          Save TLS key log into the given file
+      --qlog-file <FILE>
+          Save QUIC qlog into the given file
+      --send-batch-size <NUM>
+          Batch size for sending packets [default: 16]
+  -h, --help
+          Print help
 ```
 
 
@@ -80,14 +110,60 @@ Arguments:
   [URLS]...  Request URLs. The host of the first one is used as SNI in Client Hello
 
 Options:
-      --log-level <LOG_LEVEL>   Log level, support OFF/ERROR/WARN/INFO/DEBUG/TRACE [default: TRACE]
-      --connect-to <ADDR>       Override server's address
-      --alpn <STR>              ALPN, support "http/0.9", "hq-interop" and "h3", separated by "," [default: h3]
-      --dump-path <DIR>         Dump response body into the given directory
-      --session-file <FILE>     File used for session resumption
-      --enable-early-data       Enable early data
-      --handshake-only          Handshake only
-      --handshake-timeout <MS>  Handshake timeout in microseconds [default: 5000]
-      --keylog-file <FILE>      Save TLS key log into the given file
-  -h, --help                    Print help
+  -t, --threads <NUM>
+          Number of threads [default: 1]
+      --max-concurrent-conns <NUM>
+          Number of concurrent connections per thread [default: 1]
+      --max-requests-per-thread <NUM>
+          Number of requests per thread. "0" means infinity mode [default: 1]
+      --max-requests-per-conn <NUM>
+          Number of max requests per connection. "0" means infinity mode [default: 1]
+      --max-concurrent-requests <NUM>
+          Number of max concurrent requests per connection [default: 1]
+  -d, --duration <TIME>
+          Benchmarking duration in seconds. "0" means infinity mode. Client will exit if either the max_requests or duration is reached [default: 0]
+      --max-sample <NUM>
+          Number of max samples per thread used for request time statistics [default: 100000]
+  -p, --print-res
+          Print response header and body to stdout
+      --log-level <STR>
+          Log level, support OFF/ERROR/WARN/INFO/DEBUG/TRACE [default: INFO]
+  -c, --connect-to <ADDR>
+          Override server's address
+  -a, --alpn <STR>
+          ALPN, support "http/0.9", "hq-interop" and "h3", separated by "," [default: h3,http/0.9,hq-interop]
+      --dump-path <DIR>
+          Dump response body into the given directory. If the specified directory does not exist, a new directory will be created
+  -s, --session-file <FILE>
+          File used for session resumption
+  -e, --enable-early-data
+          Enable early data
+      --disable-stateless-reset
+          Disable stateless reset
+      --congestion-control-algor <CONGESTION_CONTROL_ALGOR>
+          Congestion control algorithm [default: CUBIC]
+      --enable-multipath
+          Enable multipath transport
+      --multipath-algor <MULTIPATH_ALGOR>
+          Multipath scheduling algorithm [default: MINRTT]
+      --local-addresses <ADDR>
+          Extra local addresses for client
+      --recv-udp-payload-size <NUM>
+          Set max_udp_payload_size transport parameter [default: 65527]
+      --send-udp-payload-size <NUM>
+          Set the maximum outgoing UDP payload size [default: 1200]
+      --handshake-timeout <TIME>
+          Handshake timeout in microseconds [default: 10000]
+      --idle-timeout <TIME>
+          Connection idle timeout in microseconds [default: 30000]
+      --initial-rtt <TIME>
+          Initial RTT in milliseconds [default: 333]
+  -k, --keylog-file <FILE>
+          Save TLS key log into the given file
+      --qlog-file <FILE>
+          Save QUIC qlog into the given file
+      --send-batch-size <NUM>
+          Batch size for sending packets [default: 1]
+  -h, --help
+          Print help
 ```