Skip to main content

addSourceSpecificMembership

method Socket.prototype.addSourceSpecificMembership
Jump to headingSocket.prototype.addSourceSpecificMembership(
sourceAddress: string,
groupAddress: string,
multicastInterface?: string,
): void

Tells the kernel to join a source-specific multicast channel at the given sourceAddress and groupAddress, using the multicastInterface with the IP_ADD_SOURCE_MEMBERSHIP socket option. If the multicastInterface argument is not specified, the operating system will choose one interface and will add membership to it. To add membership to every available interface, call socket.addSourceSpecificMembership() multiple times, once per interface.

When called on an unbound socket, this method will implicitly bind to a random port, listening on all interfaces.

Parameters Jump to heading

Jump to headingsourceAddress: string
Jump to headinggroupAddress: string
optional
Jump to headingmulticastInterface: string

Return Type Jump to heading

void
Back to top