spdy-transport

What is spdy-transport?

The spdy-transport package is an npm module that provides a stream-based API for SPDY protocol communication. It is designed to work with both SPDY/3.1 and HTTP/2, and it can be used to create SPDY or HTTP/2 servers and clients in Node.js.

What are spdy-transport's main functionalities?

SPDY/HTTP2 server creation

This code sample demonstrates how to create a SPDY/HTTP2 server using the spdy-transport package. The server listens on port 3000 and responds with 'hello world!' to all requests.

const spdy = require('spdy');
const http = require('http');

const server = spdy.createServer({
  spdy: {
    protocols: ['h2', 'spdy/3.1', ...],
    plain: false,
    'x-forwarded-for': true,
    connection: {
      windowSize: 1024 * 1024, // Server's window size
      autoSpdy31: false
    }
  }
}, (req, res) => {
  res.writeHead(200);
  res.end('hello world!');
});

server.listen(3000);

SPDY/HTTP2 client creation

This code sample shows how to create a SPDY/HTTP2 client using the spdy-transport package. The client connects to 'https://www.example.com' and sends a GET request to the root path.

const spdy = require('spdy');
const http2 = require('http2');

const client = spdy.connect('https://www.example.com', (err, socket) => {
  if (err) {
    throw new Error(err);
  }

  const req = http2.request({
    ':method': 'GET',
    ':path': '/'
  });

  req.on('response', (headers) => {
    // handle headers
  });

  req.on('data', (chunk) => {
    // handle data
  });

  req.on('end', () => {
    console.log('request ended');
  });

  req.end();
});

Other packages similar to spdy-transport

http2

The http2 package is a core module in Node.js that provides an implementation of the HTTP/2 protocol. It is similar to spdy-transport in that it allows for the creation of HTTP/2 servers and clients. However, it is built into Node.js and does not support the SPDY protocol.

node-spdy

node-spdy is another package that provides similar functionality to spdy-transport. It supports SPDY/3.1 and HTTP/2 and allows for the creation of servers and clients. It is a higher-level package that includes spdy-transport as a dependency, offering additional features such as server push.

README

spdy-transport

SPDY/HTTP2 generic transport implementation.

WIP

NOTE: THIS IS STILL WORK IN PROGRESS. EVERYTHING MAY BE BROKEN AT THIS POINT

Usage

var transport = require('spdy-transport');

// NOTE: socket is some stream or net.Socket instance, may be an argument
// of `net.createServer`'s connection handler.

var server = transport.connection.create(socket, {
  protocol: 'http2',
  isServer: true
});

server.on('stream', function(stream) {
  console.log(stream.method, stream.path, stream.headers);
  stream.respond(200, {
    header: 'value'
  });

  stream.on('readable', function() {
    var chunk = stream.read();
    if (!chunk)
      return;

    console.log(chunk);
  });

  stream.on('end', function() {
    console.log('end');
  });

  // And other node.js Stream APIs
  // ...
});

LICENSE

This software is licensed under the MIT License.

Copyright Fedor Indutny, 2015.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.