Node.js socket.ref() Method

Last Updated : 06 Apr, 2023

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 particular socket containing all the information in it.

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

Filename: index.js

Javascript

// Node.js program to demonstrate the
// server.ref() 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();
})
    // Binding server with port
    .bind(1234, () => {
 
        // Getting the reference of the server
        // by using ref() method
        const size = server.ref();
 
        // Display the result
        console.log(size.eventNames());
 
    });

Output:

[ 'message' ] UDP String: Hello

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

Filename: index.js

JavaScript

// Node.js program to demonstrate the
// server.ref() 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', () => {
 
    // Getting address information
    // for the server
    const address = server.address();
 
    // display the result
    console.log(`server listening
        ${address.address}: $ { address.port }`);
});
 
// Binding server with port address
// by using bind() method
server.bind(1234, () => {
 
    // Getting the reference of server
    // by using ref() method
    const size = server.ref();
 
    // Display the result
    console.log(size.eventNames());
});
 
// Client sending message to server
client.send("Hello", 0, 7, 1234, "localhost");

Output:

server listening 0.0.0.0:1234 [ 'message', 'listening' ] 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_ref

Node.js socket.setRecvBufferSize() Method

RohitPrasad3

Improve

Article Tags :

Similar Reads

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: T

2 min read

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: Th

2 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 fol

2 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 par

3 min read

Node.js socket.dropMembership() Method

The socket.dropMembership() method is an inbuilt application programming interface of class Socket within dgram module which is used to make kernel leave a multicast group at the particular multicast address. Syntax: const socket.dropMembership(multicastAddress[, multicastInterface]) Parameters: Thi

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

2 min read

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 metho

2 min read

Node.js socket.setTTL() Method

The socket.setTTL() method is an inbuilt application programming interface of class Socket within dgram module which is used to set or clear the IP_TTL socket option which helps to specify how many IP hops that a packet is allowed to travel through the specified router or gateway. Syntax: const sock

2 min read

Node.js socket.setMulticastTTL() Method

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 traf

2 min read

Node.js socket.unref() Method

The socket.unref() method is an inbuilt application programming interface of class Socket within dgram module which is used to allow the process to exit even if the socket is still listening. Syntax: const socket.unref() Parameters: This method does not accept any parameters. Return Value: This meth

2 min read