The Http2ServerRequest.socket is an inbuilt application programming interface of class Http2ServerRequest within the http2 module which is used to get a Proxy object that acts as a net.Socket (or tls.TLSSocket).
Syntax:
request.socketParameters: This method does not accept any arguments as a parameter.
Return Value: This method returns a Proxy object that acts as a net.Socket (or tls.TLSSocket).
Example 1:
// Node.js program to demonstrate the
// Http2ServerRequest.socket method
const http2 = require('http2');
const fs = require('fs');
// Private key and public certificate for access
const options = {
key: fs.readFileSync('private-key.pem'),
cert: fs.readFileSync('public-cert.pem'),
};
// Request and response handler
const http2Handlers = (request, response) => {
// Getting socket of http2
// by using request.socket method
const auth = request.socket;
console.log( "socket address port :- "
+ auth.address().port)
};
// Creating and initializing server
// by using http2.createServer() method
const server = http2.createServer(options, http2Handlers);
server.on('stream', (stream, requestheader) => {
stream.respond({ ':status': 200, 'content-type':
'text/plain' });
stream.write('hello ');
// Getting all information of this http2stream object
// by using state method
const status = stream.state;
stream.end("priority weight : " + status.weight);
// Stopping the server
// by using the close() method
server.close(() => {
console.log("server destroyed");
})
});
server.listen(8000);
// Creating and initializing client
// by using tls.connect() method
const client = http2.connect('http://localhost:8000');
const req = client.request({
':method': 'GET', ':path': '/'});
req.on('response', (responsesocket) => {
console.log("status : "
+ responsesocket[":status"]);
});
req.on('data', (data) => {
console.log('Received: %s ',
data.toString().replace(/(\n)/gm,""));
});
req.on('end', () => {
client.close(() => {
console.log("client destroyed");
})
});
Output:
socket address port :- 8000
status : 200
Received: hello
Received: priority weight : 16
client destroyed
server destroyed
Example 2:
// Node.js program to demonstrate the
// Http2ServerRequest.socket method
const http2 = require('http2');
const fs = require('fs');
// Private key and public certificate for access
const options = {
key: fs.readFileSync('private-key.pem'),
cert: fs.readFileSync('public-cert.pem'),
};
// Request and response handler
const http2Handlers = (request, response) => {
// Getting socket of http2
// by using request.socket method
const auth = request.socket;
response.end( "socket address family :- "
+ auth.address().family)
};
// Creating and initializing server
// by using http2.createServer() method
const server = http2.createServer(options, http2Handlers);
server.on('stream', (stream, requestHeaders) => {
// Getting all information of this http2stream object
// by using state method
const status = stream.state;
stream.end("The sum weight of all Http2Stream : " +
status.sumDependencyWeight);
// Stopping the server
// by using the close() method
server.close(() => {
console.log("server destroyed");
})
});
server.listen(8000);
// Creating and initializing client
// by using tls.connect() method
const client = http2.connect('http://localhost:8000');
const req = client.request({
':method': 'GET', ':path': '/' });
req.on('data', (data) => {
console.log('Received: %s ',
data.toString().replace(/(\n)/gm,""));
});
req.on('end', () => {
client.close(() => {
console.log("client destroyed");
})
});
Output:
Received: socket address family :- IPv6
client destroyed
server destroyed
Use Cases of http2ServerRequest.socket
- It is used to access the socket associated with the current HTTP/2 request.
- It is used to retrieve connection-related information, such as the client's IP address.
- It is used to monitor the state of the underlying network connection.
- It is used to perform socket-level operations when required.
Reference: https://nodejs.org/dist/latest-v12.x/docs/api/http2.html#http2_request_socket
