Changeset e29cc2e for trip-planner-front/node_modules/engine.io/README.md

Timestamp:

11/25/21 22:08:24 (3 years ago)

Author:

Ema <ema_spirova@…>

Branches:

master

Children:

8d391a1

Parents:

59329aa

Message:

primeNG components

File:

• trip-planner-front/node_modules/engine.io/README.md (modified) (6 diffs)

trip-planner-front/node_modules/engine.io/README.md

@@ -2 +2 @@
 # Engine.IO: the realtime engine
 
-[![Build Status](https://github.com/socketio/engine.io/workflows/CI/badge.svg?branch=master))](https://github.com/socketio/engine.io/actions)
+[![Build Status](https://github.com/socketio/engine.io/workflows/CI/badge.svg?branch=master)](https://github.com/socketio/engine.io/actions)
 [![NPM version](https://badge.fury.io/js/engine.io.svg)](http://badge.fury.io/js/engine.io)
 
@@ -189 +189 @@
 const httpServer = require('http').createServer().listen(3000);
 const server = engine.attach(httpServer, {
-  wsEngine: 'uws' // requires having uws as dependency
+  wsEngine: require('eiows').Server // requires having eiows as dependency
 });
 
@@ -205 +205 @@
     - **Arguments**
       - `Socket`: a Socket object
+
+- `initial_headers`
+    - Fired on the first request of the connection, before writing the response headers
+    - **Arguments**
+      - `headers` (`Object`): a hash of headers
+      - `req` (`http.IncomingMessage`): the request
+
+- `headers`
+    - Fired on the all requests of the connection, before writing the response headers
+    - **Arguments**
+      - `headers` (`Object`): a hash of headers
+      - `req` (`http.IncomingMessage`): the request
+
+- `connection_error`
+    - Fired when an error occurs when establishing the connection.
+    - **Arguments**
+      - `error`: an object with following properties:
+        - `req` (`http.IncomingMessage`): the request that was dropped
+        - `code` (`Number`): one of `Server.errors`
+        - `message` (`string`): one of `Server.errorMessages`
+        - `context` (`Object`): extra info about the error
+
+| Code | Message |
+| ---- | ------- |
+| 0 | "Transport unknown"
+| 1 | "Session ID unknown"
+| 2 | "Bad handshake method"
+| 3 | "Bad request"
+| 4 | "Forbidden"
+| 5 | "Unsupported protocol version"
+
 
 ##### Properties
@@ -223 +254 @@
     - **Options**
       - `pingTimeout` (`Number`): how many ms without a pong packet to
-        consider the connection closed (`5000`)
+        consider the connection closed (`20000`)
       - `pingInterval` (`Number`): how many ms before sending a new ping
         packet (`25000`)
@@ -250 +281 @@
         headers. This cookie might be used for sticky-session. Defaults to not sending any cookie (`false`).
         See [here](https://github.com/jshttp/cookie#options-1) for all supported options.
-      - `wsEngine` (`String`): what WebSocket server implementation to use. Specified module must conform to the `ws` interface (see [ws module api docs](https://github.com/websockets/ws/blob/master/doc/ws.md)). Default value is `ws`. An alternative c++ addon is also available by installing `uws` module.
+      - `wsEngine` (`Function`): what WebSocket server implementation to use. Specified module must conform to the `ws` interface (see [ws module api docs](https://github.com/websockets/ws/blob/master/doc/ws.md)). Default value is `ws`. An alternative c++ addon is also available by installing `eiows` module.
       - `cors` (`Object`): the options that will be forwarded to the cors module. See [there](https://github.com/expressjs/cors#configuration-options) for all available options. Defaults to no CORS allowed.
       - `initialPacket` (`Object`): an optional packet which will be concatenated to the handshake packet emitted by Engine.IO.
@@ -325 +356 @@
       - `type`: packet type
       - `data`: packet data (if type is message)
+- `heartbeat`
+    - Called when `ping` or `pong` packed is received (depends of client version)
 
 ##### Properties