Open In App

Node.js http2session.close() Method

Last Updated : 11 Aug, 2021
Improve
Improve
Like Article
Like
Save
Share
Report

The http2session.close() is an inbuilt application programming interface of class http2session within http2 module which is used to close this particular session.

Syntax:

const http2session.close([callback])

Parameters: This method has one optional parameter ie. callback function which is executed when this function call is made.

Return Value: This method returns nothing but a callback function for further operations.

How to generate private key and public certificate? 
 

1. Private key: Open notepad and copy paste the following key as shown below: 
 

-----BEGIN RSA PRIVATE KEY-----
MIICXQIBAAKBgQC38R9wXcUbhOd44FavgmE5R3K4JeYOHLnI7dUq1B8/Gv7l3SOg
JKef/m9gM1KvUx951mapXGtcWgwB08J3vUE2YOZ4tWJArrVZES0BI/RmFAyhQFP5
HcWl3LSM9LRihP98F33oIkKaCxA5LxOrkgpV4HrUzIKTABDYah7RPex1WQIDAQAB
AoGBAIXR71xxa9gUfc5L7+TqBs+EMmrUb6Vusp8CoGXzQvRHMJCMrMFySV0131Nu
o0YYRDsAh1nJefYLMNcXd1BjqI+qY8IeRsxaY+9CB2KKGVVDO2uLdurdC2ZdlWXT
Vwr3dDoyR0trnXJMmH2ijTeO6bush8HuXxvxJBjvEllM5QYxAkEA3jwny9JP+RFu
0rkqPBe/wi5pXpPl7PUtdNAGrh6S5958wUoR4f9bvwmTBv1nQzExKWu4EIp+7vjJ
fBeRZhnBvQJBANPjjge8418PS9zAFyKlITq6cxmM4gOWeveQZwXVNvav0NH+OKdQ
sZnnDiG26JWmnD/B8Audu97LcxjxcWI8Jc0CQEYA5PhLU229lA9EzI0JXhoozIBC
TlcKFDuLm88VSmlHqDyqvF9YNOpEdc/p2rFLuZS2ndB4D+vu6mjwc5iZ3HECQCxy
GBHRclQ3Ti9w76lpv+2kvI4IekRMZWDWnnWfwta+DGxwCgw2pfpleBZkWqdBepb5
JFQbcxQJ0wvRYXo8qaUCQQCgTvWswBj6OTP7LTvBlU1teAN2Lnrk/N5AYHZIXW6m
nUG9lYvH7DztWDTioXMrruPF7bdXfZOVJD8t0I4OUzvC
-----END RSA PRIVATE KEY-----

2.Now save the file as private-key.pem 
 

3.Public certificate: Open notepad and copy paste the following key: 
 

-----BEGIN CERTIFICATE-----
MIICfzCCAegCCQDxxeXw914Y2DANBgkqhkiG9w0BAQsFADCBgzELMAkGA1UEBhMC
SU4xEzARBgNVBAgMCldlc3RiZW5nYWwxEDAOBgNVBAcMB0tvbGthdGExFDASBgNV
BAoMC1BhbmNvLCBJbmMuMRUwEwYDVQQDDAxSb2hpdCBQcmFzYWQxIDAeBgkqhkiG
9w0BCQEWEXJvZm9mb2ZAZ21haWwuY29tMB4XDTIwMDkwOTA1NTExN1oXDTIwMTAw
OTA1NTExN1owgYMxCzAJBgNVBAYTAklOMRMwEQYDVQQIDApXZXN0YmVuZ2FsMRAw
DgYDVQQHDAdLb2xrYXRhMRQwEgYDVQQKDAtQYW5jbywgSW5jLjEVMBMGA1UEAwwM
Um9oaXQgUHJhc2FkMSAwHgYJKoZIhvcNAQkBFhFyb2ZvZm9mQGdtYWlsLmNvbTCB
nzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEAt/EfcF3FG4TneOBWr4JhOUdyuCXm
Dhy5yO3VKtQfPxr+5d0joCSnn/5vYDNSr1MfedZmqVxrXFoMAdPCd71BNmDmeLVi
QK61WREtASP0ZhQMoUBT+R3Fpdy0jPS0YoT/fBd96CJCmgsQOS8Tq5IKVeB61MyC
kwAQ2Goe0T3sdVkCAwEAATANBgkqhkiG9w0BAQsFAAOBgQATe6ixdAjoV7BSHgRX
bXM2+IZLq8kq3s7ck0EZrRVhsivutcaZwDXRCCinB+OlPedbzXwNZGvVX0nwPYHG
BfiXwdiuZeVJ88ni6Fm6RhoPtu2QF1UExfBvSXuMBgR+evp+e3QadNpGx6Ppl1aC
hWF6W2H9+MAlU7yvtmCQQuZmfQ==
-----END CERTIFICATE-----

4.Now save the as public-cert.pem 
 

Example 1: Filename: index.js 

javascript




// Node.js program to demonstrate the
// http2session.close() 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'),
};
 
