Commit 6324723
doc,dgram: fix addMembership documentation
Adding membership using `IP_ADD_MEMBERSHIP` with interface address set
to `INADDR_ANY` for `IPv4` or as an index of `0` for `IPv6` leads to
using only one interface selected by the operating system.
Fixes: #1692
PR-URL: #7244
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>1 parent ece428e commit 6324723
1 file changed
Lines changed: 5 additions & 4 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -75,10 +75,11 @@ socket.on('message', (msg, rinfo) => { | |||
| 75 | 75 | * `multicastAddress` {String} | |
| 76 | 76 | * `multicastInterface` {String}, Optional | |
| 77 | 77 | ||
| 78 | - Tells the kernel to join a multicast group at the given `multicastAddress` | ||
| 79 | - using the `IP_ADD_MEMBERSHIP` socket option. If the `multicastInterface` | ||
| 80 | - argument is not specified, the operating system will try to add membership to | ||
| 81 | - all valid networking interfaces. | ||
| 78 | + Tells the kernel to join a multicast group at the given `multicastAddress` and | ||
| 79 | + `multicastInterface` using the `IP_ADD_MEMBERSHIP` socket option. If the | ||
| 80 | + `multicastInterface` argument is not specified, the operating system will choose | ||
| 81 | + one interface and will add membership to it. To add membership to every | ||
| 82 | + available interface, call `addMembership` multiple times, once per interface. | ||
| 82 | 83 | ||
| 83 | 84 | ### socket.address() | |
| 84 | 85 | ||
0 commit comments