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 method does not return any value.

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

Filename: index.js

Javascript

// Node.js program to demonstrate the
// server.setRecvBufferSize() 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, () => {

        // Setting the receiver buffer size
        // by using setRecvBufferSize() method
        server.setRecvBufferSize(12345);

        // Getting the receiver buffer size
        // by using getRecvBufferSize() method
        const size = server.getRecvBufferSize();

        // Display the result
        console.log(size);

    });

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

Output:

12345
UDP String: Hello

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

Filename: index.js

Javascript

// Node.js program to demonstrate the
// server.setRecvBufferSize() 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, () => {

    // Setting the receive buffer size
    // by using setRecvBufferSize() method
    server.setRecvBufferSize(1234567);

    // Getting the receive buffer size
    // by using getRecvBufferSize() method
    const size = server.getRecvBufferSize();

    // Display the result
    console.log(size);

});

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

Output:

server listening 0.0.0.0:1234
1234567
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_setrecvbuffersize_size