// Creating and initializing server
// by using http2.createServer() method
const server = http2.createServer(options);
 
server.on('stream', (stream, requestHeaders) => {
   stream.respond({
      ':status': 200,
      'content-type': 'text/plain'
   });
 
   stream.write('hello ');
 
   // Getting session object
   // by using session method
   const http2session = stream.session;
 
   // Getting alpnProtocol of this session
   // by using alpnProtocol method
   const alpnProtocol = http2session.alpnProtocol;
 
   stream.end("session protocol : " + alpnProtocol);
 
   http2session.close(() => {
     console.log("session is closed");
   })
 
   // 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', (responseHeaders) => {
  console.log("status : "
    + responseHeaders[":status"]);
});
 
req.on('data', (data) => {
  console.log('Received: %s ',
  data.toString().replace(/(\n)/gm, ""));
});
 
req.on('end', () => {
  client.close(() => {
    console.log("client destroyed");
  })
});


Run the index.js file using the following command:

node index.js

Output:

server destroyed
session is closed
status : 200
Received: hello
Received: session protocol : h2c

Example 2: Filename: index.js

javascript




// Node.js program to demonstrate the
// http2session.close() 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'),
};
 
// Creating and initializing server
// by using http2.createServer() method
const server = http2.createServer(options);
 
server.on('stream', (stream, requestHeaders) => {
 
   // Getting session object
   // by using session method
   const http2session = stream.session;
 
   // Getting alpnProtocol of this session
   // by using alpnProtocol method
   const alpnProtocol = http2session.alpnProtocol;
 
   stream.end("session protocol : " + alpnProtocol);
 
   http2session.close(() => {
     console.log("session is closed");
   })
 
   // 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");
  })
});


Run the index.js file using the following command:

node index.js

Output:

Received: session protocol : h2c
client destroyed
server destroyed

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



Previous Article
Next Article

Similar Reads

Node.js Http2Session Close Event
The 'close' Event in the http2 server is emitted when the Http2Session has been destroyed. Syntax: Event: 'close' Parameters: This event does not accept any argument as a parameter. Return Value: This event returns nothing but a callback function. How to generate a Private key and Public certificate? 1. Filename: Private key Open notepad and copy-p
3 min read
Node.js http2session.connecting Method
The http2session.connecting is an inbuilt application programming interface of class http2session within http2 module which is used to check if this Http2Session instance is still connecting or not. Syntax: const http2session.connecting Parameters: This method does not accept any parameter. Return Value: This method returns true if this Http2Sessio
3 min read
Node.js http2session.closed Method
The http2session.closed is an inbuilt application programming interface of class http2session within http2 module which is used to check if this Http2Session instance has been closed or not. Syntax: const http2session.closed Parameters: This method does not accept any parameter. Return Value: This method returns boolean value true if and only if th
3 min read
Node.js http2session.destroy() Method
The http2session.destroy() is an inbuilt application programming interface of class http2session within http2 module which is used to destroy this particular session. Syntax: const http2session.destroy([error][, code]) Parameters: This method takes the following two optional arguments as a parameter: error: It is an Error object if the Http2Session
3 min read
Node.js http2session.alpnProtocol Method
The http2session.alpnProtocol is an inbuilt application programming interface of class http2session within http2 module which is used to get alp protocol property associated with this http2session object. Syntax: const http2session.alpnProtocol Parameters: This method does not accept any parameter. Return Value: This method returns alp protocol pro
3 min read
Node.js http2session.destroyed Method
The http2session.destroyed is an inbuilt application programming interface of class http2session within http2 module which is used to check if the session is destroyed or not. Syntax: const http2session.destroyed Parameters: This method does not accept any parameter. Return Value: This method return true if and only if this Http2Session instance ha
3 min read
Node.js http2session.ping() Method
The http2session.ping() is an inbuilt application programming interface of class http2session within http2 module which is used to sends a PING frame to the connected HTTP/2 peer. Syntax: const http2session.ping([payload, ]callback) Parameters: This method takes the optional ping payload buffer as a parameter. Return Value: This method return true
3 min read
Node.js http2session.setTimeout() Method
The http2session.setTimeout() is an inbuilt application programming interface of class http2session within http2 module which is used to set the duration for a time after which a particular action will take place. Syntax: const http2session.setTimeout(msecs, callback) Parameters: This method takes the following two parameters as shown below: msecs:
3 min read
Node.js http2session.socket Method
The http2session.socket is an inbuilt application programming interface of class http2session within http2 module which is used to return a Proxy object that acts as a net.Socket. Syntax: const http2session.socket Parameters: This method does not accept any parameter. Return Value: This method return a Proxy object that acts as a net.Socket. How to
3 min read
Node.js http2session.remoteSettings Method
The http2session.remoteSettings is an inbuilt application programming interface of class http2session within http2 module which is used to get a prototype-less object describing the current remote settings of this Http2Session. Syntax: const http2session.remoteSettings Parameters: This method does not accept any parameter. Return Value: This method
3 min read