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 in bytes.
Example 1: In this example, we will demonstrate the server.getRecvBufferSize() method
Filename: index.js
// Node.js program to demonstrate the
// server.getRecvBufferSize() 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 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:
65536 UDP String: Hello
Example 2: In this example, we will demonstrate the server.getRecvBufferSize() method
Filename: index.js
// Node.js program to demonstrate the
// server.getRecvBufferSize() 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 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 65536 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_getrecvbuffersize