Node.js socket.addMembership() Method

The socket.addMembership() method is an inbuilt application programming interface of class Socket within dgram module which is used to make the kernel join a multicast group at the particular multicast address.

Syntax:

const socket.addMembership(multicastAddress[, multicastInterface])

Parameters: This method takes the string representing the multicast address as a parameter.

Return Value: This method does not return any value.

Example 1: In this example, we will see the use of a socket.addMembership() method

Filename: index.js

Javascript

// Node.js program to demonstrate the
// server.addMembership() method


// Importing dgram module
const dgram = require('dgram');

// Creating and initializing client
// and server socket
let client = dgram.createSocket("udp4");
let server = dgram.createSocket("udp4");

// Catching the message event
server.on("message", function (msg) {

    // Displaying the client message
    process.stdout.write("UDP String: " + msg + "\n");

    // Exiting process
    process.exit();
})
    .bind(1234, () => {

        // Adding a multicast address for
        // others to join
        server.addMembership('224.0.0.114');
    });

// Client sending message to server
client.send("Hello", 0, 7, 1234, "localhost");

Output:

UDP String: Hello

Example 2: In this example, we will see the use of a socket.addMembership() method

Filename: index.js

Javascript

// Node.js program to demonstrate the
// server.addMembership() method


// Importing dgram module
const dgram = require('dgram');

// Creating and initializing client
// and server socket
let client = dgram.createSocket("udp4");
let server = dgram.createSocket("udp4");

// Catching the message event
server.on("message", function (msg) {

    // Displaying the client message
    process.stdout.write("UDP String: " + msg + "\n");

    // Exiting process
    process.exit();
});

// Catching the listening event
server.on('listening', () => {
    const address = server.address();
    console.log(`server listening
        ${address.address}:${address.port}`);
});

// Binding server with port address
server.bind(1234, () => {

    // Adding a multicast address for others to join
    server.addMembership('224.0.0.114');
});

// Client sending message to server
client.send("Hello", 0, 7, 1234, "localhost");

Output:

server listening 0.0.0.0:1234
UDP String: Hello

Run the index.js file using the following command:

node index.js

Reference: https://nodejs.org/dist/latest-v12.x/docs/api/dgram.html#dgram_socket_addmembership_multicastaddress_multicastinterface