Node.js http2stream.setTimeout() Method

Last Updated : 21 Nov, 2021

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?

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

Now save the file as private-key.pem
Public certificate: Open notepad and copy paste the following key:

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