@masx200/http-https-spdy-http2-polyglot v1.1.2

Description

Serve http and https and spdy and http2 connections over the same port with node.js，

and add typescript support。

Thanks to the original author，

https://github.com/mscdex/httpolyglot

https://github.com/httptoolkit/httpolyglot

Requirements

• node.js -- v12.0.0 or newer

Install

yarn add spdy  @masx200/http-https-spdy-http2-polyglot

Connection protocol judgment

Determine if the connection is over tls.

const istls = "encrypted" in req.socket;

Determine if the connection is http/2.

const ishttp2 = "h2" === req.socket.alpnProtocol;

Examples

• http2 server push

https://github.com/masx200/http-https-spdy-http2-polyglot/blob/master/test/push.js

• Websocket server

https://github.com/masx200/http-https-spdy-http2-polyglot/blob/master/test/websocket.js

• Simple Determine the connection protocol

import * as httpolyglot from "@masx200/http-https-spdy-http2-polyglot";
import fs from "fs";

const port = 9000;
const server = httpolyglot.createServer(
    {
        key: fs.readFileSync("server.key.pem"),
        cert: fs.readFileSync("server.crt.pem"),
    },
    function (req, res) {
        res.writeHead(200, { "Content-Type": "text/html" });
        res.end(
            ("encrypted" in req.socket ? "HTTPS" : "HTTP") + " Connection!"
        );
    }
);
server.listen(port, "localhost", function () {
    console.log("httpolyglot server listening on port " + port);
});

• redirect all http connections to https:

https://github.com/masx200/http-https-spdy-http2-polyglot/blob/master/test/redirect.js

• create a "404 not found" server

https://github.com/masx200/http-https-spdy-http2-polyglot/blob/master/test/notfound.js

API

Exports

https://github.com/masx200/http-https-spdy-http2-polyglot/blob/master/dist/index.d.ts

• createServer - Creates and returns a new Server instance.

declare function createServer(
    config: ServerOptions,
    requestListener?: RequestListener,
    upgradeListener?: UpgradeListener
): net.Server;

The requestListener is a function which is automatically added to the 'request' event

The upgradeListener is a function which is automatically added to the 'upgrade' event

If no "requestListener" or "upgradeListener" is provided, the default "404 not found" listener will be used instead.

Event "clientError", If a client connection emits an 'error' event, it will be forwarded here.

Event "tlsClientError", The 'tlsClientError' event is emitted when an error occurs before a secure connection is established.

Event: 'listening',Emitted when the server has been bound after calling server.listen().

Event: 'close', Emitted when the server closes

Event: 'error',Emitted when an error occurs on the server

Only "requestListener" will be called when the "request" event occurs.

Only "upgradeListener" will be called when the "upgrade" event occurs.

Do not add "request" or "upgrade" event listener because it is not recommended to add multiple event listeners for "request"or "upgrade".

How it Works

https://github.com/lvgithub/blog/blob/master/http_and_https_over_same_port/README.MD

TLS and HTTP connections are easy to distinguish based on the first byte sent by clients trying to connect. See this comment for more information.

https://github.com/mscdex/httpolyglot/issues/3#issuecomment-173680155

https://github.com/httptoolkit/httpolyglot/blob/master/lib/index.js

test

yarn install

yarn build

yarn generate

yarn serve

yarn test

yarn open