Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/nodejs/node.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJames M Snell <jasnell@gmail.com>2020-07-09 22:22:55 +0300
committerJames M Snell <jasnell@gmail.com>2020-07-16 03:16:30 +0300
commitaafdc2fcad51ec0f4ecd99424d6d2055d7878fab (patch)
tree7902e34c62bcf9e7a581322851fac371cb932cb1 /doc/api/quic.md
parent48404a179fa91adb14c13af38dfd4b28852db208 (diff)
quic: replace ipv6Only option with `'udp6-only'` type
Since the `ipv6Only` option was mutually exclusive with using `'udp6'`, making it it's own type simplifies things a bit. PR-URL: https://github.com/nodejs/node/pull/34283 Reviewed-By: Anna Henningsen <anna@addaleax.net>
Diffstat (limited to 'doc/api/quic.md')
-rw-r--r--doc/api/quic.md22
1 files changed, 6 insertions, 16 deletions
diff --git a/doc/api/quic.md b/doc/api/quic.md
index f6628bf9803..0c8f73a0e5c 100644
--- a/doc/api/quic.md
+++ b/doc/api/quic.md
@@ -260,12 +260,9 @@ added: REPLACEME
IPv6 address or a host name. If a host name is given, it will be resolved
to an IP address.
* `port` {number} The local port to bind to.
- * `type` {string} Either `'udp4'` or `'upd6'` to use either IPv4 or IPv6,
- respectively. **Default**: `'udp4'`.
- * `ipv6Only` {boolean} If `type` is `'udp6'`, then setting `ipv6Only` to
- `true` will disable dual-stack support on the UDP binding -- that is,
- binding to address `'::'` will not make `'0.0.0.0'` be bound. The option
- is ignored if `type` is `'udp4'`. **Default**: `false`.
+ * `type` {string} Can be one of `'udp4'`, `'upd6'`, or `'udp6-only'` to
+ use IPv4, IPv6, or IPv6 with dual-stack mode disabled.
+ **Default**: `'udp4'`.
* `lookup` {Function} A custom DNS lookup function. Default `dns.lookup()`.
* `maxConnections` {number} The maximum number of total active inbound
connections.
@@ -1450,12 +1447,9 @@ added: REPLACEME
IPv6 address or a host name. If a host name is given, it will be resolved
to an IP address.
* `port` {number} The local port to bind to.
- * `type` {string} Either `'udp4'` or `'upd6'` to use either IPv4 or IPv6,
- respectively. **Default**: `'udp4'`.
- * `ipv6Only` {boolean} If `type` is `'udp6'`, then setting `ipv6Only` to
- `true` will disable dual-stack support on the UDP binding -- that is,
- binding to address `'::'` will not make `'0.0.0.0'` be bound. The option
- is ignored if `type` is `'udp4'`. **Default**: `false`.
+ * `type` {string} Can be one of `'udp4'`, `'upd6'`, or `'udp6-only'` to
+ use IPv4, IPv6, or IPv6 with dual-stack mode disabled.
+ **Default**: `'udp4'`.
* Returns: {QuicEndpoint}
Creates and adds a new `QuicEndpoint` to the `QuicSocket` instance.
@@ -1600,10 +1594,6 @@ added: REPLACEME
`SSL_OP_CIPHER_SERVER_PREFERENCE` to be set in `secureOptions`, see
[OpenSSL Options][] for more information.
* `idleTimeout` {number}
- * `ipv6Only` {boolean} If `type` is `'udp6'`, then setting `ipv6Only` to
- `true` will disable dual-stack support on the UDP binding -- that is,
- binding to address `'::'` will not make `'0.0.0.0'` be bound. The option
- is ignored if `type` is `'udp4'`. **Default**: `false`.
* `key` {string|string[]|Buffer|Buffer[]|Object[]} Private keys in PEM format.
PEM allows the option of private keys being encrypted. Encrypted keys will
be decrypted with `options.passphrase`. Multiple keys using different