Open In App

Node.js socket.setBroadcast() Method

Improve
Improve
Like Article
Like
Save
Share
Report

The socket.setBroadcast() method is an inbuilt application programming interface of class Socket within dgram module which is used to set or clear the SO_BROADCAST socket option which helps the client in sending the datagram to a particular broadcast address.

Syntax:

const socket.setBroadcast( flag )

Parameters: This method takes the Boolean value as a parameter true for enabling the SO_BROADCAST socket option and false for disabling it.

Return Value: This method does not return any value.

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

Filename: index.js

Javascript




// Node.js program to demonstrate the
// socket.setBroadcast() 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");
let broadcast_address = 12345;
 
// 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(broadcast_address, () => {
 
        // Enable the SO_BROADCAST socket option
        // by using the setBroadcast() method
        server.setBroadcast(true);
    });
 
// Client sending message to server
client.send("Hello", 0, 7,
    broadcast_address, "localhost");


Output:

UDP String: Hello

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

Filename: index.js

Javascript




// Node.js program to demonstrate the
// socket.setBroadcast() 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, () => {
 
    // Enable the SO_BROADCAST socket option
    // by using the setBroadcast() method
    server.setBroadcast(true);
});
 
// 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_setbroadcast_flag



Last Updated : 11 Apr, 2023
Like Article
Save Article
Previous
Next
Share your thoughts in the comments
Similar Reads