Open In App

Node.js socket.setMulticastTTL() Method

Last Updated : 11 Apr, 2023
Improve
Improve
Like Article
Like
Save
Share
Report

The socket.setMulticastTTL() is an inbuilt application programming interface of class Socket within dgram module which is used to set or clear the IP_MULTICAST_TTL socket option which helps to specify how many numbers of IP hops that a packet is allowed to travel through the specified multicast traffic.

Syntax:

const socket.setMulticastTTL( ttl )

Parameters: This method takes an integer value representing the number of IP hops that a packet is allowed to travel through the specified multicast traffic.

Return Value: This method does not return any value.

Example 1: Filename: index.js

javascript




// Node.js program to demonstrate the
// server.setMulticastTTL() API
 
// 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;
 
// Handling 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 IP_MULTICAST_TTL socket option
        // and specifying the number of IP hopes
        // by using the setMulticastTTL() method
        server.setMulticastTTL(144);
    });
 
// Client sending message to server
client.send("Hello", 0, 7,
    broadcast_address, "localhost");


Output:

UDP String: Hello

Example 2: Filename: index.js

javascript




// Node.js program to demonstrate the
// server.setMulticastTTL() API
 
// Importing dgram module
const dgram = require('dgram');
 
// Creating and initializing client
// and server socket
let client = dgram.createSocket("udp4");
let server = dgram.createSocket("udp4");
 
// Handling the message event
server.on("message", function (msg) {
 
    // Displaying the client message
    process.stdout.write("UDP String: "
        + msg + "\n");
 
    // Exiting process
    process.exit();
 
});
 
// Handling 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 IP_MULTICAST_TTL socket option
    // and specifying the number of IP hopes
    // by using the setMulticastTTL() method
    server.setMulticastTTL(255);
});
 
// Client sending message to server
client.send("Hello", 0, 7,
    1234, "localhost");


Run the index.js file using the following command:

node index.js

Output:

server listening 0.0.0.0:1234
UDP String: Hello

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



Previous Article
Next Article

Similar Reads

Node.js socket.getRecvBufferSize() Method
The socket.getRecvBufferSize() is an inbuilt application programming interface of class Socket within dgram module which is used to get the size of socket receive buffer in bytes. Syntax: const socket.getRecvBufferSize() Parameters: This method does not accept any parameter. Return Value: This method returns the size of the socket receiving buffer
2 min read
Node.js socket.send() Method
The socket.send() method is an inbuilt application programming interface of class Socket within dgram module which is used to send the message from one socket to another. Syntax: socket.send(msg[, offset, length][, port][, address][, callback]) Parameters: This method takes the following parameter: msg: Message to be sent.offset: Offset in the buff
3 min read
Node.js socket.setRecvBufferSize() Method
The socket.setRecvBufferSize() method is an inbuilt application programming interface of class Socket within dgram module which is used to set the size of the socket receive buffer in bytes. Syntax: const socket.setRecvBufferSize( size ) Parameters: This method takes the integer value size as a parameter for size allocation. Return Value: This meth
2 min read
Node.js socket.setSendBufferSize() Method
The socket.setSendBufferSize() method is an inbuilt application programming interface of class Socket within dgram module which is used to set the size of the socket to send buffer in bytes. Syntax: const socket.setSendBufferSize( size ) Parameters: This method takes the integer value size as a parameter for size allocation. Return Value: This meth
2 min read
Node.js socket.getSendBufferSize() Method
The socket.getSendBufferSize() method is an inbuilt application programming interface of class Socket within dgram module which is used to get the size of the socket to send buffer in bytes. Syntax: const socket.getSendBufferSize() Parameters: This method does not accept any parameters. Return Value: This method returns the socket receive buffer si
2 min read
Node.js socket.ref() Method
The socket.ref() method is an inbuilt application programming interface of class Socket within dgram module which is used to get the reference of the particular socket containing all the information in it. Syntax: const socket.ref() Parameters: This method does not accept any parameters. Return Value: This method returns the reference of the partic
2 min read
Node.js socket.remoteAddress() Method
The socket.remoteAddress() method is an inbuilt application programming interface of class Socket within dgram module which is used to get the remote address of the server containing the port, address, and family. Syntax: const socket.remoteAddress() Parameters: This method does not accept any parameters. Return Value: This method returns the remot
3 min read
Node.js socket.connect() Method
The socket.connect() method is an inbuilt application programming interface of class Socket within dgram module which is used to connect the particular server to a particular port and address. Syntax: const socket.connect(port[, address][, callback]) Parameters: This method accepts the following parameters: port: This parameter holds the port numbe
3 min read
Node.js socket.bind() Method
The socket.bind() method is an inbuilt application programming interface of class Socket within dgram module which is used to bind the particular data gram server to a particular port with some required information. Syntax: const socket.bind(options[, callback]) Parameters: This method takes the following parameter: option: It can use the following
2 min read
Node.js socket.address() Method
The socket.address() method is an inbuilt application programming interface of class Socket within dgram module which is used to get the object which contains the address information for the socket. Syntax: const socket.address() Parameters: This method does not accept any parameter. Return Value: This method returns the object which contains the a
2 min read