quic: add natRebinding argument to docs

PR-URL: #34669 Reviewed-By: Anna Henningsen <anna@addaleax.net>
nodejs · Aug 17, 2020 · c17eaa3f3fe1ed18aef661540b07e80404172431 · c17eaa3
1 parent 442968c
commit c17eaa3f3fe1ed18aef661540b07e80404172431
Showing with 5 additions and 1 deletion.

+5 −1 doc/api/quic.md
diff --git a/doc/api/quic.md b/doc/api/quic.md
@@ -1246,12 +1246,16 @@ empty object when the key exchange is not ephemeral. The supported types are
 
 For example: `{ type: 'ECDH', name: 'prime256v1', size: 256 }`.
 
-#### `quicclientsession.setSocket(socket])`
+#### `quicclientsession.setSocket(socket[, natRebinding])`
 <!-- YAML
 added: REPLACEME
 -->
 
 * `socket` {QuicSocket} A `QuicSocket` instance to move this session to.
+* `natRebinding` {boolean} When `true`, indicates that the local address is to
+  be changed without triggering address validation. This will be rare and will
+  typically be used only to test resiliency in NAT rebind scenarios.
+  **Default**: `false`.
 * Returns: {Promise}
 
 Migrates the `QuicClientSession` to the given `QuicSocket` instance. If the new