Node.js http2stream.setTimeout() Method

The http2stream.setTimeout() method is an inbuilt application programming interface of class Http2Stream within http2 module which is used to set the duration for a time after which a particular action will take place.

Syntax:

const http2stream.setTimeout(msecs, callback)

Parameters: This method takes the integer value of duration.

Return Value: This method returns nothing but a callback function for commencing the particular activity after time out .

How to generate the private key and public certificate?

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

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

1. Now save the file as private-key.pem
2. 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-----

1. Now save the file as public-cert.pem

Example 1: Filename: index.js

Javascript

// Node.js program to demonstrate the
// Http2Stream.setTimeout() API
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() api
const server = http2.createServer(options);


server.on('stream', (stream, requestHeaders) => {


   // setting time out for the stream
   // by using setTimeout()
   stream.setTimeout(3000, ()=>{
     stream.respond({
       ':status': 200,
       'content-type': 'text/plain'
     });

     stream.end("surprise !!!");
   })

  // 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");
  })

});

Output:

status : 200
Received: surprise !!!
client destroyed
server destroyed

Run the index.js file using the following command:

node index.js

Example 2:

Filename: index.js

Javascript

// Node.js program to demonstrate the
// Http2Stream.setTimeout() API
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 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");
  })

  // Cancel the stream if there's
  // no activity after 3 seconds
  req.setTimeout(3000, ()=>{

    req.close(NGHTTP2_CANCEL);
  })

});

Output:

events.js:292 
throw er; // Unhandled ‘error’ event 
^
Error [ERR_HTTP2_STREAM_CANCEL]: The pending stream has been canceled (caused by: connect ECONNREFUSED 127.0.0.1:8000) 
at ClientHttp2Session.destroy (internal/http2/core.js:1379:20) 
at Socket.socketOnError (internal/http2/core.js:2758:13) 
at Socket.emit (events.js:315:20) 
at emitErrorNT (internal/streams/destroy.js:92:8) 
at emitErrorAndCloseNT (internal/streams/destroy.js:60:3) 
at processTicksAndRejections (internal/process/task_queues.js:84:21) 
Emitted ‘error’ event on ClientHttp2Stream instance at: 
at emitErrorNT (internal/streams/destroy.js:92:8) 
at emitErrorAndCloseNT (internal/streams/destroy.js:60:3) 
at processTicksAndRejections (internal/process/task_queues.js:84:21) { 
cause: Error: connect ECONNREFUSED 127.0.0.1:8000 
at TCPConnectWrap.afterConnect [as oncomplete] (net.js:1141:16) { 
errno: ‘ECONNREFUSED’, 
code: ‘ECONNREFUSED’, 
syscall: ‘connect’, 
address: ‘127.0.0.1’, 
port: 8000 
}, 
code: ‘ERR_HTTP2_STREAM_CANCEL’ 
} 

Run the index.js file using the following command:

node index.js

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