chore(release): 2.5.1

Release notes: https://github.com/socketio/socket.io/releases/tag/2.5.1 Diff: https://github.com/socketio/socket.io/compare/2.5.0...2.5.1
fix: add a noop handler for the error event
2026-01-11 07:58:13 -05:00 · 2024-06-19 10:48:24 +02:00 · 2024-06-19 10:46:29 +02:00 · 2024-06-19 10:44:04 +02:00 · 2022-06-26 09:49:21 +02:00 · 2022-06-26 08:54:51 +02:00
81 changed files with 8110 additions and 1400 deletions
--- a/.github/ISSUE_TEMPLATE.md
+++ b/.github/ISSUE_TEMPLATE.md
@@ -1,5 +1,9 @@

-*Note*: for support questions, please use one of these channels: [stackoverflow](http://stackoverflow.com/questions/tagged/socket.io) or [slack](https://socketio.slack.com)
+**Note**: for support questions, please use one of these channels: [stackoverflow](http://stackoverflow.com/questions/tagged/socket.io) or [slack](https://socketio.slack.com)
+
+For bug reports and feature requests for the **Swift client**, please open an issue [there](https://github.com/socketio/socket.io-client-swift).
+
+For bug reports and feature requests for the **Java client**, please open an issue [there](https://github.com/socketio/socket.io-client-java).

 ### You want to:

@@ -8,12 +12,15 @@

 ### Current behaviour

+*What is actually happening?*

 ### Steps to reproduce (if the current behaviour is a bug)

+**Note**: the best way (and by that we mean **the only way**) to get a quick answer is to provide a failing test case by forking the following [fiddle](https://github.com/socketio/socket.io-fiddle).

 ### Expected behaviour

+*What is expected?*

 ### Setup
 - OS:
--- a/.github/workflows/ci.yml
+++ b/.github/workflows/ci.yml
@@ -0,0 +1,24 @@
+name: CI
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  test-node:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [10.x, 12.x, 14.x]
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v1
+        with:
+          node-version: ${{ matrix.node-version }}
+      - run: npm ci
+      - run: npm test
+        env:
+          CI: true
--- a/.gitignore
+++ b/.gitignore
@@ -11,3 +11,4 @@ node_modules
 coverage
 .idea
 dist
+.nyc_output
--- a/.travis.yml
+++ b/.travis.yml
@@ -1,28 +0,0 @@
-sudo: false
-before_install:
-  - npm install -g npm@'>=1.4.3'
-language: node_js
-node_js:
-  - "0.10"
-  - "0.12"
-  - "4"
-  - "node"
-
-git:
-  depth: 1
-
-matrix:
-  include:
-  - node_js: '0.10'
-    env: TEST_VERSION=compat
-  - node_js: '0.12'
-    env: TEST_VERSION=compat
-  - node_js: '4'
-    env: TEST_VERSION=compat
-#matrix:
-  #fast_finish: true
-  #allow_failures:
-    #- node_js: "0.11"
-
-notifications:
-  irc: "irc.freenode.org#socket.io"
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -0,0 +1,36 @@
+## [2.5.1](https://github.com/socketio/socket.io/compare/2.5.0...2.5.1) (2024-06-19)
+
+
+### Bug Fixes
+
+* add a noop handler for the error event ([d30630b](https://github.com/socketio/socket.io/commit/d30630ba10562bf987f4d2b42440fc41a828119c))
+
+
+
+# [2.5.0](https://github.com/socketio/socket.io/compare/2.4.1...2.5.0) (2022-06-26)
+
+
+### Bug Fixes
+
+* fix race condition in dynamic namespaces ([05e1278](https://github.com/socketio/socket.io/commit/05e1278cfa99f3ecf3f8f0531ffe57d850e9a05b))
+* ignore packet received after disconnection ([22d4bdf](https://github.com/socketio/socket.io/commit/22d4bdf00d1a03885dc0171125faddfaef730066))
+* only set 'connected' to true after middleware execution ([226cc16](https://github.com/socketio/socket.io/commit/226cc16165f9fe60f16ff4d295fb91c8971cde35))
+* prevent the socket from joining a room after disconnection ([f223178](https://github.com/socketio/socket.io/commit/f223178eb655a7713303b21a78f9ef9e161d6458))
+
+
+
+## [2.4.1](https://github.com/socketio/socket.io/compare/2.4.0...2.4.1) (2021-01-07)
+
+
+### Reverts
+
+* fix(security): do not allow all origins by default ([a169050](https://github.com/socketio/socket.io/commit/a1690509470e9dd5559cec4e60908ca6c23e9ba0))
+
+
+# [2.4.0](https://github.com/socketio/socket.io/compare/2.3.0...2.4.0) (2021-01-04)
+
+
+### Bug Fixes
+
+* **security:** do not allow all origins by default ([f78a575](https://github.com/socketio/socket.io/commit/f78a575f66ab693c3ea96ea88429ddb1a44c86c7))
+* properly overwrite the query sent in the handshake ([d33a619](https://github.com/socketio/socket.io/commit/d33a619905a4905c153d4fec337c74da5b533a9e))
--- a/History.md
+++ b/History.md
@@ -1,638 +0,0 @@
-
-1.7.2 / 2016-12-11
-===================
-
-  * [chore] Bump engine.io to version 1.8.2 (#2782)
-  * [fix] Fixes socket.use error packet (#2772)
-
-1.7.1 / 2016-11-28
-===================
-
-1.7.0 / 2016-11-27
-===================
-
-  * [docs] Comment connected socket availability for adapters (#2081)
-  * [docs] Fixed grammar issues in the README.md (#2159)
-  * [feature] serve sourcemap for socket.io-client (#2482)
-  * [feature] Add a `local` flag (#2628)
-  * [chore] Bump engine.io to version 1.8.1 (#2765)
-  * [chore] Update client location and serve minified file (#2766)
-
-1.6.0 / 2016-11-20
-==================
-
-  * [fix] Make ETag header comply with standard. (#2603)
-  * [feature] Loading client script on demand. (#2567)
-  * [test] Fix leaking clientSocket (#2721)
-  * [feature] Add support for all event emitter methods (#2601)
-  * [chore] Update year to 2016 (#2456)
-  * [feature] Add support for socket middleware (#2306)
-  * [feature] add support for Server#close(callback) (#2748)
-  * [fix] Don't drop query variables on handshake (#2745)
-  * [example] Add disconnection/reconnection logs to the chat example (#2675)
-  * [perf] Minor code optimizations (#2219)
-  * [chore] Bump debug to version 2.3.3 (#2754)
-  * [chore] Bump engine.io to version 1.8.0 (#2755)
-  * [chore] Bump socket.io-adapter to version 0.5.0 (#2756)
-
-1.5.1 / 2016-10-24
-==================
-
-  * [fix] Avoid swallowing exceptions thrown by user event handlers (#2682)
-  * [test] Use client function to unify `client` in test script (#2731)
-  * [docs] Add link to LICENSE (#2221)
-  * [docs] Fix JSDoc of optional parameters (#2465)
-  * [docs] Fix typo (#2724)
-  * [docs] Link readme npm package badge to npm registry page (#2612)
-  * [docs] Minor fixes (#2526)
-  * [chore] Bump socket.io-parser to 2.3.0 (#2730)
-  * [chore] Add Github issue and PR templates (#2733)
-  * [chore] Bump engine.io to 1.7.2 (#2729)
-  * [chore] Bump socket.io-parser to 2.3.1 (#2734)
-
-1.5.0 / 2016-10-06
-==================
-
-  * [feature] stop append /# before id when no namespace (#2508)
-  * [feature] Add a 'disconnecting' event to access to socket.rooms upon disconnection (#2332)
-  * [fix] Fix query string management (#2422)
-  * [fix] add quote to exec paths, prevent error when spaces in path (#2508)
-  * [docs] Prevent mixup for new programmers (#2599)
-  * [example] Fix chat display in Firefox (#2477)
-  * [chore] Add gulp & babel in the build process (#2471)
-  * [chore] Bump engine.io to 1.7.0 (#2707)
-  * [chore] Remove unused zuul-ngrok dependency (#2708)
-  * [chore] Point towards current master of socket.io-client (#2710)
-  * [chore] Restrict files included in npm package (#2709)
-  * [chore] Link build badge to master branch (#2549)
-
-1.4.8 / 2016-06-23
-==================
-
-  * package: bump `engine.io`
-
-1.4.7 / 2016-06-23
-==================
-
-  * package: bump `engine.io`
-
-1.4.6 / 2016-05-02
-==================
-
-  * package: bump engine.io
-
-1.4.5 / 2016-01-26
-==================
-
-  * fix closing the underlying `http.Server`
-
-1.4.4 / 2016-01-10
-==================
-
-  * package: bump `engine.io`
-
-1.4.3 / 2016-01-08
-==================
-
-  * bump `socket.io-client`
-
-1.4.2 / 2016-01-07
-==================
-
-  * bump `engine.io`
-
-1.4.1 / 2016-01-07
-==================
-
-  * version bump
-
-1.4.0 / 2015-11-28
-==================
-
-  * socket.io: increase large binary data test timeout
-  * package: bump `engine.io` for release
-  * trigger callback even when joining an already joined room
-  * package: bump parser
-  * namespace: clear rooms flag after a clients call (fixes #1978)
-  * package: bump `socket.io-parser`
-  * fixed tests with large data
-  * fixed a typo in the example code
-  * package: bump mocha
-  * package: bump `has-binary` and `zuul-ngrok`
-  * package: bump `engine.io` and `socket.io-client`
-  * README: clarified documentation of Socket.in
-  * README: fixed up legacy repo links
-  * test: better timeout for stress test
-  * socket: don't set request property which has a getter
-  * removed proxy index file
-  * support flags on namespace
-  * improve Socket#packet and Client#packet
-  * socket: warn node_redis-style about missing `error`
-  * test: added failing test
-  * test: increase timeout for large binary data test
-  * package: bump `has-binary` to work with all objects (fixes #1955)
-  * fix origin verification default https port [evanlucas]
-  * support compression [nkzawa]
-  * changed type of `Client#sockets`, `Namespace#sockets` and `Socket#rooms` to maps (instead of arrays)
-
-1.3.7 / 2015-09-21
-==================
-
-  * package: bump `socket.io-client` for node4 compatibility
-  * package: bump `engine.io` for node4 compatibility
-
-1.3.6 / 2015-07-14
-==================
-
-  * package: bump `engine.io` to fix build on windows
-
-1.3.5 / 2015-03-03
-==================
-
- * package: bump `socket.io-parser`
-
-1.3.4 / 2015-02-14
-==================
-
- * package: bump `socket.io-client`
-
-1.3.3 / 2015-02-03
-==================
-
- * socket: warn node_redis-style about missing `error`
- * package: bump parser to better handle bad binary packets
-
-1.3.2 / 2015-01-19
-==================
-
- * no change on this release
-
-1.3.1 / 2015-01-19
-==================
-
- * no change on this release
- * package: bump `engine.io`
-
-1.3.0 / 2015-01-19
-==================
-
- * package: bump `engine.io`
- * add test for reconnection after server restarts [rase-]
- * update license with up-to-date year range [fay-jai]
- * fix leaving unknown rooms [defunctzombie]
- * allow null origins when allowed origins is a function [drewblaisdell]
- * fix tests on node 0.11
- * package: fix `npm test` to run on windows
- * package: bump `debug` v2.1.0 [coderaiser]
- * added tests for volatile [rase-]
-
-1.2.1 / 2014-11-21
-==================
-
- * fix protocol violations and improve error handling (GH-1880)
- * package: bump `engine.io` for websocket leak fix [3rd-Eden]
- * style tweaks
-
-1.2.0 / 2014-10-27
-==================
-
- * package: bump `engine.io`
- * downloads badge
- * add test to check that empty rooms are autopruned
- * added Server#origins(v:Function) description for dynamic CORS
- * added test coverage for Server#origins(function) for dynamic CORS
- * added optional Server#origins(function) for dynamic CORS
- * fix usage example for Server#close
- * package: fix main file for example application 'chat'
- * package: bump `socket.io-parser`
- * update README http ctor to createServer()
- * bump adapter with a lot of fixes for room bookkeeping
-
-1.1.0 / 2014-09-04
-==================
-
- * examples: minor fix of escaping
- * testing for equivalence of namespaces starting with / or without
- * update index.js
- * added relevant tests
- * take "" and "/" as equivalent namespaces on server
- * use svg instead of png to get better image quality in readme
- * make CI build faster
- * fix splice arguments and `socket.rooms` value update in `socket.leaveAll`.
- * client cannot connect to non-existing namespaces
- * bump engine.io version to get the cached IP address
- * fixed handshake object address property and made the test case more strict.
- * package: bump `engine.io`
- * fixed the failing test where server crashes on disconnect involving connectBuffer
- * npmignore: ignore `.gitignore` (fixes #1607)
- * test: added failing case for `socket.disconnect` and nsps
- * fix repo in package.json
- * improve Close documentation
- * use ephemeral ports
- * fix: We should use the standard http protocol to handler the etag header.
- * override default browser font-family for inputs
- * update has-binary-data to 1.0.3
- * add close specs
- * add ability to stop the http server even if not created inside socket.io
- * make sure server gets close
- * Add test case for checking that reconnect_failed is fired only once upon failure
- * package: bump `socket.io-parser` for `component-emitter` dep fix
-
-1.0.6 / 2014-06-19
-==================
-
- * package: bump `socket.io-client`
-
-1.0.5 / 2014-06-16
-==================
-
- * package: bump `engine.io` to fix jsonp `\n` bug and CORS warnings
- * index: fix typo [yanatan16]
- * add `removeListener` to blacklisted events
- * examples: clearer instructions to install chat example
- * index: fix namespace `connectBuffer` issue
-
-1.0.4 / 2014-06-02
-==================
-
- * package: bump socket.io-client
-
-1.0.3 / 2014-05-31
-==================
-
- * package: bump `socket.io-client`
- * package: bump `socket.io-parser` for binary ACK fix
- * package: bump `engine.io` for binary UTF8 fix
- * example: fix XSS in chat example
-
-1.0.2 / 2014-05-28
-==================
-
- * package: bump `socket.io-parser` for windows fix
-
-1.0.1 / 2014-05-28
-==================
-
- * bump due to bad npm tag
-
-1.0.0 / 2014-05-28
-==================
-
- * stable release
-
-1.0.0-pre5 / 2014-05-22
-=======================
-
- * package: bump `socket.io-client` for parser fixes
- * package: bump `engine.io`
-
-1.0.0-pre4 / 2014-05-19
-=======================
-
- * package: bump client
-
-1.0.0-pre3 / 2014-05-17
-=======================
-
- * package: bump parser
- * package: bump engine.io
-
-1.0.0-pre2 / 2014-04-27
-=======================
-
- * package: bump `engine.io`
- * added backwards compatible of engine.io maxHttpBufferSize
- * added test that server and client using same protocol
- * added support for setting allowed origins
- * added information about logging
- * the set function in server can be used to set some attributes for BC
- * fix error in callback call 'done' instead of 'next' in docs
- * package: bump `socket.io-parser`
- * package: bump `expect.js`
- * added some new tests, including binary with acks
-
-1.0.0-pre / 2014-03-14
-======================
-
- * implemented `engine.io`
- * implemented `socket.io-adapter`
- * implemented `socket.io-protocol`
- * implemented `debug` and improved instrumentation
- * added binary support
- * added new `require('io')(srv)` signature
- * simplified `socket.io-client` serving
-
-0.9.14 / 2013-03-29
-===================
-
-  * manager: fix memory leak with SSL [jpallen]
-
-0.9.13 / 2012-12-13
-===================
-
-  * package: fixed `base64id` requirement
-
-0.9.12 / 2012-12-13
-===================
-
-  * manager: fix for latest node which is returning a clone with `listeners` [viirya]
-
-0.9.11 / 2012-11-02
-===================
-
-  * package: move redis to optionalDependenices [3rd-Eden]
-  * bumped client
-
-0.9.10 / 2012-08-10
-===================
-
-  * Don't lowercase log messages
-  * Always set the HTTP response in case an error should be returned to the client
-  * Create or destroy the flash policy server on configuration change
-  * Honour configuration to disable flash policy server
-  * Add express 3.0 instructions on Readme.md
-  * Bump client
-
-0.9.9 / 2012-08-01
-==================
-
-  * Fixed sync disconnect xhrs handling
-  * Put license text in its own file (#965)
-  * Add warning to .listen() to ease the migration to Express 3.x
-  * Restored compatibility with node 0.4.x
-
-0.9.8 / 2012-07-24
-==================
-
-  * Bumped client.
-
-0.9.7 / 2012-07-24
-==================
-
-  * Prevent crash when socket leaves a room twice.
-  * Corrects unsafe usage of for..in
-  * Fix for node 0.8 with `gzip compression` [vadimi]
-  * Update redis to support Node 0.8.x
-  * Made ID generation securely random
-  * Fix Redis Store race condition in manager onOpen unsubscribe callback
-  * Fix for EventEmitters always reusing the same Array instance for listeners
-
-0.9.6 / 2012-04-17
-==================
-
-  * Fixed XSS in jsonp-polling.
-
-0.9.5 / 2012-04-05
-==================
-
-  * Added test for polling and socket close.
-  * Ensure close upon request close.
-  * Fix disconnection reason being lost for polling transports.
-  * Ensure that polling transports work with Connection: close.
-  * Log disconnection reason.
-
-0.9.4 / 2012-04-01
-==================
-
-  * Disconnecting from namespace improvement (#795) [DanielBaulig]
-  * Bumped client with polling reconnection loop (#438)
-
-0.9.3 / 2012-03-28
-==================
-
-  * Fix "Syntax error" on FF Web Console with XHR Polling [mikito]
-
-0.9.2 / 2012-03-13
-==================
-
-  * More sensible close `timeout default` (fixes disconnect issue)
-
-0.9.1-1 / 2012-03-02
-====================
-
-  * Bumped client with NPM dependency fix.
-
-0.9.1 / 2012-03-02
-==================
-
-  * Changed heartbeat timeout and interval defaults (60 and 25 seconds)
-  * Make tests work both on 0.4 and 0.6
-  * Updated client (improvements + bug fixes).
-
-0.9.0 / 2012-02-26
-==================
-
-  * Make it possible to use a regexp to match the socket.io resource URL.
-    We need this because we have to prefix the socket.io URL with a variable ID.
-  * Supplemental fix to gavinuhma/authfix, it looks like the same Access-Control-Origin logic is needed in the http and xhr-polling transports
-  * Updated express dep for windows compatibility.
-  * Combine two substr calls into one in decodePayload to improve performance
-  * Minor documentation fix
-  * Minor. Conform to style of other files.
-  * Switching setting to 'match origin protocol'
-  * Revert "Fixes leaking Redis subscriptions for #663. The local flag was not getting passed through onClientDisconnect()."
-  * Revert "Handle leaked dispatch:[id] subscription."
-  * Merge pull request #667 from dshaw/patch/redis-disconnect
-  * Handle leaked dispatch:[id] subscription.
-  * Fixes leaking Redis subscriptions for #663. The local flag was not getting passed through onClientDisconnect().
-  * Prevent memory leaking on uncompleted requests & add max post size limitation
-  * Fix for testcase
-  * Set Access-Control-Allow-Credentials true, regardless of cookie
-  * Remove assertvarnish from package as it breaks on 0.6
-  * Correct irc channel
-  * Added proper return after reserved field error
-  * Fixes manager.js failure to close connection after transport error has happened
-  * Added implicit port 80 for origin checks. fixes #638
-  * Fixed bug #432 in 0.8.7
-  * Set Access-Control-Allow-Origin header to origin to enable withCredentials
-  * Adding configuration variable matchOriginProtocol
-  * Fixes location mismatch error in Safari.
-  * Use tty to detect if we should add colors or not by default.
-  * Updated the package location.
-
-0.8.7 / 2011-11-05
-==================
-
-  * Fixed memory leaks in closed clients.
-  * Fixed memory leaks in namespaces.
-  * Fixed websocket handling for malformed requests from proxies. [einaros]
-  * Node 0.6 compatibility. [einaros] [3rd-Eden]
-  * Adapted tests and examples.
-
-0.8.6 / 2011-10-27 
-==================
-
-  * Added JSON decoding on jsonp-polling transport.
-  * Fixed README example.
-  * Major speed optimizations [3rd-Eden] [einaros] [visionmedia]
-  * Added decode/encode benchmarks [visionmedia]
-  * Added support for black-listing client sent events.
-  * Fixed logging options, closes #540 [3rd-Eden]
-  * Added vary header for gzip [3rd-Eden]
-  * Properly cleaned up async websocket / flashsocket tests, after patching node-websocket-client
-  * Patched to properly shut down when a finishClose call is made during connection establishment
-  * Added support for socket.io version on url and far-future Expires [3rd-Eden] [getify]
-  * Began IE10 compatibility [einaros] [tbranyen]
-  * Misc WebSocket fixes [einaros]
-  * Added UTF8 to respone headers for htmlfile [3rd-Eden]
-
-0.8.5 / 2011-10-07
-==================
-
-  * Added websocket draft HyBi-16 support. [einaros]
-  * Fixed websocket continuation bugs. [einaros]
-  * Fixed flashsocket transport name.
-  * Fixed websocket tests.
-  * Ensured `parser#decodePayload` doesn't choke.
-  * Added http referrer verification to manager verifyOrigin.
-  * Added access control for cross domain xhr handshakes [3rd-Eden]
-  * Added support for automatic generation of socket.io files [3rd-Eden]
-  * Added websocket binary support [einaros]
-  * Added gzip support for socket.io.js [3rd-Eden]
-  * Expose socket.transport [3rd-Eden]
-  * Updated client.
-
-0.8.4 / 2011-09-06
-==================
-
-  * Client build
-
-0.8.3 / 2011-09-03
-==================
-
-  * Fixed `\n` parsing for non-JSON packets (fixes #479).
-  * Fixed parsing of certain unicode characters (fixes #451).
-  * Fixed transport message packet logging.
-  * Fixed emission of `error` event resulting in an uncaught exception if unhandled (fixes #476).
-  * Fixed; allow for falsy values as the configuration value of `log level` (fixes #491).
-  * Fixed repository URI in `package.json`. Fixes #504.
-  * Added text/plain content-type to handshake responses [einaros]
-  * Improved single byte writes [einaros]
-  * Updated socket.io-flashsocket default port from 843 to 10843 [3rd-Eden]
-  * Updated client.
-
-0.8.2 / 2011-08-29
-==================
-
-  * Updated client.
-
-0.8.1 / 2011-08-29
-==================
-
-  * Fixed utf8 bug in send framing in websocket [einaros]
-  * Fixed typo in docs [Znarkus]
-  * Fixed bug in send framing for over 64kB of data in websocket [einaros]
-  * Corrected ping handling in websocket transport [einaros]
-
-0.8.0 / 2011-08-28
-==================
-
-  * Updated to work with two-level websocket versioning. [einaros]
-  * Added hybi07 support. [einaros]
-  * Added hybi10 support. [einaros]
-  * Added http referrer verification to manager.js verifyOrigin. [einaors]
-
-0.7.11 / 2011-08-27
-===================
-
-  * Updated socket.io-client.
-
-0.7.10 / 2011-08-27
-===================
-
-  * Updated socket.io-client.
-
-0.7.9 / 2011-08-12
-==================
-
-  * Updated socket.io-client.
-  * Make sure we only do garbage collection when the server we receive is actually run.
-
-0.7.8 / 2011-08-08
-==================
-
-  * Changed; make sure sio#listen passes options to both HTTP server and socket.io manager.
-  * Added docs for sio#listen.
-  * Added options parameter support for Manager constructor.
-  * Added memory leaks tests and test-leaks Makefile task.
-  * Removed auto npm-linking from make test.
-  * Make sure that you can disable heartbeats. [3rd-Eden]
-  * Fixed rooms memory leak [3rd-Eden]
-  * Send response once we got all POST data, not immediately [Pita]
-  * Fixed onLeave behavior with missing clientsk [3rd-Eden]
-  * Prevent duplicate references in rooms.
-  * Added alias for `to` to `in` and `in` to `to`.
-  * Fixed roomClients definition.
-  * Removed dependency on redis for installation without npm [3rd-Eden]
-  * Expose path and querystring in handshakeData [3rd-Eden]
-
-0.7.7 / 2011-07-12
-==================
-
-  * Fixed double dispatch handling with emit to closed clients.
-  * Added test for emitting to closed clients to prevent regression.
-  * Fixed race condition in redis test.
-  * Changed Transport#end instrumentation.
-  * Leveraged $emit instead of emit internally.
-  * Made tests faster.
-  * Fixed double disconnect events.
-  * Fixed disconnect logic
-  * Simplified remote events handling in Socket.
-  * Increased testcase timeout.
-  * Fixed unknown room emitting (GH-291). [3rd-Eden]
-  * Fixed `address` in handshakeData. [3rd-Eden]
-  * Removed transports definition in chat example.
-  * Fixed room cleanup
-  * Fixed; make sure the client is cleaned up after booting.
-  * Make sure to mark the client as non-open if the connection is closed.
-  * Removed unneeded `buffer` declarations.
-  * Fixed; make sure to clear socket handlers and subscriptions upon transport close.
-
-0.7.6 / 2011-06-30
-==================
-
-  * Fixed general dispatching when a client has closed.
-
-0.7.5 / 2011-06-30
-==================
-
-  * Fixed dispatching to clients that are disconnected.
-
-0.7.4 / 2011-06-30
-==================
-
-  * Fixed; only clear handlers if they were set. [level09]
-
-0.7.3 / 2011-06-30
-==================
-
-  * Exposed handshake data to clients.
-  * Refactored dispatcher interface.
-  * Changed; Moved id generation method into the manager.
-  * Added sub-namespace authorization. [3rd-Eden]
-  * Changed; normalized SocketNamespace local eventing [dvv]
-  * Changed; Use packet.reason or default to 'packet' [3rd-Eden]
-  * Changed console.error to console.log.
-  * Fixed; bind both servers at the same time do that the test never times out.
-  * Added 304 support.
-  * Removed `Transport#name` for abstract interface.
-  * Changed; lazily require http and https module only when needed. [3rd-Eden]
-
-0.7.2 / 2011-06-22
-==================
-
-  * Make sure to write a packet (of type `noop`) when closing a poll.
-    This solves a problem with cross-domain requests being flagged as aborted and
-    reconnection being triggered.
-  * Added `noop` message type.
-
-0.7.1 / 2011-06-21 
-==================
-
-  * Fixed cross-domain XHR.
-  * Added CORS test to xhr-polling suite.
-
-0.7.0 / 2010-06-21
-==================
-
-  * http://socket.io/announcement.html
--- a/2
+++ b/2
@@ -1,6 +1,6 @@
 (The MIT License)

-Copyright (c) 2014-2016 Automattic <dev@cloudup.com>
+Copyright (c) 2014-2018 Automattic <dev@cloudup.com>

 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the
--- a/8
+++ b/8
@@ -1,8 +0,0 @@
-
-test:
-	@./node_modules/.bin/gulp test
-
-test-cov:
-	@./node_modules/.bin/gulp test-cov
-
-.PHONY: test
--- a/Readme.md
+++ b/Readme.md
@@ -1,12 +1,91 @@

 # socket.io

-[![Build Status](https://secure.travis-ci.org/socketio/socket.io.svg?branch=master)](https://travis-ci.org/socketio/socket.io)
+[![Backers on Open Collective](https://opencollective.com/socketio/backers/badge.svg)](#backers) [![Sponsors on Open Collective](https://opencollective.com/socketio/sponsors/badge.svg)](#sponsors)
+[![Build Status](https://github.com/socketio/socket.io/workflows/CI/badge.svg)](https://github.com/socketio/socket.io/actions)
 [![Dependency Status](https://david-dm.org/socketio/socket.io.svg)](https://david-dm.org/socketio/socket.io)
 [![devDependency Status](https://david-dm.org/socketio/socket.io/dev-status.svg)](https://david-dm.org/socketio/socket.io#info=devDependencies)
 [![NPM version](https://badge.fury.io/js/socket.io.svg)](https://www.npmjs.com/package/socket.io)
 ![Downloads](https://img.shields.io/npm/dm/socket.io.svg?style=flat)
-[![](http://slack.socket.io/badge.svg?)](http://slack.socket.io)
+[![](https://slackin-socketio.now.sh/badge.svg)](https://slackin-socketio.now.sh)
+
+## Features
+
+Socket.IO enables real-time bidirectional event-based communication. It consists of:
+
+- a Node.js server (this repository)
+- a [Javascript client library](https://github.com/socketio/socket.io-client) for the browser (or a Node.js client)
+
+Some implementations in other languages are also available:
+
+- [Java](https://github.com/socketio/socket.io-client-java)
+- [C++](https://github.com/socketio/socket.io-client-cpp)
+- [Swift](https://github.com/socketio/socket.io-client-swift)
+- [Dart](https://github.com/rikulo/socket.io-client-dart)
+
+Its main features are:
+
+#### Reliability
+
+Connections are established even in the presence of:
+  - proxies and load balancers.
+  - personal firewall and antivirus software.
+
+For this purpose, it relies on [Engine.IO](https://github.com/socketio/engine.io), which first establishes a long-polling connection, then tries to upgrade to better transports that are "tested" on the side, like WebSocket. Please see the [Goals](https://github.com/socketio/engine.io#goals) section for more information.
+
+#### Auto-reconnection support
+
+Unless instructed otherwise a disconnected client will try to reconnect forever, until the server is available again. Please see the available reconnection options [here](https://github.com/socketio/socket.io-client/blob/master/docs/API.md#new-managerurl-options).
+
+#### Disconnection detection
+
+A heartbeat mechanism is implemented at the Engine.IO level, allowing both the server and the client to know when the other one is not responding anymore.
+
+That functionality is achieved with timers set on both the server and the client, with timeout values (the `pingInterval` and `pingTimeout` parameters) shared during the connection handshake. Those timers require any subsequent client calls to be directed to the same server, hence the `sticky-session` requirement when using multiples nodes.
+
+#### Binary support
+
+Any serializable data structures can be emitted, including:
+
+- [ArrayBuffer](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer) and [Blob](https://developer.mozilla.org/en-US/docs/Web/API/Blob) in the browser
+- [ArrayBuffer](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer) and [Buffer](https://nodejs.org/api/buffer.html) in Node.js
+
+#### Simple and convenient API
+
+Sample code:
+
+```js
+io.on('connection', socket => {
+  socket.emit('request', /* … */); // emit an event to the socket
+  io.emit('broadcast', /* … */); // emit an event to all connected sockets
+  socket.on('reply', () => { /* … */ }); // listen to the event
+});
+```
+
+#### Cross-browser
+
+Browser support is tested in Saucelabs:
+
+[![Sauce Test Status](https://saucelabs.com/browser-matrix/socket.svg)](https://saucelabs.com/u/socket)
+
+#### Multiplexing support
+
+In order to create separation of concerns within your application (for example per module, or based on permissions), Socket.IO allows you to create several `Namespaces`, which will act as separate communication channels but will share the same underlying connection.
+
+#### Room support
+
+Within each `Namespace`, you can define arbitrary channels, called `Rooms`, that sockets can join and leave. You can then broadcast to any given room, reaching every socket that has joined it.
+
+This is a useful feature to send notifications to a group of users, or to a given user connected on several devices for example.
+
+
+**Note:** Socket.IO is not a WebSocket implementation. Although Socket.IO indeed uses WebSocket as a transport when possible, it adds some metadata to each packet: the packet type, the namespace and the ack id when a message acknowledgement is needed. That is why a WebSocket client will not be able to successfully connect to a Socket.IO server, and a Socket.IO client will not be able to connect to a WebSocket server (like `ws://echo.websocket.org`) either. Please see the protocol specification [here](https://github.com/socketio/socket.io-protocol).
+
+## Installation
+
+```bash
+npm install socket.io
+```

 ## How to use

@@ -14,11 +93,11 @@ The following example attaches socket.io to a plain Node.JS
 HTTP server listening on port `3000`.

 ```js
-var server = require('http').createServer();
-var io = require('socket.io')(server);
-io.on('connection', function(client){
-  client.on('event', function(data){});
-  client.on('disconnect', function(){});
+const server = require('http').createServer();
+const io = require('socket.io')(server);
+io.on('connection', client => {
+  client.on('event', data => { /* … */ });
+  client.on('disconnect', () => { /* … */ });
 });
 server.listen(3000);
 ```
@@ -26,8 +105,8 @@ server.listen(3000);
 ### Standalone

 ```js
-var io = require('socket.io')();
-io.on('connection', function(client){});
+const io = require('socket.io')();
+io.on('connection', client => { ... });
 io.listen(3000);
 ```

@@ -36,13 +115,13 @@ io.listen(3000);
 Starting with **3.0**, express applications have become request handler
 functions that you pass to `http` or `http` `Server` instances. You need
 to pass the `Server` to `socket.io`, and not the express application
-function.
+function. Also make sure to call `.listen` on the `server`, not the `app`.

 ```js
-var app = require('express')();
-var server = require('http').createServer(app);
-var io = require('socket.io')(server);
-io.on('connection', function(){ /* … */ });
+const app = require('express')();
+const server = require('http').createServer(app);
+const io = require('socket.io')(server);
+io.on('connection', () => { /* … */ });
 server.listen(3000);
 ```

@@ -52,414 +131,16 @@ Like Express.JS, Koa works by exposing an application as a request
 handler function, but only by calling the `callback` method.

 ```js
-var app = require('koa')();
-var server = require('http').createServer(app.callback());
-var io = require('socket.io')(server);
-io.on('connection', function(){ /* … */ });
+const app = require('koa')();
+const server = require('http').createServer(app.callback());
+const io = require('socket.io')(server);
+io.on('connection', () => { /* … */ });
 server.listen(3000);
 ```

-## API
+## Documentation

-### Server
-
-  Exposed by `require('socket.io')`.
-
-### Server()
-
-  Creates a new `Server`. Works with and without `new`:
-
-  ```js
-  var io = require('socket.io')();
-  // or
-  var Server = require('socket.io');
-  var io = new Server();
-  ```
-
-### Server(opts:Object)
-
-  Optionally, the first or second argument (see below) of the `Server`
-  constructor can be an options object.
-
-  The following options are supported:
-
-  - `serveClient` sets the value for Server#serveClient()
-  - `path` sets the value for Server#path()
-
-  The same options passed to socket.io are always passed to
-  the `engine.io` `Server` that gets created. See engine.io
-  [options](https://github.com/socketio/engine.io#methods-1)
-  as reference.
-
-### Server(srv:http#Server, opts:Object)
-
-  Creates a new `Server` and attaches it to the given `srv`. Optionally
-  `opts` can be passed.
-
-### Server(port:Number, opts:Object)
-
-  Binds socket.io to a new `http.Server` that listens on `port`.
-
-### Server#serveClient(v:Boolean):Server
-
-  If `v` is `true` the attached server (see `Server#attach`) will serve
-  the client files. Defaults to `true`.
-
-  This method has no effect after `attach` is called.
-
-  ```js
-  // pass a server and the `serveClient` option
-  var io = require('socket.io')(http, { serveClient: false });
-
-  // or pass no server and then you can call the method
-  var io = require('socket.io')();
-  io.serveClient(false);
-  io.attach(http);
-  ```
-
-  If no arguments are supplied this method returns the current value.
-
-### Server#path(v:String):Server
-
-  Sets the path `v` under which `engine.io` and the static files will be
-  served. Defaults to `/socket.io`.
-
-  If no arguments are supplied this method returns the current value.
-
-### Server#adapter(v:Adapter):Server
-
-  Sets the adapter `v`. Defaults to an instance of the `Adapter` that
-  ships with socket.io which is memory based. See
-  [socket.io-adapter](https://github.com/socketio/socket.io-adapter).
-
-  If no arguments are supplied this method returns the current value.
-
-### Server#origins(v:String):Server
-
-  Sets the allowed origins `v`. Defaults to any origins being allowed.
-
-  If no arguments are supplied this method returns the current value.
-
-### Server#origins(v:Function):Server
-
-  Sets the allowed origins as dynamic function. Function takes two arguments `origin:String` and `callback(error, success)`, where `success` is a boolean value indicating whether origin is allowed or not.
-
-  __Potential drawbacks__:
-  * in some situations, when it is not possible to determine `origin` it may have value of `*`
-  * As this function will be executed for every request, it is advised to make this function work as fast as possible
-  * If `socket.io` is used together with `Express`, the CORS headers will be affected only for `socket.io` requests. For Express can use [cors](https://github.com/expressjs/cors).
-
-
-### Server#sockets:Namespace
-
-  The default (`/`) namespace.
-
-### Server#attach(srv:http#Server, opts:Object):Server
-
-  Attaches the `Server` to an engine.io instance on `srv` with the
-  supplied `opts` (optionally).
-
-### Server#attach(port:Number, opts:Object):Server
-
-  Attaches the `Server` to an engine.io instance that is bound to `port`
-  with the given `opts` (optionally).
-
-### Server#listen
-
-  Synonym of `Server#attach`.
-
-### Server#bind(srv:engine#Server):Server
-
-  Advanced use only. Binds the server to a specific engine.io `Server`
-  (or compatible API) instance.
-
-### Server#onconnection(socket:engine#Socket):Server
-
-  Advanced use only. Creates a new `socket.io` client from the incoming
-  engine.io (or compatible API) `socket`.
-
-### Server#of(nsp:String):Namespace
-
-  Initializes and retrieves the given `Namespace` by its pathname
-  identifier `nsp`.
-
-  If the namespace was already initialized it returns it immediately.
-
-### Server#emit
-
-  Emits an event to all connected clients. The following two are
-  equivalent:
-
-  ```js
-  var io = require('socket.io')();
-  io.sockets.emit('an event sent to all connected clients');
-  io.emit('an event sent to all connected clients');
-  ```
-
-  For other available methods, see `Namespace` below.
-
-### Server#close([fn:Function])
-
-  Closes socket.io server.
-  
-  The optional `fn` is passed to the `server.close([callback])` method of the 
-  core `net` module and is called on error or when all connections are closed. 
-  The callback is expected to implement the common single argument `err` 
-  signature (if any).
-
-  ```js
-  var Server = require('socket.io');
-  var PORT   = 3030;
-  var server = require('http').Server();
-
-  var io = Server(PORT);
-
-  io.close(); // Close current server
-
-  server.listen(PORT); // PORT is free to use
-
-  io = Server(server);
-  ```
-
-### Server#use
-
-  See `Namespace#use` below.
-
-### Namespace
-
-  Represents a pool of sockets connected under a given scope identified
-  by a pathname (eg: `/chat`).
-
-  By default the client always connects to `/`.
-
-#### Events
-
-  - `connection` / `connect`. Fired upon a connection.
-
-    Parameters:
-    - `Socket` the incoming socket.
-
-### Namespace#name:String
-
-  The namespace identifier property.
-
-### Namespace#connected:Object<Socket>
-
-  Hash of `Socket` objects that are connected to this namespace indexed
-  by `id`.
-
-### Namespace#clients(fn:Function)
-
-  Gets a list of client IDs connected to this namespace (across all nodes if applicable).
-
-  An example to get all clients in a namespace:
-
-  ```js
-  var io = require('socket.io')();
-  io.of('/chat').clients(function(error, clients){
-    if (error) throw error;
-    console.log(clients); // => [PZDoMHjiu8PYfRiKAAAF, Anw2LatarvGVVXEIAAAD]
-  });
-  ```
-
-  An example to get all clients in namespace's room:
-
-  ```js
-  var io = require('socket.io')();
-  io.of('/chat').in('general').clients(function(error, clients){
-    if (error) throw error;
-    console.log(clients); // => [Anw2LatarvGVVXEIAAAD]
-  });
-  ```
-
-  As with broadcasting, the default is all clients from the default namespace ('/'):
-
-  ```js
-  var io = require('socket.io')();
-  io.clients(function(error, clients){
-    if (error) throw error;
-    console.log(clients); // => [6em3d4TJP8Et9EMNAAAA, G5p55dHhGgUnLUctAAAB]
-  });
-  ```
-
-### Namespace#use(fn:Function):Namespace
-
-  Registers a middleware, which is a function that gets executed for
-  every incoming `Socket`, and receives as parameters the socket and a
-  function to optionally defer execution to the next registered
-  middleware.
-
-  ```js
-  var io = require('socket.io')();
-  io.use(function(socket, next){
-    if (socket.request.headers.cookie) return next();
-    next(new Error('Authentication error'));
-  });
-  ```
-
-  Errors passed to middleware callbacks are sent as special `error`
-  packets to clients.
-
-### Socket
-
-  A `Socket` is the fundamental class for interacting with browser
-  clients. A `Socket` belongs to a certain `Namespace` (by default `/`)
-  and uses an underlying `Client` to communicate.
-  
-  It should be noted the `Socket` doesn't relate directly to the actual
-  underlying TCP/IP `socket` and it is only the name of the class.
-
-### Socket#use(fn:Function):Socket
-
-  Registers a middleware, which is a function that gets executed for
-  every incoming `Packet` and receives as parameter the packet and a
-  function to optionally defer execution to the next registered
-  middleware.
-
-  ```js
-  var io = require('socket.io')();
-  io.on('connection', function(socket){
-    socket.use(function(packet, next){
-      if (packet.doge === true) return next();
-      next(new Error('Not a doge error'));
-  });
-  ```
-
-  Errors passed to middleware callbacks are sent as special `error`
-  packets to clients.
-
-### Socket#rooms:Object
-
-  A hash of strings identifying the rooms this client is in, indexed by
-  room name.
-
-### Socket#client:Client
-
-  A reference to the underlying `Client` object.
-
-### Socket#conn:Socket
-
-  A reference to the underlying `Client` transport connection (engine.io
-  `Socket` object). This allows access to the IO transport layer, which
-  still (mostly) abstracts the actual TCP/IP socket.
-
-### Socket#request:Request
-
-  A getter proxy that returns the reference to the `request` that
-  originated the underlying engine.io `Client`. Useful for accessing
-  request headers such as `Cookie` or `User-Agent`.
-
-### Socket#id:String
-
-  A unique identifier for the session, that comes from the
-  underlying `Client`.
-
-### Socket#emit(name:String[, …]):Socket
-
-  Emits an event identified by the string `name` to the client.
-  Any other parameters can be included.
-
-  All datastructures are supported, including `Buffer`. JavaScript
-  functions can't be serialized/deserialized.
-
-  ```js
-  var io = require('socket.io')();
-  io.on('connection', function(client){
-    client.emit('an event', { some: 'data' });
-  });
-  ```
-
-### Socket#join(name:String[, fn:Function]):Socket
-
-  Adds the client to the `room`, and fires optionally a callback `fn`
-  with `err` signature (if any).
-
-  The client is automatically a member of a room identified with its
-  session id (see `Socket#id`).
-
-  The mechanics of joining  rooms are handled by the `Adapter`
-  that has been configured (see `Server#adapter` above), defaulting to
-  [socket.io-adapter](https://github.com/socketio/socket.io-adapter).
-
-### Socket#leave(name:String[, fn:Function]):Socket
-
-  Removes the client from `room`, and fires optionally a callback `fn`
-  with `err` signature (if any).
-
-  **Rooms are left automatically upon disconnection**.
-
-  The mechanics of leaving rooms are handled by the `Adapter`
-  that has been configured (see `Server#adapter` above), defaulting to
-  [socket.io-adapter](https://github.com/socketio/socket.io-adapter).
-
-### Socket#to(room:String):Socket
-
-  Sets a modifier for a subsequent event emission that the event will
-  only be _broadcasted_ to clients that have joined the given `room`.
-
-  To emit to multiple rooms, you can call `to` several times.
-
-  ```js
-  var io = require('socket.io')();
-  io.on('connection', function(client){
-    client.to('others').emit('an event', { some: 'data' });
-  });
-  ```
-
-### Socket#in(room:String):Socket
-
-  Same as `Socket#to`
-
-### Socket#compress(v:Boolean):Socket
-
-  Sets a modifier for a subsequent event emission that the event data will
-  only be _compressed_ if the value is `true`. Defaults to `true` when you don't call the method.
-
-  ```js
-  var io = require('socket.io')();
-  io.on('connection', function(client){
-    client.compress(false).emit('an event', { some: 'data' });
-  });
-  ```
-  
-### Socket#disconnect(close:Boolean):Socket
-    
-  Disconnects this client. If value of close is `true`, closes the underlying connection. 
-  Otherwise, it just disconnects the namespace.
-
-#### Events
-
- `disconnect`
-    - Fired upon disconnection.
-    - **Arguments**
-      - `String`: the reason of the disconnection (either client or server-side)
- `error`
-    - Fired when an error occurs.
-    - **Arguments**
-      - `Object`: error data
- `disconnecting`
-    - Fired when the client is going to be disconnected (but hasn't left its `rooms` yet).
-    - **Arguments**
-      - `String`: the reason of the disconnection (either client or server-side)
-
-These are reserved events (along with `connect`, `newListener` and `removeListener`) which cannot be used as event names.
-
-
-### Client
-
-  The `Client` class represents an incoming transport (engine.io)
-  connection. A `Client` can be associated with many multiplexed `Socket`s
-  that belong to different `Namespace`s.
-
-### Client#conn
-
-  A reference to the underlying `engine.io` `Socket` connection.
-
-### Client#request
-
-  A getter proxy that returns the reference to the `request` that
-  originated the engine.io connection. Useful for accessing
-  request headers such as `Cookie` or `User-Agent`.
+Please see the documentation [here](/docs/README.md). Contributions are welcome!

 ## Debug / logging

@@ -484,6 +165,79 @@ Set the environmental variable `TEST_VERSION` to `compat` to test the transpiled

 The `gulp` task `test` will always transpile the source code into es5 and export to `dist` first before running the test.

+
+## Backers
+
+Support us with a monthly donation and help us continue our activities. [[Become a backer](https://opencollective.com/socketio#backer)]
+
+<a href="https://opencollective.com/socketio/backer/0/website" target="_blank"><img src="https://opencollective.com/socketio/backer/0/avatar.svg"></a>
+<a href="https://opencollective.com/socketio/backer/1/website" target="_blank"><img src="https://opencollective.com/socketio/backer/1/avatar.svg"></a>
+<a href="https://opencollective.com/socketio/backer/2/website" target="_blank"><img src="https://opencollective.com/socketio/backer/2/avatar.svg"></a>
+<a href="https://opencollective.com/socketio/backer/3/website" target="_blank"><img src="https://opencollective.com/socketio/backer/3/avatar.svg"></a>
+<a href="https://opencollective.com/socketio/backer/4/website" target="_blank"><img src="https://opencollective.com/socketio/backer/4/avatar.svg"></a>
+<a href="https://opencollective.com/socketio/backer/5/website" target="_blank"><img src="https://opencollective.com/socketio/backer/5/avatar.svg"></a>
+<a href="https://opencollective.com/socketio/backer/6/website" target="_blank"><img src="https://opencollective.com/socketio/backer/6/avatar.svg"></a>
+<a href="https://opencollective.com/socketio/backer/7/website" target="_blank"><img src="https://opencollective.com/socketio/backer/7/avatar.svg"></a>
+<a href="https://opencollective.com/socketio/backer/8/website" target="_blank"><img src="https://opencollective.com/socketio/backer/8/avatar.svg"></a>
+<a href="https://opencollective.com/socketio/backer/9/website" target="_blank"><img src="https://opencollective.com/socketio/backer/9/avatar.svg"></a>
+<a href="https://opencollective.com/socketio/backer/10/website" target="_blank"><img src="https://opencollective.com/socketio/backer/10/avatar.svg"></a>
+<a href="https://opencollective.com/socketio/backer/11/website" target="_blank"><img src="https://opencollective.com/socketio/backer/11/avatar.svg"></a>
+<a href="https://opencollective.com/socketio/backer/12/website" target="_blank"><img src="https://opencollective.com/socketio/backer/12/avatar.svg"></a>
+<a href="https://opencollective.com/socketio/backer/13/website" target="_blank"><img src="https://opencollective.com/socketio/backer/13/avatar.svg"></a>
+<a href="https://opencollective.com/socketio/backer/14/website" target="_blank"><img src="https://opencollective.com/socketio/backer/14/avatar.svg"></a>
+<a href="https://opencollective.com/socketio/backer/15/website" target="_blank"><img src="https://opencollective.com/socketio/backer/15/avatar.svg"></a>
+<a href="https://opencollective.com/socketio/backer/16/website" target="_blank"><img src="https://opencollective.com/socketio/backer/16/avatar.svg"></a>
+<a href="https://opencollective.com/socketio/backer/17/website" target="_blank"><img src="https://opencollective.com/socketio/backer/17/avatar.svg"></a>
+<a href="https://opencollective.com/socketio/backer/18/website" target="_blank"><img src="https://opencollective.com/socketio/backer/18/avatar.svg"></a>
+<a href="https://opencollective.com/socketio/backer/19/website" target="_blank"><img src="https://opencollective.com/socketio/backer/19/avatar.svg"></a>
+<a href="https://opencollective.com/socketio/backer/20/website" target="_blank"><img src="https://opencollective.com/socketio/backer/20/avatar.svg"></a>
+<a href="https://opencollective.com/socketio/backer/21/website" target="_blank"><img src="https://opencollective.com/socketio/backer/21/avatar.svg"></a>
+<a href="https://opencollective.com/socketio/backer/22/website" target="_blank"><img src="https://opencollective.com/socketio/backer/22/avatar.svg"></a>
+<a href="https://opencollective.com/socketio/backer/23/website" target="_blank"><img src="https://opencollective.com/socketio/backer/23/avatar.svg"></a>
+<a href="https://opencollective.com/socketio/backer/24/website" target="_blank"><img src="https://opencollective.com/socketio/backer/24/avatar.svg"></a>
+<a href="https://opencollective.com/socketio/backer/25/website" target="_blank"><img src="https://opencollective.com/socketio/backer/25/avatar.svg"></a>
+<a href="https://opencollective.com/socketio/backer/26/website" target="_blank"><img src="https://opencollective.com/socketio/backer/26/avatar.svg"></a>
+<a href="https://opencollective.com/socketio/backer/27/website" target="_blank"><img src="https://opencollective.com/socketio/backer/27/avatar.svg"></a>
+<a href="https://opencollective.com/socketio/backer/28/website" target="_blank"><img src="https://opencollective.com/socketio/backer/28/avatar.svg"></a>
+<a href="https://opencollective.com/socketio/backer/29/website" target="_blank"><img src="https://opencollective.com/socketio/backer/29/avatar.svg"></a>
+
+
+## Sponsors
+
+Become a sponsor and get your logo on our README on Github with a link to your site. [[Become a sponsor](https://opencollective.com/socketio#sponsor)]
+
+<a href="https://opencollective.com/socketio/sponsor/0/website" target="_blank"><img src="https://opencollective.com/socketio/sponsor/0/avatar.svg"></a>
+<a href="https://opencollective.com/socketio/sponsor/1/website" target="_blank"><img src="https://opencollective.com/socketio/sponsor/1/avatar.svg"></a>
+<a href="https://opencollective.com/socketio/sponsor/2/website" target="_blank"><img src="https://opencollective.com/socketio/sponsor/2/avatar.svg"></a>
+<a href="https://opencollective.com/socketio/sponsor/3/website" target="_blank"><img src="https://opencollective.com/socketio/sponsor/3/avatar.svg"></a>
+<a href="https://opencollective.com/socketio/sponsor/4/website" target="_blank"><img src="https://opencollective.com/socketio/sponsor/4/avatar.svg"></a>
+<a href="https://opencollective.com/socketio/sponsor/5/website" target="_blank"><img src="https://opencollective.com/socketio/sponsor/5/avatar.svg"></a>
+<a href="https://opencollective.com/socketio/sponsor/6/website" target="_blank"><img src="https://opencollective.com/socketio/sponsor/6/avatar.svg"></a>
+<a href="https://opencollective.com/socketio/sponsor/7/website" target="_blank"><img src="https://opencollective.com/socketio/sponsor/7/avatar.svg"></a>
+<a href="https://opencollective.com/socketio/sponsor/8/website" target="_blank"><img src="https://opencollective.com/socketio/sponsor/8/avatar.svg"></a>
+<a href="https://opencollective.com/socketio/sponsor/9/website" target="_blank"><img src="https://opencollective.com/socketio/sponsor/9/avatar.svg"></a>
+<a href="https://opencollective.com/socketio/sponsor/10/website" target="_blank"><img src="https://opencollective.com/socketio/sponsor/10/avatar.svg"></a>
+<a href="https://opencollective.com/socketio/sponsor/11/website" target="_blank"><img src="https://opencollective.com/socketio/sponsor/11/avatar.svg"></a>
+<a href="https://opencollective.com/socketio/sponsor/12/website" target="_blank"><img src="https://opencollective.com/socketio/sponsor/12/avatar.svg"></a>
+<a href="https://opencollective.com/socketio/sponsor/13/website" target="_blank"><img src="https://opencollective.com/socketio/sponsor/13/avatar.svg"></a>
+<a href="https://opencollective.com/socketio/sponsor/14/website" target="_blank"><img src="https://opencollective.com/socketio/sponsor/14/avatar.svg"></a>
+<a href="https://opencollective.com/socketio/sponsor/15/website" target="_blank"><img src="https://opencollective.com/socketio/sponsor/15/avatar.svg"></a>
+<a href="https://opencollective.com/socketio/sponsor/16/website" target="_blank"><img src="https://opencollective.com/socketio/sponsor/16/avatar.svg"></a>
+<a href="https://opencollective.com/socketio/sponsor/17/website" target="_blank"><img src="https://opencollective.com/socketio/sponsor/17/avatar.svg"></a>
+<a href="https://opencollective.com/socketio/sponsor/18/website" target="_blank"><img src="https://opencollective.com/socketio/sponsor/18/avatar.svg"></a>
+<a href="https://opencollective.com/socketio/sponsor/19/website" target="_blank"><img src="https://opencollective.com/socketio/sponsor/19/avatar.svg"></a>
+<a href="https://opencollective.com/socketio/sponsor/20/website" target="_blank"><img src="https://opencollective.com/socketio/sponsor/20/avatar.svg"></a>
+<a href="https://opencollective.com/socketio/sponsor/21/website" target="_blank"><img src="https://opencollective.com/socketio/sponsor/21/avatar.svg"></a>
+<a href="https://opencollective.com/socketio/sponsor/22/website" target="_blank"><img src="https://opencollective.com/socketio/sponsor/22/avatar.svg"></a>
+<a href="https://opencollective.com/socketio/sponsor/23/website" target="_blank"><img src="https://opencollective.com/socketio/sponsor/23/avatar.svg"></a>
+<a href="https://opencollective.com/socketio/sponsor/24/website" target="_blank"><img src="https://opencollective.com/socketio/sponsor/24/avatar.svg"></a>
+<a href="https://opencollective.com/socketio/sponsor/25/website" target="_blank"><img src="https://opencollective.com/socketio/sponsor/25/avatar.svg"></a>
+<a href="https://opencollective.com/socketio/sponsor/26/website" target="_blank"><img src="https://opencollective.com/socketio/sponsor/26/avatar.svg"></a>
+<a href="https://opencollective.com/socketio/sponsor/27/website" target="_blank"><img src="https://opencollective.com/socketio/sponsor/27/avatar.svg"></a>
+<a href="https://opencollective.com/socketio/sponsor/28/website" target="_blank"><img src="https://opencollective.com/socketio/sponsor/28/avatar.svg"></a>
+<a href="https://opencollective.com/socketio/sponsor/29/website" target="_blank"><img src="https://opencollective.com/socketio/sponsor/29/avatar.svg"></a>
+
+
 ## License

 [MIT](LICENSE)
--- a/docs/API.md
+++ b/docs/API.md
@@ -0,0 +1,880 @@
+
+## Table of Contents
+
+  - [Class: Server](#server)
+    - [new Server(httpServer[, options])](#new-serverhttpserver-options)
+    - [new Server(port[, options])](#new-serverport-options)
+    - [new Server(options)](#new-serveroptions)
+    - [server.sockets](#serversockets)
+    - [server.engine.generateId](#serverenginegenerateid)
+    - [server.serveClient([value])](#serverserveclientvalue)
+    - [server.path([value])](#serverpathvalue)
+    - [server.adapter([value])](#serveradaptervalue)
+    - [server.origins([value])](#serveroriginsvalue)
+    - [server.origins(fn)](#serveroriginsfn)
+    - [server.attach(httpServer[, options])](#serverattachhttpserver-options)
+    - [server.attach(port[, options])](#serverattachport-options)
+    - [server.listen(httpServer[, options])](#serverlistenhttpserver-options)
+    - [server.listen(port[, options])](#serverlistenport-options)
+    - [server.bind(engine)](#serverbindengine)
+    - [server.onconnection(socket)](#serveronconnectionsocket)
+    - [server.of(nsp)](#serverofnsp)
+    - [server.close([callback])](#serverclosecallback)
+  - [Class: Namespace](#namespace)
+    - [namespace.name](#namespacename)
+    - [namespace.connected](#namespaceconnected)
+    - [namespace.adapter](#namespaceadapter)
+    - [namespace.to(room)](#namespacetoroom)
+    - [namespace.in(room)](#namespaceinroom)
+    - [namespace.emit(eventName[, ...args])](#namespaceemiteventname-args)
+    - [namespace.clients(callback)](#namespaceclientscallback)
+    - [namespace.use(fn)](#namespaceusefn)
+    - [Event: 'connect'](#event-connect)
+    - [Event: 'connection'](#event-connect)
+    - [Flag: 'volatile'](#flag-volatile)
+    - [Flag: 'local'](#flag-local)
+    - [Flag: 'binary'](#flag-binary)
+  - [Class: Socket](#socket)
+    - [socket.id](#socketid)
+    - [socket.rooms](#socketrooms)
+    - [socket.client](#socketclient)
+    - [socket.conn](#socketconn)
+    - [socket.request](#socketrequest)
+    - [socket.handshake](#sockethandshake)
+    - [socket.use(fn)](#socketusefn)
+    - [socket.send([...args][, ack])](#socketsendargs-ack)
+    - [socket.emit(eventName[, ...args][, ack])](#socketemiteventname-args-ack)
+    - [socket.on(eventName, callback)](#socketoneventname-callback)
+    - [socket.once(eventName, listener)](#socketonceeventname-listener)
+    - [socket.removeListener(eventName, listener)](#socketremovelistenereventname-listener)
+    - [socket.removeAllListeners([eventName])](#socketremovealllistenerseventname)
+    - [socket.eventNames()](#socketeventnames)
+    - [socket.join(room[, callback])](#socketjoinroom-callback)
+    - [socket.join(rooms[, callback])](#socketjoinrooms-callback)
+    - [socket.leave(room[, callback])](#socketleaveroom-callback)
+    - [socket.to(room)](#sockettoroom)
+    - [socket.in(room)](#socketinroom)
+    - [socket.compress(value)](#socketcompressvalue)
+    - [socket.disconnect(close)](#socketdisconnectclose)
+    - [Flag: 'broadcast'](#flag-broadcast)
+    - [Flag: 'volatile'](#flag-volatile-1)
+    - [Flag: 'binary'](#flag-binary-1)
+    - [Event: 'disconnect'](#event-disconnect)
+    - [Event: 'error'](#event-error)
+    - [Event: 'disconnecting'](#event-disconnecting)
+  - [Class: Client](#client)
+    - [client.conn](#clientconn)
+    - [client.request](#clientrequest)
+
+
+### Server
+
+Exposed by `require('socket.io')`.
+
+#### new Server(httpServer[, options])
+
+  - `httpServer` _(http.Server)_ the server to bind to.
+  - `options` _(Object)_
+    - `path` _(String)_: name of the path to capture (`/socket.io`)
+    - `serveClient` _(Boolean)_: whether to serve the client files (`true`)
+    - `adapter` _(Adapter)_: the adapter to use. Defaults to an instance of the `Adapter` that ships with socket.io which is memory based. See [socket.io-adapter](https://github.com/socketio/socket.io-adapter)
+    - `origins` _(String)_: the allowed origins (`*:*`)
+    - `parser` _(Parser)_: the parser to use. Defaults to an instance of the `Parser` that ships with socket.io. See [socket.io-parser](https://github.com/socketio/socket.io-parser).
+
+Works with and without `new`:
+
+```js
+const io = require('socket.io')();
+// or
+const Server = require('socket.io');
+const io = new Server();
+```
+
+The same options passed to socket.io are always passed to the `engine.io` `Server` that gets created. See engine.io [options](https://github.com/socketio/engine.io#methods-1) as reference.
+
+Among those options:
+
+  - `pingTimeout` _(Number)_: how many ms without a pong packet to consider the connection closed (`60000`)
+  - `pingInterval` _(Number)_: how many ms before sending a new ping packet (`25000`).
+
+Those two parameters will impact the delay before a client knows the server is not available anymore. For example, if the underlying TCP connection is not closed properly due to a network issue, a client may have to wait up to `pingTimeout + pingInterval` ms before getting a `disconnect` event.
+
+  - `transports` _(Array<String>)_: transports to allow connections to (`['polling', 'websocket']`).
+
+**Note:** The order is important. By default, a long-polling connection is established first, and then upgraded to WebSocket if possible. Using `['websocket']` means there will be no fallback if a WebSocket connection cannot be opened.
+
+```js
+const server = require('http').createServer();
+
+const io = require('socket.io')(server, {
+  path: '/test',
+  serveClient: false,
+  // below are engine.IO options
+  pingInterval: 10000,
+  pingTimeout: 5000,
+  cookie: false
+});
+
+server.listen(3000);
+```
+
+#### new Server(port[, options])
+
+  - `port` _(Number)_ a port to listen to (a new `http.Server` will be created)
+  - `options` _(Object)_
+
+See [above](#new-serverhttpserver-options) for available options.
+
+```js
+const server = require('http').createServer();
+
+const io = require('socket.io')(3000, {
+  path: '/test',
+  serveClient: false,
+  // below are engine.IO options
+  pingInterval: 10000,
+  pingTimeout: 5000,
+  cookie: false
+});
+```
+
+#### new Server(options)
+
+  - `options` _(Object)_
+
+See [above](#new-serverhttpserver-options) for available options.
+
+```js
+const io = require('socket.io')({
+  path: '/test',
+  serveClient: false,
+});
+
+// either
+const server = require('http').createServer();
+
+io.attach(server, {
+  pingInterval: 10000,
+  pingTimeout: 5000,
+  cookie: false
+});
+
+server.listen(3000);
+
+// or
+io.attach(3000, {
+  pingInterval: 10000,
+  pingTimeout: 5000,
+  cookie: false
+});
+```
+
+#### server.sockets
+
+  * _(Namespace)_
+
+The default (`/`) namespace.
+
+#### server.serveClient([value])
+
+  - `value` _(Boolean)_
+  - **Returns** `Server|Boolean`
+
+If `value` is `true` the attached server (see `Server#attach`) will serve the client files. Defaults to `true`. This method has no effect after `attach` is called. If no arguments are supplied this method returns the current value.
+
+```js
+// pass a server and the `serveClient` option
+const io = require('socket.io')(http, { serveClient: false });
+
+// or pass no server and then you can call the method
+const io = require('socket.io')();
+io.serveClient(false);
+io.attach(http);
+```
+
+#### server.path([value])
+
+  - `value` _(String)_
+  - **Returns** `Server|String`
+
+Sets the path `value` under which `engine.io` and the static files will be served. Defaults to `/socket.io`. If no arguments are supplied this method returns the current value.
+
+```js
+const io = require('socket.io')();
+io.path('/myownpath');
+
+// client-side
+const socket = io({
+  path: '/myownpath'
+});
+```
+
+#### server.adapter([value])
+
+  - `value` _(Adapter)_
+  - **Returns** `Server|Adapter`
+
+Sets the adapter `value`. Defaults to an instance of the `Adapter` that ships with socket.io which is memory based. See [socket.io-adapter](https://github.com/socketio/socket.io-adapter). If no arguments are supplied this method returns the current value.
+
+```js
+const io = require('socket.io')(3000);
+const redis = require('socket.io-redis');
+io.adapter(redis({ host: 'localhost', port: 6379 }));
+```
+
+#### server.origins([value])
+
+  - `value` _(String|String[])_
+  - **Returns** `Server|String`
+
+Sets the allowed origins `value`. Defaults to any origins being allowed. If no arguments are supplied this method returns the current value.
+
+```js
+io.origins(['https://foo.example.com:443']);
+```
+
+#### server.origins(fn)
+
+  - `fn` _(Function)_
+  - **Returns** `Server`
+
+Provides a function taking two arguments `origin:String` and `callback(error, success)`, where `success` is a boolean value indicating whether origin is allowed or not.  If `success` is set to `false`, `error` must be provided as a string value that will be appended to the server response, e.g. "Origin not allowed".
+
+__Potential drawbacks__:
+* in some situations, when it is not possible to determine `origin` it may have value of `*`
+* As this function will be executed for every request, it is advised to make this function work as fast as possible
+* If `socket.io` is used together with `Express`, the CORS headers will be affected only for `socket.io` requests. For Express you can use [cors](https://github.com/expressjs/cors).
+
+```js
+io.origins((origin, callback) => {
+  if (origin !== 'https://foo.example.com') {
+    return callback('origin not allowed', false);
+  }
+  callback(null, true);
+});
+```
+
+#### server.attach(httpServer[, options])
+
+  - `httpServer` _(http.Server)_ the server to attach to
+  - `options` _(Object)_
+
+Attaches the `Server` to an engine.io instance on `httpServer` with the supplied `options` (optionally).
+
+#### server.attach(port[, options])
+
+  - `port` _(Number)_ the port to listen on
+  - `options` _(Object)_
+
+Attaches the `Server` to an engine.io instance on a new http.Server with the supplied `options` (optionally).
+
+#### server.listen(httpServer[, options])
+
+Synonym of [server.attach(httpServer[, options])](#serverattachhttpserver-options).
+
+#### server.listen(port[, options])
+
+Synonym of [server.attach(port[, options])](#serverattachport-options).
+
+#### server.bind(engine)
+
+  - `engine` _(engine.Server)_
+  - **Returns** `Server`
+
+Advanced use only. Binds the server to a specific engine.io `Server` (or compatible API) instance.
+
+#### server.onconnection(socket)
+
+  - `socket` _(engine.Socket)_
+  - **Returns** `Server`
+
+Advanced use only. Creates a new `socket.io` client from the incoming engine.io (or compatible API) `Socket`.
+
+#### server.of(nsp)
+
+  - `nsp` _(String|RegExp|Function)_
+  - **Returns** `Namespace`
+
+Initializes and retrieves the given `Namespace` by its pathname identifier `nsp`. If the namespace was already initialized it returns it immediately.
+
+```js
+const adminNamespace = io.of('/admin');
+```
+
+A regex or a function can also be provided, in order to create namespace in a dynamic way:
+
+```js
+const dynamicNsp = io.of(/^\/dynamic-\d+$/).on('connect', (socket) => {
+  const newNamespace = socket.nsp; // newNamespace.name === '/dynamic-101'
+
+  // broadcast to all clients in the given sub-namespace
+  newNamespace.emit('hello');
+});
+
+// client-side
+const socket = io('/dynamic-101');
+
+// broadcast to all clients in each sub-namespace
+dynamicNsp.emit('hello');
+
+// use a middleware for each sub-namespace
+dynamicNsp.use((socket, next) => { /* ... */ });
+```
+
+With a function:
+
+```js
+io.of((name, query, next) => {
+  next(null, checkToken(query.token));
+}).on('connect', (socket) => { /* ... */ });
+```
+
+#### server.close([callback])
+
+  - `callback` _(Function)_
+
+Closes the socket.io server. The `callback` argument is optional and will be called when all connections are closed.
+
+```js
+const Server = require('socket.io');
+const PORT   = 3030;
+const server = require('http').Server();
+
+const io = Server(PORT);
+
+io.close(); // Close current server
+
+server.listen(PORT); // PORT is free to use
+
+io = Server(server);
+```
+
+#### server.engine.generateId
+
+Overwrites the default method to generate your custom socket id.
+
+The function is called with a node request object (`http.IncomingMessage`) as first parameter.
+
+```js
+io.engine.generateId = (req) => {
+  return "custom:id:" + custom_id++; // custom id must be unique
+}
+```
+
+### Namespace
+
+Represents a pool of sockets connected under a given scope identified
+by a pathname (eg: `/chat`).
+
+A client always connects to `/` (the main namespace), then potentially connect to other namespaces (while using the same underlying connection).
+
+#### namespace.name
+
+  * _(String)_
+
+The namespace identifier property.
+
+#### namespace.connected
+
+  * _(Object<Socket>)_
+
+The hash of `Socket` objects that are connected to this namespace, indexed by `id`.
+
+#### namespace.adapter
+
+  * _(Adapter)_
+
+The `Adapter` used for the namespace. Useful when using the `Adapter` based on [Redis](https://github.com/socketio/socket.io-redis), as it exposes methods to manage sockets and rooms accross your cluster.
+
+**Note:** the adapter of the main namespace can be accessed with `io.of('/').adapter`.
+
+#### namespace.to(room)
+
+  - `room` _(String)_
+  - **Returns** `Namespace` for chaining
+
+Sets a modifier for a subsequent event emission that the event will only be _broadcasted_ to clients that have joined the given `room`.
+
+To emit to multiple rooms, you can call `to` several times.
+
+```js
+const io = require('socket.io')();
+const adminNamespace = io.of('/admin');
+
+adminNamespace.to('level1').emit('an event', { some: 'data' });
+```
+
+#### namespace.in(room)
+
+Synonym of [namespace.to(room)](#namespacetoroom).
+
+#### namespace.emit(eventName[, ...args])
+
+  - `eventName` _(String)_
+  - `args`
+
+Emits an event to all connected clients. The following two are equivalent:
+
+```js
+const io = require('socket.io')();
+io.emit('an event sent to all connected clients'); // main namespace
+
+const chat = io.of('/chat');
+chat.emit('an event sent to all connected clients in chat namespace');
+```
+
+**Note:** acknowledgements are not supported when emitting from namespace.
+
+#### namespace.clients(callback)
+
+  - `callback` _(Function)_
+
+Gets a list of client IDs connected to this namespace (across all nodes if applicable).
+
+```js
+const io = require('socket.io')();
+io.of('/chat').clients((error, clients) => {
+  if (error) throw error;
+  console.log(clients); // => [PZDoMHjiu8PYfRiKAAAF, Anw2LatarvGVVXEIAAAD]
+});
+```
+
+An example to get all clients in namespace's room:
+
+```js
+io.of('/chat').in('general').clients((error, clients) => {
+  if (error) throw error;
+  console.log(clients); // => [Anw2LatarvGVVXEIAAAD]
+});
+```
+
+As with broadcasting, the default is all clients from the default namespace ('/'):
+
+```js
+io.clients((error, clients) => {
+  if (error) throw error;
+  console.log(clients); // => [6em3d4TJP8Et9EMNAAAA, G5p55dHhGgUnLUctAAAB]
+});
+```
+
+#### namespace.use(fn)
+
+  - `fn` _(Function)_
+
+Registers a middleware, which is a function that gets executed for every incoming `Socket`, and receives as parameters the socket and a function to optionally defer execution to the next registered middleware.
+
+Errors passed to middleware callbacks are sent as special `error` packets to clients.
+
+```js
+io.use((socket, next) => {
+  if (socket.request.headers.cookie) return next();
+  next(new Error('Authentication error'));
+});
+```
+
+#### Event: 'connect'
+
+  - `socket` _(Socket)_ socket connection with client
+
+Fired upon a connection from client.
+
+```js
+io.on('connect', (socket) => {
+  // ...
+});
+
+io.of('/admin').on('connect', (socket) => {
+  // ...
+});
+```
+
+#### Event: 'connection'
+
+Synonym of [Event: 'connect'](#event-connect).
+
+#### Flag: 'volatile'
+
+Sets a modifier for a subsequent event emission that the event data may be lost if the clients are not ready to receive messages (because of network slowness or other issues, or because they’re connected through long polling and is in the middle of a request-response cycle).
+
+```js
+io.volatile.emit('an event', { some: 'data' }); // the clients may or may not receive it
+```
+
+#### Flag: 'binary'
+
+Specifies whether there is binary data in the emitted data. Increases performance when specified. Can be `true` or `false`.
+
+```js
+io.binary(false).emit('an event', { some: 'data' });
+```
+
+#### Flag: 'local'
+
+Sets a modifier for a subsequent event emission that the event data will only be _broadcast_ to the current node (when the [Redis adapter](https://github.com/socketio/socket.io-redis) is used).
+
+```js
+io.local.emit('an event', { some: 'data' });
+```
+
+### Socket
+
+A `Socket` is the fundamental class for interacting with browser clients. A `Socket` belongs to a certain `Namespace` (by default `/`) and uses an underlying `Client` to communicate.
+
+It should be noted the `Socket` doesn't relate directly to the actual underlying TCP/IP `socket` and it is only the name of the class.
+
+Within each `Namespace`, you can also define arbitrary channels (called `room`) that the `Socket` can join and leave. That provides a convenient way to broadcast to a group of `Socket`s (see `Socket#to` below).
+
+The `Socket` class inherits from [EventEmitter](https://nodejs.org/api/events.html#events_class_eventemitter). The `Socket` class overrides the `emit` method, and does not modify any other `EventEmitter` method. All methods documented here which also appear as `EventEmitter` methods (apart from `emit`) are implemented by `EventEmitter`, and documentation for `EventEmitter` applies.
+
+#### socket.id
+
+  * _(String)_
+
+A unique identifier for the session, that comes from the underlying `Client`.
+
+#### socket.rooms
+
+  * _(Object)_
+
+A hash of strings identifying the rooms this client is in, indexed by room name.
+
+```js
+io.on('connection', (socket) => {
+  socket.join('room 237', () => {
+    let rooms = Object.keys(socket.rooms);
+    console.log(rooms); // [ <socket.id>, 'room 237' ]
+  });
+});
+```
+
+#### socket.client
+
+  * _(Client)_
+
+A reference to the underlying `Client` object.
+
+#### socket.conn
+
+  * _(engine.Socket)_
+
+A reference to the underlying `Client` transport connection (engine.io `Socket` object). This allows access to the IO transport layer, which still (mostly) abstracts the actual TCP/IP socket.
+
+#### socket.request
+
+  * _(Request)_
+
+A getter proxy that returns the reference to the `request` that originated the underlying engine.io `Client`. Useful for accessing request headers such as `Cookie` or `User-Agent`.
+
+#### socket.handshake
+
+  * _(Object)_
+
+The handshake details:
+
+```js
+{
+  headers: /* the headers sent as part of the handshake */,
+  time: /* the date of creation (as string) */,
+  address: /* the ip of the client */,
+  xdomain: /* whether the connection is cross-domain */,
+  secure: /* whether the connection is secure */,
+  issued: /* the date of creation (as unix timestamp) */,
+  url: /* the request URL string */,
+  query: /* the query object */
+}
+```
+
+Usage:
+
+```js
+io.use((socket, next) => {
+  let handshake = socket.handshake;
+  // ...
+});
+
+io.on('connection', (socket) => {
+  let handshake = socket.handshake;
+  // ...
+});
+```
+
+#### socket.use(fn)
+
+  - `fn` _(Function)_
+
+Registers a middleware, which is a function that gets executed for every incoming `Packet` and receives as parameter the packet and a function to optionally defer execution to the next registered middleware.
+
+Errors passed to middleware callbacks are sent as special `error` packets to clients.
+
+```js
+io.on('connection', (socket) => {
+  socket.use((packet, next) => {
+    if (packet.doge === true) return next();
+    next(new Error('Not a doge error'));
+  });
+});
+```
+
+#### socket.send([...args][, ack])
+
+  - `args`
+  - `ack` _(Function)_
+  - **Returns** `Socket`
+
+Sends a `message` event. See [socket.emit(eventName[, ...args][, ack])](#socketemiteventname-args-ack).
+
+#### socket.emit(eventName[, ...args][, ack])
+
+*(overrides `EventEmitter.emit`)*
+  - `eventName` _(String)_
+  - `args`
+  - `ack` _(Function)_
+  - **Returns** `Socket`
+
+Emits an event to the socket identified by the string name. Any other parameters can be included. All serializable datastructures are supported, including `Buffer`.
+
+```js
+socket.emit('hello', 'world');
+socket.emit('with-binary', 1, '2', { 3: '4', 5: Buffer.alloc(6) });
+```
+
+The `ack` argument is optional and will be called with the client's answer.
+
+```js
+io.on('connection', (socket) => {
+  socket.emit('an event', { some: 'data' });
+
+  socket.emit('ferret', 'tobi', (data) => {
+    console.log(data); // data will be 'woot'
+  });
+
+  // the client code
+  // client.on('ferret', (name, fn) => {
+  //   fn('woot');
+  // });
+
+});
+```
+
+#### socket.on(eventName, callback)
+
+*(inherited from `EventEmitter`)*
+  - `eventName` _(String)_
+  - `callback` _(Function)_
+  - **Returns** `Socket`
+
+Register a new handler for the given event.
+
+```js
+socket.on('news', (data) => {
+  console.log(data);
+});
+// with several arguments
+socket.on('news', (arg1, arg2, arg3) => {
+  // ...
+});
+// or with acknowledgement
+socket.on('news', (data, callback) => {
+  callback(0);
+});
+```
+
+#### socket.once(eventName, listener)
+#### socket.removeListener(eventName, listener)
+#### socket.removeAllListeners([eventName])
+#### socket.eventNames()
+
+Inherited from `EventEmitter` (along with other methods not mentioned here). See Node.js documentation for the `events` module.
+
+#### socket.join(room[, callback])
+
+  - `room` _(String)_
+  - `callback` _(Function)_
+  - **Returns** `Socket` for chaining
+
+Adds the client to the `room`, and fires optionally a callback with `err` signature (if any).
+
+```js
+io.on('connection', (socket) => {
+  socket.join('room 237', () => {
+    let rooms = Object.keys(socket.rooms);
+    console.log(rooms); // [ <socket.id>, 'room 237' ]
+    io.to('room 237').emit('a new user has joined the room'); // broadcast to everyone in the room
+  });
+});
+```
+
+The mechanics of joining rooms are handled by the `Adapter` that has been configured (see `Server#adapter` above), defaulting to [socket.io-adapter](https://github.com/socketio/socket.io-adapter).
+
+For your convenience, each socket automatically joins a room identified by its id (see `Socket#id`). This makes it easy to broadcast messages to other sockets:
+
+```js
+io.on('connection', (socket) => {
+  socket.on('say to someone', (id, msg) => {
+    // send a private message to the socket with the given id
+    socket.to(id).emit('my message', msg);
+  });
+});
+```
+
+#### socket.join(rooms[, callback])
+
+  - `rooms` _(Array)_
+  - `callback` _(Function)_
+  - **Returns** `Socket` for chaining
+
+Adds the client to the list of room, and fires optionally a callback with `err` signature (if any).
+
+#### socket.leave(room[, callback])
+
+  - `room` _(String)_
+  - `callback` _(Function)_
+  - **Returns** `Socket` for chaining
+
+Removes the client from `room`, and fires optionally a callback with `err` signature (if any).
+
+**Rooms are left automatically upon disconnection**.
+
+#### socket.to(room)
+
+  - `room` _(String)_
+  - **Returns** `Socket` for chaining
+
+Sets a modifier for a subsequent event emission that the event will only be _broadcasted_ to clients that have joined the given `room` (the socket itself being excluded).
+
+To emit to multiple rooms, you can call `to` several times.
+
+```js
+io.on('connection', (socket) => {
+  // to one room
+  socket.to('others').emit('an event', { some: 'data' });
+  // to multiple rooms
+  socket.to('room1').to('room2').emit('hello');
+  // a private message to another socket
+  socket.to(/* another socket id */).emit('hey');
+});
+```
+
+**Note:** acknowledgements are not supported when broadcasting.
+
+#### socket.in(room)
+
+Synonym of [socket.to(room)](#sockettoroom).
+
+#### socket.compress(value)
+
+  - `value` _(Boolean)_ whether to following packet will be compressed
+  - **Returns** `Socket` for chaining
+
+Sets a modifier for a subsequent event emission that the event data will only be _compressed_ if the value is `true`. Defaults to `true` when you don't call the method.
+
+```js
+io.on('connection', (socket) => {
+  socket.compress(false).emit('uncompressed', "that's rough");
+});
+```
+
+#### socket.disconnect(close)
+
+  - `close` _(Boolean)_ whether to close the underlying connection
+  - **Returns** `Socket`
+
+Disconnects this client. If value of close is `true`, closes the underlying connection. Otherwise, it just disconnects the namespace.
+
+```js
+io.on('connection', (socket) => {
+  setTimeout(() => socket.disconnect(true), 5000);
+});
+```
+
+#### Flag: 'broadcast'
+
+Sets a modifier for a subsequent event emission that the event data will only be _broadcast_ to every sockets but the sender.
+
+```js
+io.on('connection', (socket) => {
+  socket.broadcast.emit('an event', { some: 'data' }); // everyone gets it but the sender
+});
+```
+
+#### Flag: 'volatile'
+
+Sets a modifier for a subsequent event emission that the event data may be lost if the client is not ready to receive messages (because of network slowness or other issues, or because they’re connected through long polling and is in the middle of a request-response cycle).
+
+```js
+io.on('connection', (socket) => {
+  socket.volatile.emit('an event', { some: 'data' }); // the client may or may not receive it
+});
+```
+
+#### Flag: 'binary'
+
+Specifies whether there is binary data in the emitted data. Increases performance when specified. Can be `true` or `false`.
+
+```js
+var io = require('socket.io')();
+io.on('connection', function(socket){
+  socket.binary(false).emit('an event', { some: 'data' }); // The data to send has no binary data
+});
+```
+
+#### Event: 'disconnect'
+
+  - `reason` _(String)_ the reason of the disconnection (either client or server-side)
+
+Fired upon disconnection.
+
+```js
+io.on('connection', (socket) => {
+  socket.on('disconnect', (reason) => {
+    // ...
+  });
+});
+```
+
+#### Event: 'error'
+
+  - `error` _(Object)_ error object
+
+Fired when an error occurs.
+
+```js
+io.on('connection', (socket) => {
+  socket.on('error', (error) => {
+    // ...
+  });
+});
+```
+
+#### Event: 'disconnecting'
+
+  - `reason` _(String)_ the reason of the disconnection (either client or server-side)
+
+Fired when the client is going to be disconnected (but hasn't left its `rooms` yet).
+
+```js
+io.on('connection', (socket) => {
+  socket.on('disconnecting', (reason) => {
+    let rooms = Object.keys(socket.rooms);
+    // ...
+  });
+});
+```
+
+These are reserved events (along with `connect`, `newListener` and `removeListener`) which cannot be used as event names.
+
+### Client
+
+The `Client` class represents an incoming transport (engine.io) connection. A `Client` can be associated with many multiplexed `Socket`s that belong to different `Namespace`s.
+
+#### client.conn
+
+  * _(engine.Socket)_
+
+A reference to the underlying `engine.io` `Socket` connection.
+
+#### client.request
+
+  * _(Request)_
+
+A getter proxy that returns the reference to the `request` that originated the engine.io connection. Useful for accessing request headers such as `Cookie` or `User-Agent`.
--- a/docs/README.md
+++ b/docs/README.md
@@ -0,0 +1,15 @@
+
+## Table of Contents
+
+#### Getting started
+
+  - [Write a chat application](http://socket.io/get-started/chat/)
+
+#### API Reference
+
+  - [Server API](API.md)
+  - [Client API](https://github.com/socketio/socket.io-client/blob/master/docs/API.md)
+
+#### Advanced topics
+
+  - [Emit cheatsheet](emit.md)
--- a/docs/emit.md
+++ b/docs/emit.md
@@ -0,0 +1,64 @@
+
+## Emit cheatsheet
+
+```js
+
+io.on('connect', onConnect);
+
+function onConnect(socket){
+
+  // sending to the client
+  socket.emit('hello', 'can you hear me?', 1, 2, 'abc');
+
+  // sending to all clients except sender
+  socket.broadcast.emit('broadcast', 'hello friends!');
+
+  // sending to all clients in 'game' room except sender
+  socket.to('game').emit('nice game', "let's play a game");
+
+  // sending to all clients in 'game1' and/or in 'game2' room, except sender
+  socket.to('game1').to('game2').emit('nice game', "let's play a game (too)");
+
+  // sending to all clients in 'game' room, including sender
+  io.in('game').emit('big-announcement', 'the game will start soon');
+
+  // sending to all clients in namespace 'myNamespace', including sender
+  io.of('myNamespace').emit('bigger-announcement', 'the tournament will start soon');
+
+  // sending to a specific room in a specific namespace, including sender
+  io.of('myNamespace').to('room').emit('event', 'message');
+
+  // sending to individual socketid (private message)
+  io.to(<socketid>).emit('hey', 'I just met you');
+
+  // sending with acknowledgement
+  socket.emit('question', 'do you think so?', function (answer) {});
+
+  // sending without compression
+  socket.compress(false).emit('uncompressed', "that's rough");
+
+  // sending a message that might be dropped if the client is not ready to receive messages
+  socket.volatile.emit('maybe', 'do you really need it?');
+
+  // specifying whether the data to send has binary data
+  socket.binary(false).emit('what', 'I have no binaries!');
+
+  // sending to all clients on this node (when using multiple nodes)
+  io.local.emit('hi', 'my lovely babies');
+
+  // sending to all connected clients
+  io.emit('an event sent to all connected clients');
+
+};
+
+```
+
+**Note:** The following events are reserved and should not be used as event names by your application:
+- `error`
+- `connect`
+- `disconnect`
+- `disconnecting`
+- `newListener`
+- `removeListener`
+- `ping`
+- `pong`
--- a/examples/chat/index.js
+++ b/examples/chat/index.js
@@ -1,26 +1,27 @@
 // Setup basic express server
 var express = require('express');
 var app = express();
+var path = require('path');
 var server = require('http').createServer(app);
 var io = require('../..')(server);
 var port = process.env.PORT || 3000;

-server.listen(port, function () {
+server.listen(port, () => {
  console.log('Server listening at port %d', port);
 });

 // Routing
-app.use(express.static(__dirname + '/public'));
+app.use(express.static(path.join(__dirname, 'public')));

 // Chatroom

 var numUsers = 0;

-io.on('connection', function (socket) {
+io.on('connection', (socket) => {
  var addedUser = false;

  // when the client emits 'new message', this listens and executes
-  socket.on('new message', function (data) {
+  socket.on('new message', (data) => {
    // we tell the client to execute 'new message'
    socket.broadcast.emit('new message', {
      username: socket.username,
@@ -29,7 +30,7 @@ io.on('connection', function (socket) {
  });

  // when the client emits 'add user', this listens and executes
-  socket.on('add user', function (username) {
+  socket.on('add user', (username) => {
    if (addedUser) return;

    // we store the username in the socket session for this client
@@ -47,21 +48,21 @@ io.on('connection', function (socket) {
  });

  // when the client emits 'typing', we broadcast it to others
-  socket.on('typing', function () {
+  socket.on('typing', () => {
    socket.broadcast.emit('typing', {
      username: socket.username
    });
  });

  // when the client emits 'stop typing', we broadcast it to others
-  socket.on('stop typing', function () {
+  socket.on('stop typing', () => {
    socket.broadcast.emit('stop typing', {
      username: socket.username
    });
  });

  // when the user disconnects.. perform this
-  socket.on('disconnect', function () {
+  socket.on('disconnect', () => {
    if (addedUser) {
      --numUsers;

--- a/examples/chat/public/main.js
+++ b/examples/chat/public/main.js
@@ -25,7 +25,7 @@ $(function() {

  var socket = io();

-  function addParticipantsMessage (data) {
+  const addParticipantsMessage = (data) => {
    var message = '';
    if (data.numUsers === 1) {
      message += "there's 1 participant";
@@ -36,7 +36,7 @@ $(function() {
  }

  // Sets the client's username
-  function setUsername () {
+  const setUsername = () => {
    username = cleanInput($usernameInput.val().trim());

    // If the username is valid
@@ -52,7 +52,7 @@ $(function() {
  }

  // Sends a chat message
-  function sendMessage () {
+  const sendMessage = () => {
    var message = $inputMessage.val();
    // Prevent markup from being injected into the message
    message = cleanInput(message);
@@ -69,13 +69,13 @@ $(function() {
  }

  // Log a message
-  function log (message, options) {
+    const log = (message, options) => {
    var $el = $('<li>').addClass('log').text(message);
    addMessageElement($el, options);
  }

  // Adds the visual chat message to the message list
-  function addChatMessage (data, options) {
+  const addChatMessage = (data, options) => {
    // Don't fade the message in if there is an 'X was typing'
    var $typingMessages = getTypingMessages(data);
    options = options || {};
@@ -100,14 +100,14 @@ $(function() {
  }

  // Adds the visual chat typing message
-  function addChatTyping (data) {
+  const addChatTyping = (data) => {
    data.typing = true;
    data.message = 'is typing';
    addChatMessage(data);
  }

  // Removes the visual chat typing message
-  function removeChatTyping (data) {
+  const removeChatTyping = (data) => {
    getTypingMessages(data).fadeOut(function () {
      $(this).remove();
    });
@@ -118,7 +118,7 @@ $(function() {
  // options.fade - If the element should fade-in (default = true)
  // options.prepend - If the element should prepend
  //   all other messages (default = false)
-  function addMessageElement (el, options) {
+  const addMessageElement = (el, options) => {
    var $el = $(el);

    // Setup default options
@@ -145,12 +145,12 @@ $(function() {
  }

  // Prevents input from having injected markup
-  function cleanInput (input) {
-    return $('<div/>').text(input).text();
+  const cleanInput = (input) => {
+    return $('<div/>').text(input).html();
  }

  // Updates the typing event
-  function updateTyping () {
+  const updateTyping = () => {
    if (connected) {
      if (!typing) {
        typing = true;
@@ -158,7 +158,7 @@ $(function() {
      }
      lastTypingTime = (new Date()).getTime();

-      setTimeout(function () {
+      setTimeout(() => {
        var typingTimer = (new Date()).getTime();
        var timeDiff = typingTimer - lastTypingTime;
        if (timeDiff >= TYPING_TIMER_LENGTH && typing) {
@@ -170,14 +170,14 @@ $(function() {
  }

  // Gets the 'X is typing' messages of a user
-  function getTypingMessages (data) {
+  const getTypingMessages = (data) => {
    return $('.typing.message').filter(function (i) {
      return $(this).data('username') === data.username;
    });
  }

  // Gets the color of a username through our hash function
-  function getUsernameColor (username) {
+  const getUsernameColor = (username) => {
    // Compute hash code
    var hash = 7;
    for (var i = 0; i < username.length; i++) {
@@ -190,7 +190,7 @@ $(function() {

  // Keyboard events

-  $window.keydown(function (event) {
+  $window.keydown(event => {
    // Auto-focus the current input when a key is typed
    if (!(event.ctrlKey || event.metaKey || event.altKey)) {
      $currentInput.focus();
@@ -207,26 +207,26 @@ $(function() {
    }
  });

-  $inputMessage.on('input', function() {
+  $inputMessage.on('input', () => {
    updateTyping();
  });

  // Click events

  // Focus input when clicking anywhere on login page
-  $loginPage.click(function () {
+  $loginPage.click(() => {
    $currentInput.focus();
  });

  // Focus input when clicking on the message input's border
-  $inputMessage.click(function () {
+  $inputMessage.click(() => {
    $inputMessage.focus();
  });

  // Socket events

  // Whenever the server emits 'login', log the login message
-  socket.on('login', function (data) {
+  socket.on('login', (data) => {
    connected = true;
    // Display the welcome message
    var message = "Welcome to Socket.IO Chat – ";
@@ -237,45 +237,45 @@ $(function() {
  });

  // Whenever the server emits 'new message', update the chat body
-  socket.on('new message', function (data) {
+  socket.on('new message', (data) => {
    addChatMessage(data);
  });

  // Whenever the server emits 'user joined', log it in the chat body
-  socket.on('user joined', function (data) {
+  socket.on('user joined', (data) => {
    log(data.username + ' joined');
    addParticipantsMessage(data);
  });

  // Whenever the server emits 'user left', log it in the chat body
-  socket.on('user left', function (data) {
+  socket.on('user left', (data) => {
    log(data.username + ' left');
    addParticipantsMessage(data);
    removeChatTyping(data);
  });

  // Whenever the server emits 'typing', show the typing message
-  socket.on('typing', function (data) {
+  socket.on('typing', (data) => {
    addChatTyping(data);
  });

  // Whenever the server emits 'stop typing', kill the typing message
-  socket.on('stop typing', function (data) {
+  socket.on('stop typing', (data) => {
    removeChatTyping(data);
  });

-  socket.on('disconnect', function () {
+  socket.on('disconnect', () => {
    log('you have been disconnected');
  });

-  socket.on('reconnect', function () {
+  socket.on('reconnect', () => {
    log('you have been reconnected');
    if (username) {
      socket.emit('add user', username);
    }
  });

-  socket.on('reconnect_error', function () {
+  socket.on('reconnect_error', () => {
    log('attempt to reconnect has failed');
  });

--- a/examples/cluster-haproxy/README.md
+++ b/examples/cluster-haproxy/README.md
@@ -0,0 +1,31 @@
+
+# Socket.IO Chat with haproxy & redis
+
+A simple chat demo for socket.io
+
+## How to use
+
+Install [Docker Compose](https://docs.docker.com/compose/install/), then:
+
+```
+$ docker-compose up -d
+```
+
+And then point your browser to `http://localhost:3000`.
+
+This will start four Socket.IO nodes, behind a haproxy instance which will loadbalance the requests (using a cookie for sticky sessions, see [cookie](https://cbonte.github.io/haproxy-dconv/1.7/configuration.html#4.2-cookie)).
+
+Each node connects to the redis backend, which will enable to broadcast to every client, no matter which node it is currently connected to.
+
+```
+# you can kill a given node, the client should reconnect to another node
+$ docker-compose stop server-george
+```
+
+## Features
+
+- Multiple users can join a chat room by each entering a unique username
+on website load.
+- Users can type chat messages to the chat room.
+- A notification is sent to all users when a user joins or leaves
+the chatroom.
--- a/examples/cluster-haproxy/docker-compose.yml
+++ b/examples/cluster-haproxy/docker-compose.yml
@@ -0,0 +1,51 @@
+
+haproxy:
+  build: ./haproxy
+  links:
+    - server-john
+    - server-paul
+    - server-george
+    - server-ringo
+  ports:
+   - "3000:80"
+
+server-john:
+  build: ./server
+  links:
+    - redis
+  expose:
+    - "3000"
+  environment:
+    - NAME=John
+
+server-paul:
+  build: ./server
+  links:
+    - redis
+  expose:
+    - "3000"
+  environment:
+    - NAME=Paul
+
+server-george:
+  build: ./server
+  links:
+    - redis
+  expose:
+    - "3000"
+  environment:
+    - NAME=George
+
+server-ringo:
+  build: ./server
+  links:
+    - redis
+  expose:
+    - "3000"
+  environment:
+    - NAME=Ringo
+
+redis:
+  image: redis:alpine
+  expose:
+    - "6379"
--- a/examples/cluster-haproxy/haproxy/Dockerfile
+++ b/examples/cluster-haproxy/haproxy/Dockerfile
@@ -0,0 +1,2 @@
+FROM haproxy:1.7-alpine
+COPY haproxy.cfg /usr/local/etc/haproxy/haproxy.cfg
--- a/examples/cluster-haproxy/haproxy/haproxy.cfg
+++ b/examples/cluster-haproxy/haproxy/haproxy.cfg
@@ -0,0 +1,31 @@
+# Reference: http://blog.haproxy.com/2012/11/07/websockets-load-balancing-with-haproxy/
+
+global
+  daemon
+  maxconn 4096
+  nbproc 2
+
+defaults
+  mode http
+  balance roundrobin
+  option http-server-close
+  timeout connect     5s
+  timeout client      30s
+  timeout client-fin  30s
+  timeout server      30s
+  timeout tunnel      1h
+  default-server inter 1s rise 2 fall 1 on-marked-down shutdown-sessions
+  option forwardfor
+
+listen chat
+  bind *:80
+  default_backend nodes
+
+backend nodes
+  option httpchk HEAD /health
+  http-check expect status 200
+  cookie serverid insert
+  server john    server-john:3000    cookie john   check
+  server paul    server-paul:3000    cookie paul   check
+  server george  server-george:3000  cookie george check
+  server ringo   server-ringo:3000   cookie ringo  check
--- a/examples/cluster-haproxy/server/Dockerfile
+++ b/examples/cluster-haproxy/server/Dockerfile
@@ -0,0 +1,15 @@
+FROM mhart/alpine-node:6
+
+# Create app directory
+RUN mkdir -p /usr/src/app
+WORKDIR /usr/src/app
+
+# Install app dependencies
+COPY package.json /usr/src/app/
+RUN npm install
+
+# Bundle app source
+COPY . /usr/src/app
+
+EXPOSE 3000
+CMD [ "npm", "start" ]
--- a/examples/cluster-haproxy/server/index.js
+++ b/examples/cluster-haproxy/server/index.js
@@ -0,0 +1,87 @@
+// Setup basic express server
+var express = require('express');
+var app = express();
+var server = require('http').createServer(app);
+var io = require('socket.io')(server);
+var redis = require('socket.io-redis');
+var port = process.env.PORT || 3000;
+var serverName = process.env.NAME || 'Unknown';
+
+io.adapter(redis({ host: 'redis', port: 6379 }));
+
+server.listen(port, function () {
+  console.log('Server listening at port %d', port);
+  console.log('Hello, I\'m %s, how can I help?', serverName);
+});
+
+// Routing
+app.use(express.static(__dirname + '/public'));
+
+// Health check
+app.head('/health', function (req, res) {
+  res.sendStatus(200);
+});
+
+// Chatroom
+
+var numUsers = 0;
+
+io.on('connection', function (socket) {
+  socket.emit('my-name-is', serverName);
+
+  var addedUser = false;
+
+  // when the client emits 'new message', this listens and executes
+  socket.on('new message', function (data) {
+    // we tell the client to execute 'new message'
+    socket.broadcast.emit('new message', {
+      username: socket.username,
+      message: data
+    });
+  });
+
+  // when the client emits 'add user', this listens and executes
+  socket.on('add user', function (username) {
+    if (addedUser) return;
+
+    // we store the username in the socket session for this client
+    socket.username = username;
+    ++numUsers;
+    addedUser = true;
+    socket.emit('login', {
+      numUsers: numUsers
+    });
+    // echo globally (all clients) that a person has connected
+    socket.broadcast.emit('user joined', {
+      username: socket.username,
+      numUsers: numUsers
+    });
+  });
+
+  // when the client emits 'typing', we broadcast it to others
+  socket.on('typing', function () {
+    socket.broadcast.emit('typing', {
+      username: socket.username
+    });
+  });
+
+  // when the client emits 'stop typing', we broadcast it to others
+  socket.on('stop typing', function () {
+    socket.broadcast.emit('stop typing', {
+      username: socket.username
+    });
+  });
+
+  // when the user disconnects.. perform this
+  socket.on('disconnect', function () {
+    if (addedUser) {
+      --numUsers;
+
+      // echo globally that this client has left
+      socket.broadcast.emit('user left', {
+        username: socket.username,
+        numUsers: numUsers
+      });
+    }
+  });
+});
--- a/examples/cluster-haproxy/server/package.json
+++ b/examples/cluster-haproxy/server/package.json
@@ -0,0 +1,17 @@
+{
+  "name": "socket.io-chat",
+  "version": "0.0.0",
+  "description": "A simple chat client using socket.io",
+  "main": "index.js",
+  "author": "Grant Timmerman",
+  "private": true,
+  "license": "BSD",
+  "dependencies": {
+    "express": "4.13.4",
+    "socket.io": "^1.7.2",
+    "socket.io-redis": "^3.0.0"
+  },
+  "scripts": {
+    "start": "node index.js"
+  }
+}
--- a/examples/cluster-haproxy/server/public/index.html
+++ b/examples/cluster-haproxy/server/public/index.html
@@ -0,0 +1,28 @@
+<!doctype html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <title>Socket.IO Chat Example</title>
+  <link rel="stylesheet" href="style.css">
+</head>
+<body>
+  <ul class="pages">
+    <li class="chat page">
+      <div class="chatArea">
+        <ul class="messages"></ul>
+      </div>
+      <input class="inputMessage" placeholder="Type here..."/>
+    </li>
+    <li class="login page">
+      <div class="form">
+        <h3 class="title">What's your nickname?</h3>
+        <input class="usernameInput" type="text" maxlength="14" />
+      </div>
+    </li>
+  </ul>
+
+  <script src="https://code.jquery.com/jquery-1.10.2.min.js"></script>
+  <script src="/socket.io/socket.io.js"></script>
+  <script src="/main.js"></script>
+</body>
+</html>
--- a/examples/cluster-haproxy/server/public/main.js
+++ b/examples/cluster-haproxy/server/public/main.js
@@ -0,0 +1,286 @@
+$(function() {
+  var FADE_TIME = 150; // ms
+  var TYPING_TIMER_LENGTH = 400; // ms
+  var COLORS = [
+    '#e21400', '#91580f', '#f8a700', '#f78b00',
+    '#58dc00', '#287b00', '#a8f07a', '#4ae8c4',
+    '#3b88eb', '#3824aa', '#a700ff', '#d300e7'
+  ];
+
+  // Initialize variables
+  var $window = $(window);
+  var $usernameInput = $('.usernameInput'); // Input for username
+  var $messages = $('.messages'); // Messages area
+  var $inputMessage = $('.inputMessage'); // Input message input box
+
+  var $loginPage = $('.login.page'); // The login page
+  var $chatPage = $('.chat.page'); // The chatroom page
+
+  // Prompt for setting a username
+  var username;
+  var connected = false;
+  var typing = false;
+  var lastTypingTime;
+  var $currentInput = $usernameInput.focus();
+
+  var socket = io();
+
+  function addParticipantsMessage (data) {
+    var message = '';
+    if (data.numUsers === 1) {
+      message += "there's 1 participant";
+    } else {
+      message += "there are " + data.numUsers + " participants";
+    }
+    log(message);
+  }
+
+  // Sets the client's username
+  function setUsername () {
+    username = cleanInput($usernameInput.val().trim());
+
+    // If the username is valid
+    if (username) {
+      $loginPage.fadeOut();
+      $chatPage.show();
+      $loginPage.off('click');
+      $currentInput = $inputMessage.focus();
+
+      // Tell the server your username
+      socket.emit('add user', username);
+    }
+  }
+
+  // Sends a chat message
+  function sendMessage () {
+    var message = $inputMessage.val();
+    // Prevent markup from being injected into the message
+    message = cleanInput(message);
+    // if there is a non-empty message and a socket connection
+    if (message && connected) {
+      $inputMessage.val('');
+      addChatMessage({
+        username: username,
+        message: message
+      });
+      // tell server to execute 'new message' and send along one parameter
+      socket.emit('new message', message);
+    }
+  }
+
+  // Log a message
+  function log (message, options) {
+    var $el = $('<li>').addClass('log').text(message);
+    addMessageElement($el, options);
+  }
+
+  // Adds the visual chat message to the message list
+  function addChatMessage (data, options) {
+    // Don't fade the message in if there is an 'X was typing'
+    var $typingMessages = getTypingMessages(data);
+    options = options || {};
+    if ($typingMessages.length !== 0) {
+      options.fade = false;
+      $typingMessages.remove();
+    }
+
+    var $usernameDiv = $('<span class="username"/>')
+      .text(data.username)
+      .css('color', getUsernameColor(data.username));
+    var $messageBodyDiv = $('<span class="messageBody">')
+      .text(data.message);
+
+    var typingClass = data.typing ? 'typing' : '';
+    var $messageDiv = $('<li class="message"/>')
+      .data('username', data.username)
+      .addClass(typingClass)
+      .append($usernameDiv, $messageBodyDiv);
+
+    addMessageElement($messageDiv, options);
+  }
+
+  // Adds the visual chat typing message
+  function addChatTyping (data) {
+    data.typing = true;
+    data.message = 'is typing';
+    addChatMessage(data);
+  }
+
+  // Removes the visual chat typing message
+  function removeChatTyping (data) {
+    getTypingMessages(data).fadeOut(function () {
+      $(this).remove();
+    });
+  }
+
+  // Adds a message element to the messages and scrolls to the bottom
+  // el - The element to add as a message
+  // options.fade - If the element should fade-in (default = true)
+  // options.prepend - If the element should prepend
+  //   all other messages (default = false)
+  function addMessageElement (el, options) {
+    var $el = $(el);
+
+    // Setup default options
+    if (!options) {
+      options = {};
+    }
+    if (typeof options.fade === 'undefined') {
+      options.fade = true;
+    }
+    if (typeof options.prepend === 'undefined') {
+      options.prepend = false;
+    }
+
+    // Apply options
+    if (options.fade) {
+      $el.hide().fadeIn(FADE_TIME);
+    }
+    if (options.prepend) {
+      $messages.prepend($el);
+    } else {
+      $messages.append($el);
+    }
+    $messages[0].scrollTop = $messages[0].scrollHeight;
+  }
+
+  // Prevents input from having injected markup
+  function cleanInput (input) {
+    return $('<div/>').text(input).text();
+  }
+
+  // Updates the typing event
+  function updateTyping () {
+    if (connected) {
+      if (!typing) {
+        typing = true;
+        socket.emit('typing');
+      }
+      lastTypingTime = (new Date()).getTime();
+
+      setTimeout(function () {
+        var typingTimer = (new Date()).getTime();
+        var timeDiff = typingTimer - lastTypingTime;
+        if (timeDiff >= TYPING_TIMER_LENGTH && typing) {
+          socket.emit('stop typing');
+          typing = false;
+        }
+      }, TYPING_TIMER_LENGTH);
+    }
+  }
+
+  // Gets the 'X is typing' messages of a user
+  function getTypingMessages (data) {
+    return $('.typing.message').filter(function (i) {
+      return $(this).data('username') === data.username;
+    });
+  }
+
+  // Gets the color of a username through our hash function
+  function getUsernameColor (username) {
+    // Compute hash code
+    var hash = 7;
+    for (var i = 0; i < username.length; i++) {
+       hash = username.charCodeAt(i) + (hash << 5) - hash;
+    }
+    // Calculate color
+    var index = Math.abs(hash % COLORS.length);
+    return COLORS[index];
+  }
+
+  // Keyboard events
+
+  $window.keydown(function (event) {
+    // Auto-focus the current input when a key is typed
+    if (!(event.ctrlKey || event.metaKey || event.altKey)) {
+      $currentInput.focus();
+    }
+    // When the client hits ENTER on their keyboard
+    if (event.which === 13) {
+      if (username) {
+        sendMessage();
+        socket.emit('stop typing');
+        typing = false;
+      } else {
+        setUsername();
+      }
+    }
+  });
+
+  $inputMessage.on('input', function() {
+    updateTyping();
+  });
+
+  // Click events
+
+  // Focus input when clicking anywhere on login page
+  $loginPage.click(function () {
+    $currentInput.focus();
+  });
+
+  // Focus input when clicking on the message input's border
+  $inputMessage.click(function () {
+    $inputMessage.focus();
+  });
+
+  // Socket events
+
+  // Whenever the server emits 'login', log the login message
+  socket.on('login', function (data) {
+    connected = true;
+    // Display the welcome message
+    var message = "Welcome to Socket.IO Chat – ";
+    log(message, {
+      prepend: true
+    });
+    addParticipantsMessage(data);
+  });
+
+  // Whenever the server emits 'new message', update the chat body
+  socket.on('new message', function (data) {
+    addChatMessage(data);
+  });
+
+  // Whenever the server emits 'user joined', log it in the chat body
+  socket.on('user joined', function (data) {
+    log(data.username + ' joined');
+    addParticipantsMessage(data);
+  });
+
+  // Whenever the server emits 'user left', log it in the chat body
+  socket.on('user left', function (data) {
+    log(data.username + ' left');
+    addParticipantsMessage(data);
+    removeChatTyping(data);
+  });
+
+  // Whenever the server emits 'typing', show the typing message
+  socket.on('typing', function (data) {
+    addChatTyping(data);
+  });
+
+  // Whenever the server emits 'stop typing', kill the typing message
+  socket.on('stop typing', function (data) {
+    removeChatTyping(data);
+  });
+
+  socket.on('disconnect', function () {
+    log('you have been disconnected');
+  });
+
+  socket.on('reconnect', function () {
+    log('you have been reconnected');
+    if (username) {
+      socket.emit('add user', username);
+    }
+  });
+
+  socket.on('reconnect_error', function () {
+    log('attempt to reconnect has failed');
+  });
+
+  socket.on('my-name-is', function (serverName) {
+    log('host is now ' + serverName);
+  })
+
+});
--- a/examples/cluster-haproxy/server/public/style.css
+++ b/examples/cluster-haproxy/server/public/style.css
@@ -0,0 +1,149 @@
+/* Fix user-agent */
+
+* {
+  box-sizing: border-box;
+}
+
+html {
+  font-weight: 300;
+  -webkit-font-smoothing: antialiased;
+}
+
+html, input {
+  font-family:
+    "HelveticaNeue-Light",
+    "Helvetica Neue Light",
+    "Helvetica Neue",
+    Helvetica,
+    Arial,
+    "Lucida Grande",
+    sans-serif;
+}
+
+html, body {
+  height: 100%;
+  margin: 0;
+  padding: 0;
+}
+
+ul {
+  list-style: none;
+  word-wrap: break-word;
+}
+
+/* Pages */
+
+.pages {
+  height: 100%;
+  margin: 0;
+  padding: 0;
+  width: 100%;
+}
+
+.page {
+  height: 100%;
+  position: absolute;
+  width: 100%;
+}
+
+/* Login Page */
+
+.login.page {
+  background-color: #000;
+}
+
+.login.page .form {
+  height: 100px;
+  margin-top: -100px;
+  position: absolute;
+
+  text-align: center;
+  top: 50%;
+  width: 100%;
+}
+
+.login.page .form .usernameInput {
+  background-color: transparent;
+  border: none;
+  border-bottom: 2px solid #fff;
+  outline: none;
+  padding-bottom: 15px;
+  text-align: center;
+  width: 400px;
+}
+
+.login.page .title {
+  font-size: 200%;
+}
+
+.login.page .usernameInput {
+  font-size: 200%;
+  letter-spacing: 3px;
+}
+
+.login.page .title, .login.page .usernameInput {
+  color: #fff;
+  font-weight: 100;
+}
+
+/* Chat page */
+
+.chat.page {
+  display: none;
+}
+
+/* Font */
+
+.messages {
+  font-size: 150%;
+}
+
+.inputMessage {
+  font-size: 100%;
+}
+
+.log {
+  color: gray;
+  font-size: 70%;
+  margin: 5px;
+  text-align: center;
+}
+
+/* Messages */
+
+.chatArea {
+  height: 100%;
+  padding-bottom: 60px;
+}
+
+.messages {
+  height: 100%;
+  margin: 0;
+  overflow-y: scroll;
+  padding: 10px 20px 10px 20px;
+}
+
+.message.typing .messageBody {
+  color: gray;
+}
+
+.username {
+  font-weight: 700;
+  overflow: hidden;
+  padding-right: 15px;
+  text-align: right;
+}
+
+/* Input */
+
+.inputMessage {
+  border: 10px solid #000;
+  bottom: 0;
+  height: 60px;
+  left: 0;
+  outline: none;
+  padding-left: 10px;
+  position: absolute;
+  right: 0;
+  width: 100%;
+}
--- a/examples/cluster-httpd/README.md
+++ b/examples/cluster-httpd/README.md
@@ -0,0 +1,31 @@
+
+# Socket.IO Chat with httpd & redis
+
+A simple chat demo for socket.io
+
+## How to use
+
+Install [Docker Compose](https://docs.docker.com/compose/install/), then:
+
+```
+$ docker-compose up -d
+```
+
+And then point your browser to `http://localhost:3000`.
+
+This will start four Socket.IO nodes, behind a httpd proxy which will loadbalance the requests (using a cookie for sticky sessions, see [cookie](http://httpd.apache.org/docs/2.4/fr/mod/mod_proxy_balancer.html)).
+
+Each node connects to the redis backend, which will enable to broadcast to every client, no matter which node it is currently connected to.
+
+```
+# you can kill a given node, the client should reconnect to another node
+$ docker-compose stop server-george
+```
+
+## Features
+
+- Multiple users can join a chat room by each entering a unique username
+on website load.
+- Users can type chat messages to the chat room.
+- A notification is sent to all users when a user joins or leaves
+the chatroom.
--- a/examples/cluster-httpd/docker-compose.yml
+++ b/examples/cluster-httpd/docker-compose.yml
@@ -0,0 +1,51 @@
+
+httpd:
+  build: ./httpd
+  links:
+    - server-john
+    - server-paul
+    - server-george
+    - server-ringo
+  ports:
+   - "3000:80"
+
+server-john:
+  build: ./server
+  links:
+    - redis
+  expose:
+    - "3000"
+  environment:
+    - NAME=John
+
+server-paul:
+  build: ./server
+  links:
+    - redis
+  expose:
+    - "3000"
+  environment:
+    - NAME=Paul
+
+server-george:
+  build: ./server
+  links:
+    - redis
+  expose:
+    - "3000"
+  environment:
+    - NAME=George
+
+server-ringo:
+  build: ./server
+  links:
+    - redis
+  expose:
+    - "3000"
+  environment:
+    - NAME=Ringo
+
+redis:
+  image: redis:alpine
+  expose:
+    - "6379"
--- a/examples/cluster-httpd/httpd/Dockerfile
+++ b/examples/cluster-httpd/httpd/Dockerfile
@@ -0,0 +1,2 @@
+FROM httpd:2.4-alpine
+COPY ./httpd.conf /usr/local/apache2/conf/httpd.conf
--- a/examples/cluster-httpd/httpd/httpd.conf
+++ b/examples/cluster-httpd/httpd/httpd.conf
@@ -0,0 +1,52 @@
+
+Listen 80
+
+ServerName localhost
+
+LoadModule authn_file_module            modules/mod_authn_file.so
+LoadModule authn_core_module            modules/mod_authn_core.so
+LoadModule authz_host_module            modules/mod_authz_host.so
+LoadModule authz_groupfile_module       modules/mod_authz_groupfile.so
+LoadModule authz_user_module            modules/mod_authz_user.so
+LoadModule authz_core_module            modules/mod_authz_core.so
+
+LoadModule headers_module               modules/mod_headers.so
+LoadModule lbmethod_byrequests_module   modules/mod_lbmethod_byrequests.so
+LoadModule proxy_module                 modules/mod_proxy.so
+LoadModule proxy_balancer_module        modules/mod_proxy_balancer.so
+LoadModule proxy_http_module            modules/mod_proxy_http.so
+LoadModule proxy_wstunnel_module        modules/mod_proxy_wstunnel.so
+LoadModule rewrite_module               modules/mod_rewrite.so
+LoadModule slotmem_shm_module           modules/mod_slotmem_shm.so
+LoadModule unixd_module                 modules/mod_unixd.so
+
+User daemon
+Group daemon
+
+ErrorLog /proc/self/fd/2
+
+Header add Set-Cookie "SERVERID=sticky.%{BALANCER_WORKER_ROUTE}e; path=/" env=BALANCER_ROUTE_CHANGED
+
+<Proxy "balancer://nodes_polling">
+    BalancerMember "http://server-john:3000"    route=john
+    BalancerMember "http://server-paul:3000"    route=paul
+    BalancerMember "http://server-george:3000"  route=george
+    BalancerMember "http://server-ringo:3000"   route=ringo
+    ProxySet stickysession=SERVERID
+</Proxy>
+
+<Proxy "balancer://nodes_ws">
+    BalancerMember "ws://server-john:3000"    route=john
+    BalancerMember "ws://server-paul:3000"    route=paul
+    BalancerMember "ws://server-george:3000"  route=george
+    BalancerMember "ws://server-ringo:3000"   route=ringo
+    ProxySet stickysession=SERVERID
+</Proxy>
+
+RewriteEngine On
+RewriteCond %{HTTP:Upgrade} =websocket [NC]
+RewriteRule /(.*) balancer://nodes_ws/$1 [P,L]
+RewriteCond %{HTTP:Upgrade} !=websocket [NC]
+RewriteRule /(.*) balancer://nodes_polling/$1 [P,L]
+
+ProxyTimeout 3
--- a/examples/cluster-httpd/server/Dockerfile
+++ b/examples/cluster-httpd/server/Dockerfile
@@ -0,0 +1,15 @@
+FROM mhart/alpine-node:6
+
+# Create app directory
+RUN mkdir -p /usr/src/app
+WORKDIR /usr/src/app
+
+# Install app dependencies
+COPY package.json /usr/src/app/
+RUN npm install
+
+# Bundle app source
+COPY . /usr/src/app
+
+EXPOSE 3000
+CMD [ "npm", "start" ]
--- a/examples/cluster-httpd/server/index.js
+++ b/examples/cluster-httpd/server/index.js
@@ -0,0 +1,82 @@
+// Setup basic express server
+var express = require('express');
+var app = express();
+var server = require('http').createServer(app);
+var io = require('socket.io')(server);
+var redis = require('socket.io-redis');
+var port = process.env.PORT || 3000;
+var serverName = process.env.NAME || 'Unknown';
+
+io.adapter(redis({ host: 'redis', port: 6379 }));
+
+server.listen(port, function () {
+  console.log('Server listening at port %d', port);
+  console.log('Hello, I\'m %s, how can I help?', serverName);
+});
+
+// Routing
+app.use(express.static(__dirname + '/public'));
+
+// Chatroom
+
+var numUsers = 0;
+
+io.on('connection', function (socket) {
+  socket.emit('my-name-is', serverName);
+
+  var addedUser = false;
+
+  // when the client emits 'new message', this listens and executes
+  socket.on('new message', function (data) {
+    // we tell the client to execute 'new message'
+    socket.broadcast.emit('new message', {
+      username: socket.username,
+      message: data
+    });
+  });
+
+  // when the client emits 'add user', this listens and executes
+  socket.on('add user', function (username) {
+    if (addedUser) return;
+
+    // we store the username in the socket session for this client
+    socket.username = username;
+    ++numUsers;
+    addedUser = true;
+    socket.emit('login', {
+      numUsers: numUsers
+    });
+    // echo globally (all clients) that a person has connected
+    socket.broadcast.emit('user joined', {
+      username: socket.username,
+      numUsers: numUsers
+    });
+  });
+
+  // when the client emits 'typing', we broadcast it to others
+  socket.on('typing', function () {
+    socket.broadcast.emit('typing', {
+      username: socket.username
+    });
+  });
+
+  // when the client emits 'stop typing', we broadcast it to others
+  socket.on('stop typing', function () {
+    socket.broadcast.emit('stop typing', {
+      username: socket.username
+    });
+  });
+
+  // when the user disconnects.. perform this
+  socket.on('disconnect', function () {
+    if (addedUser) {
+      --numUsers;
+
+      // echo globally that this client has left
+      socket.broadcast.emit('user left', {
+        username: socket.username,
+        numUsers: numUsers
+      });
+    }
+  });
+});
--- a/examples/cluster-httpd/server/package.json
+++ b/examples/cluster-httpd/server/package.json
@@ -0,0 +1,17 @@
+{
+  "name": "socket.io-chat",
+  "version": "0.0.0",
+  "description": "A simple chat client using socket.io",
+  "main": "index.js",
+  "author": "Grant Timmerman",
+  "private": true,
+  "license": "BSD",
+  "dependencies": {
+    "express": "4.13.4",
+    "socket.io": "^1.7.2",
+    "socket.io-redis": "^3.0.0"
+  },
+  "scripts": {
+    "start": "node index.js"
+  }
+}
--- a/examples/cluster-httpd/server/public/index.html
+++ b/examples/cluster-httpd/server/public/index.html
@@ -0,0 +1,28 @@
+<!doctype html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <title>Socket.IO Chat Example</title>
+  <link rel="stylesheet" href="style.css">
+</head>
+<body>
+  <ul class="pages">
+    <li class="chat page">
+      <div class="chatArea">
+        <ul class="messages"></ul>
+      </div>
+      <input class="inputMessage" placeholder="Type here..."/>
+    </li>
+    <li class="login page">
+      <div class="form">
+        <h3 class="title">What's your nickname?</h3>
+        <input class="usernameInput" type="text" maxlength="14" />
+      </div>
+    </li>
+  </ul>
+
+  <script src="https://code.jquery.com/jquery-1.10.2.min.js"></script>
+  <script src="/socket.io/socket.io.js"></script>
+  <script src="/main.js"></script>
+</body>
+</html>
--- a/examples/cluster-httpd/server/public/main.js
+++ b/examples/cluster-httpd/server/public/main.js
@@ -0,0 +1,286 @@
+$(function() {
+  var FADE_TIME = 150; // ms
+  var TYPING_TIMER_LENGTH = 400; // ms
+  var COLORS = [
+    '#e21400', '#91580f', '#f8a700', '#f78b00',
+    '#58dc00', '#287b00', '#a8f07a', '#4ae8c4',
+    '#3b88eb', '#3824aa', '#a700ff', '#d300e7'
+  ];
+
+  // Initialize variables
+  var $window = $(window);
+  var $usernameInput = $('.usernameInput'); // Input for username
+  var $messages = $('.messages'); // Messages area
+  var $inputMessage = $('.inputMessage'); // Input message input box
+
+  var $loginPage = $('.login.page'); // The login page
+  var $chatPage = $('.chat.page'); // The chatroom page
+
+  // Prompt for setting a username
+  var username;
+  var connected = false;
+  var typing = false;
+  var lastTypingTime;
+  var $currentInput = $usernameInput.focus();
+
+  var socket = io();
+
+  function addParticipantsMessage (data) {
+    var message = '';
+    if (data.numUsers === 1) {
+      message += "there's 1 participant";
+    } else {
+      message += "there are " + data.numUsers + " participants";
+    }
+    log(message);
+  }
+
+  // Sets the client's username
+  function setUsername () {
+    username = cleanInput($usernameInput.val().trim());
+
+    // If the username is valid
+    if (username) {
+      $loginPage.fadeOut();
+      $chatPage.show();
+      $loginPage.off('click');
+      $currentInput = $inputMessage.focus();
+
+      // Tell the server your username
+      socket.emit('add user', username);
+    }
+  }
+
+  // Sends a chat message
+  function sendMessage () {
+    var message = $inputMessage.val();
+    // Prevent markup from being injected into the message
+    message = cleanInput(message);
+    // if there is a non-empty message and a socket connection
+    if (message && connected) {
+      $inputMessage.val('');
+      addChatMessage({
+        username: username,
+        message: message
+      });
+      // tell server to execute 'new message' and send along one parameter
+      socket.emit('new message', message);
+    }
+  }
+
+  // Log a message
+  function log (message, options) {
+    var $el = $('<li>').addClass('log').text(message);
+    addMessageElement($el, options);
+  }
+
+  // Adds the visual chat message to the message list
+  function addChatMessage (data, options) {
+    // Don't fade the message in if there is an 'X was typing'
+    var $typingMessages = getTypingMessages(data);
+    options = options || {};
+    if ($typingMessages.length !== 0) {
+      options.fade = false;
+      $typingMessages.remove();
+    }
+
+    var $usernameDiv = $('<span class="username"/>')
+      .text(data.username)
+      .css('color', getUsernameColor(data.username));
+    var $messageBodyDiv = $('<span class="messageBody">')
+      .text(data.message);
+
+    var typingClass = data.typing ? 'typing' : '';
+    var $messageDiv = $('<li class="message"/>')
+      .data('username', data.username)
+      .addClass(typingClass)
+      .append($usernameDiv, $messageBodyDiv);
+
+    addMessageElement($messageDiv, options);
+  }
+
+  // Adds the visual chat typing message
+  function addChatTyping (data) {
+    data.typing = true;
+    data.message = 'is typing';
+    addChatMessage(data);
+  }
+
+  // Removes the visual chat typing message
+  function removeChatTyping (data) {
+    getTypingMessages(data).fadeOut(function () {
+      $(this).remove();
+    });
+  }
+
+  // Adds a message element to the messages and scrolls to the bottom
+  // el - The element to add as a message
+  // options.fade - If the element should fade-in (default = true)
+  // options.prepend - If the element should prepend
+  //   all other messages (default = false)
+  function addMessageElement (el, options) {
+    var $el = $(el);
+
+    // Setup default options
+    if (!options) {
+      options = {};
+    }
+    if (typeof options.fade === 'undefined') {
+      options.fade = true;
+    }
+    if (typeof options.prepend === 'undefined') {
+      options.prepend = false;
+    }
+
+    // Apply options
+    if (options.fade) {
+      $el.hide().fadeIn(FADE_TIME);
+    }
+    if (options.prepend) {
+      $messages.prepend($el);
+    } else {
+      $messages.append($el);
+    }
+    $messages[0].scrollTop = $messages[0].scrollHeight;
+  }
+
+  // Prevents input from having injected markup
+  function cleanInput (input) {
+    return $('<div/>').text(input).text();
+  }
+
+  // Updates the typing event
+  function updateTyping () {
+    if (connected) {
+      if (!typing) {
+        typing = true;
+        socket.emit('typing');
+      }
+      lastTypingTime = (new Date()).getTime();
+
+      setTimeout(function () {
+        var typingTimer = (new Date()).getTime();
+        var timeDiff = typingTimer - lastTypingTime;
+        if (timeDiff >= TYPING_TIMER_LENGTH && typing) {
+          socket.emit('stop typing');
+          typing = false;
+        }
+      }, TYPING_TIMER_LENGTH);
+    }
+  }
+
+  // Gets the 'X is typing' messages of a user
+  function getTypingMessages (data) {
+    return $('.typing.message').filter(function (i) {
+      return $(this).data('username') === data.username;
+    });
+  }
+
+  // Gets the color of a username through our hash function
+  function getUsernameColor (username) {
+    // Compute hash code
+    var hash = 7;
+    for (var i = 0; i < username.length; i++) {
+       hash = username.charCodeAt(i) + (hash << 5) - hash;
+    }
+    // Calculate color
+    var index = Math.abs(hash % COLORS.length);
+    return COLORS[index];
+  }
+
+  // Keyboard events
+
+  $window.keydown(function (event) {
+    // Auto-focus the current input when a key is typed
+    if (!(event.ctrlKey || event.metaKey || event.altKey)) {
+      $currentInput.focus();
+    }
+    // When the client hits ENTER on their keyboard
+    if (event.which === 13) {
+      if (username) {
+        sendMessage();
+        socket.emit('stop typing');
+        typing = false;
+      } else {
+        setUsername();
+      }
+    }
+  });
+
+  $inputMessage.on('input', function() {
+    updateTyping();
+  });
+
+  // Click events
+
+  // Focus input when clicking anywhere on login page
+  $loginPage.click(function () {
+    $currentInput.focus();
+  });
+
+  // Focus input when clicking on the message input's border
+  $inputMessage.click(function () {
+    $inputMessage.focus();
+  });
+
+  // Socket events
+
+  // Whenever the server emits 'login', log the login message
+  socket.on('login', function (data) {
+    connected = true;
+    // Display the welcome message
+    var message = "Welcome to Socket.IO Chat – ";
+    log(message, {
+      prepend: true
+    });
+    addParticipantsMessage(data);
+  });
+
+  // Whenever the server emits 'new message', update the chat body
+  socket.on('new message', function (data) {
+    addChatMessage(data);
+  });
+
+  // Whenever the server emits 'user joined', log it in the chat body
+  socket.on('user joined', function (data) {
+    log(data.username + ' joined');
+    addParticipantsMessage(data);
+  });
+
+  // Whenever the server emits 'user left', log it in the chat body
+  socket.on('user left', function (data) {
+    log(data.username + ' left');
+    addParticipantsMessage(data);
+    removeChatTyping(data);
+  });
+
+  // Whenever the server emits 'typing', show the typing message
+  socket.on('typing', function (data) {
+    addChatTyping(data);
+  });
+
+  // Whenever the server emits 'stop typing', kill the typing message
+  socket.on('stop typing', function (data) {
+    removeChatTyping(data);
+  });
+
+  socket.on('disconnect', function () {
+    log('you have been disconnected');
+  });
+
+  socket.on('reconnect', function () {
+    log('you have been reconnected');
+    if (username) {
+      socket.emit('add user', username);
+    }
+  });
+
+  socket.on('reconnect_error', function () {
+    log('attempt to reconnect has failed');
+  });
+
+  socket.on('my-name-is', function (serverName) {
+    log('host is now ' + serverName);
+  })
+
+});
--- a/examples/cluster-httpd/server/public/style.css
+++ b/examples/cluster-httpd/server/public/style.css
@@ -0,0 +1,149 @@
+/* Fix user-agent */
+
+* {
+  box-sizing: border-box;
+}
+
+html {
+  font-weight: 300;
+  -webkit-font-smoothing: antialiased;
+}
+
+html, input {
+  font-family:
+    "HelveticaNeue-Light",
+    "Helvetica Neue Light",
+    "Helvetica Neue",
+    Helvetica,
+    Arial,
+    "Lucida Grande",
+    sans-serif;
+}
+
+html, body {
+  height: 100%;
+  margin: 0;
+  padding: 0;
+}
+
+ul {
+  list-style: none;
+  word-wrap: break-word;
+}
+
+/* Pages */
+
+.pages {
+  height: 100%;
+  margin: 0;
+  padding: 0;
+  width: 100%;
+}
+
+.page {
+  height: 100%;
+  position: absolute;
+  width: 100%;
+}
+
+/* Login Page */
+
+.login.page {
+  background-color: #000;
+}
+
+.login.page .form {
+  height: 100px;
+  margin-top: -100px;
+  position: absolute;
+
+  text-align: center;
+  top: 50%;
+  width: 100%;
+}
+
+.login.page .form .usernameInput {
+  background-color: transparent;
+  border: none;
+  border-bottom: 2px solid #fff;
+  outline: none;
+  padding-bottom: 15px;
+  text-align: center;
+  width: 400px;
+}
+
+.login.page .title {
+  font-size: 200%;
+}
+
+.login.page .usernameInput {
+  font-size: 200%;
+  letter-spacing: 3px;
+}
+
+.login.page .title, .login.page .usernameInput {
+  color: #fff;
+  font-weight: 100;
+}
+
+/* Chat page */
+
+.chat.page {
+  display: none;
+}
+
+/* Font */
+
+.messages {
+  font-size: 150%;
+}
+
+.inputMessage {
+  font-size: 100%;
+}
+
+.log {
+  color: gray;
+  font-size: 70%;
+  margin: 5px;
+  text-align: center;
+}
+
+/* Messages */
+
+.chatArea {
+  height: 100%;
+  padding-bottom: 60px;
+}
+
+.messages {
+  height: 100%;
+  margin: 0;
+  overflow-y: scroll;
+  padding: 10px 20px 10px 20px;
+}
+
+.message.typing .messageBody {
+  color: gray;
+}
+
+.username {
+  font-weight: 700;
+  overflow: hidden;
+  padding-right: 15px;
+  text-align: right;
+}
+
+/* Input */
+
+.inputMessage {
+  border: 10px solid #000;
+  bottom: 0;
+  height: 60px;
+  left: 0;
+  outline: none;
+  padding-left: 10px;
+  position: absolute;
+  right: 0;
+  width: 100%;
+}
--- a/examples/cluster-nginx/README.md
+++ b/examples/cluster-nginx/README.md
@@ -0,0 +1,31 @@
+
+# Socket.IO Chat with nginx & redis
+
+A simple chat demo for socket.io
+
+## How to use
+
+Install [Docker Compose](https://docs.docker.com/compose/install/), then:
+
+```
+$ docker-compose up -d
+```
+
+And then point your browser to `http://localhost:3000`.
+
+This will start four Socket.IO nodes, behind a nginx proxy which will loadbalance the requests (using the IP of the client, see [ip_hash](http://nginx.org/en/docs/http/ngx_http_upstream_module.html#ip_hash)).
+
+Each node connects to the redis backend, which will enable to broadcast to every client, no matter which node it is currently connected to.
+
+```
+# you can kill a given node, the client should reconnect to another node
+$ docker-compose stop server-george
+```
+
+## Features
+
+- Multiple users can join a chat room by each entering a unique username
+on website load.
+- Users can type chat messages to the chat room.
+- A notification is sent to all users when a user joins or leaves
+the chatroom.
--- a/examples/cluster-nginx/docker-compose.yml
+++ b/examples/cluster-nginx/docker-compose.yml
@@ -0,0 +1,51 @@
+
+nginx:
+  build: ./nginx
+  links:
+    - server-john
+    - server-paul
+    - server-george
+    - server-ringo
+  ports:
+   - "3000:80"
+
+server-john:
+  build: ./server
+  links:
+    - redis
+  expose:
+    - "3000"
+  environment:
+    - NAME=John
+
+server-paul:
+  build: ./server
+  links:
+    - redis
+  expose:
+    - "3000"
+  environment:
+    - NAME=Paul
+
+server-george:
+  build: ./server
+  links:
+    - redis
+  expose:
+    - "3000"
+  environment:
+    - NAME=George
+
+server-ringo:
+  build: ./server
+  links:
+    - redis
+  expose:
+    - "3000"
+  environment:
+    - NAME=Ringo
+
+redis:
+  image: redis:alpine
+  expose:
+    - "6379"
--- a/examples/cluster-nginx/nginx/Dockerfile
+++ b/examples/cluster-nginx/nginx/Dockerfile
@@ -0,0 +1,3 @@
+
+FROM nginx:alpine
+COPY nginx.conf /etc/nginx/nginx.conf
--- a/examples/cluster-nginx/nginx/nginx.conf
+++ b/examples/cluster-nginx/nginx/nginx.conf
@@ -0,0 +1,35 @@
+# Reference: https://www.nginx.com/resources/wiki/start/topics/examples/full/
+
+worker_processes 4;
+
+events {
+  worker_connections 1024;
+}
+
+http {
+  server {
+    listen 80;
+
+    location / {
+      proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+      proxy_set_header Host $host;
+
+      proxy_pass http://nodes;
+
+      # enable WebSockets
+      proxy_http_version 1.1;
+      proxy_set_header Upgrade $http_upgrade;
+      proxy_set_header Connection "upgrade";
+    }
+  }
+
+  upstream nodes {
+    # enable sticky session
+    ip_hash;
+
+    server server-john:3000;
+    server server-paul:3000;
+    server server-george:3000;
+    server server-ringo:3000;
+  }
+}
--- a/examples/cluster-nginx/server/Dockerfile
+++ b/examples/cluster-nginx/server/Dockerfile
@@ -0,0 +1,15 @@
+FROM mhart/alpine-node:6
+
+# Create app directory
+RUN mkdir -p /usr/src/app
+WORKDIR /usr/src/app
+
+# Install app dependencies
+COPY package.json /usr/src/app/
+RUN npm install
+
+# Bundle app source
+COPY . /usr/src/app
+
+EXPOSE 3000
+CMD [ "npm", "start" ]
--- a/examples/cluster-nginx/server/index.js
+++ b/examples/cluster-nginx/server/index.js
@@ -0,0 +1,82 @@
+// Setup basic express server
+var express = require('express');
+var app = express();
+var server = require('http').createServer(app);
+var io = require('socket.io')(server);
+var redis = require('socket.io-redis');
+var port = process.env.PORT || 3000;
+var serverName = process.env.NAME || 'Unknown';
+
+io.adapter(redis({ host: 'redis', port: 6379 }));
+
+server.listen(port, function () {
+  console.log('Server listening at port %d', port);
+  console.log('Hello, I\'m %s, how can I help?', serverName);
+});
+
+// Routing
+app.use(express.static(__dirname + '/public'));
+
+// Chatroom
+
+var numUsers = 0;
+
+io.on('connection', function (socket) {
+  socket.emit('my-name-is', serverName);
+
+  var addedUser = false;
+
+  // when the client emits 'new message', this listens and executes
+  socket.on('new message', function (data) {
+    // we tell the client to execute 'new message'
+    socket.broadcast.emit('new message', {
+      username: socket.username,
+      message: data
+    });
+  });
+
+  // when the client emits 'add user', this listens and executes
+  socket.on('add user', function (username) {
+    if (addedUser) return;
+
+    // we store the username in the socket session for this client
+    socket.username = username;
+    ++numUsers;
+    addedUser = true;
+    socket.emit('login', {
+      numUsers: numUsers
+    });
+    // echo globally (all clients) that a person has connected
+    socket.broadcast.emit('user joined', {
+      username: socket.username,
+      numUsers: numUsers
+    });
+  });
+
+  // when the client emits 'typing', we broadcast it to others
+  socket.on('typing', function () {
+    socket.broadcast.emit('typing', {
+      username: socket.username
+    });
+  });
+
+  // when the client emits 'stop typing', we broadcast it to others
+  socket.on('stop typing', function () {
+    socket.broadcast.emit('stop typing', {
+      username: socket.username
+    });
+  });
+
+  // when the user disconnects.. perform this
+  socket.on('disconnect', function () {
+    if (addedUser) {
+      --numUsers;
+
+      // echo globally that this client has left
+      socket.broadcast.emit('user left', {
+        username: socket.username,
+        numUsers: numUsers
+      });
+    }
+  });
+});
--- a/examples/cluster-nginx/server/package.json
+++ b/examples/cluster-nginx/server/package.json
@@ -0,0 +1,17 @@
+{
+  "name": "socket.io-chat",
+  "version": "0.0.0",
+  "description": "A simple chat client using socket.io",
+  "main": "index.js",
+  "author": "Grant Timmerman",
+  "private": true,
+  "license": "MIT",
+  "dependencies": {
+    "express": "4.13.4",
+    "socket.io": "^1.7.2",
+    "socket.io-redis": "^3.0.0"
+  },
+  "scripts": {
+    "start": "node index.js"
+  }
+}
--- a/examples/cluster-nginx/server/public/index.html
+++ b/examples/cluster-nginx/server/public/index.html
@@ -0,0 +1,28 @@
+<!doctype html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <title>Socket.IO Chat Example</title>
+  <link rel="stylesheet" href="style.css">
+</head>
+<body>
+  <ul class="pages">
+    <li class="chat page">
+      <div class="chatArea">
+        <ul class="messages"></ul>
+      </div>
+      <input class="inputMessage" placeholder="Type here..."/>
+    </li>
+    <li class="login page">
+      <div class="form">
+        <h3 class="title">What's your nickname?</h3>
+        <input class="usernameInput" type="text" maxlength="14" />
+      </div>
+    </li>
+  </ul>
+
+  <script src="https://code.jquery.com/jquery-1.10.2.min.js"></script>
+  <script src="/socket.io/socket.io.js"></script>
+  <script src="/main.js"></script>
+</body>
+</html>
--- a/examples/cluster-nginx/server/public/main.js
+++ b/examples/cluster-nginx/server/public/main.js
@@ -0,0 +1,286 @@
+$(function() {
+  var FADE_TIME = 150; // ms
+  var TYPING_TIMER_LENGTH = 400; // ms
+  var COLORS = [
+    '#e21400', '#91580f', '#f8a700', '#f78b00',
+    '#58dc00', '#287b00', '#a8f07a', '#4ae8c4',
+    '#3b88eb', '#3824aa', '#a700ff', '#d300e7'
+  ];
+
+  // Initialize variables
+  var $window = $(window);
+  var $usernameInput = $('.usernameInput'); // Input for username
+  var $messages = $('.messages'); // Messages area
+  var $inputMessage = $('.inputMessage'); // Input message input box
+
+  var $loginPage = $('.login.page'); // The login page
+  var $chatPage = $('.chat.page'); // The chatroom page
+
+  // Prompt for setting a username
+  var username;
+  var connected = false;
+  var typing = false;
+  var lastTypingTime;
+  var $currentInput = $usernameInput.focus();
+
+  var socket = io();
+
+  function addParticipantsMessage (data) {
+    var message = '';
+    if (data.numUsers === 1) {
+      message += "there's 1 participant";
+    } else {
+      message += "there are " + data.numUsers + " participants";
+    }
+    log(message);
+  }
+
+  // Sets the client's username
+  function setUsername () {
+    username = cleanInput($usernameInput.val().trim());
+
+    // If the username is valid
+    if (username) {
+      $loginPage.fadeOut();
+      $chatPage.show();
+      $loginPage.off('click');
+      $currentInput = $inputMessage.focus();
+
+      // Tell the server your username
+      socket.emit('add user', username);
+    }
+  }
+
+  // Sends a chat message
+  function sendMessage () {
+    var message = $inputMessage.val();
+    // Prevent markup from being injected into the message
+    message = cleanInput(message);
+    // if there is a non-empty message and a socket connection
+    if (message && connected) {
+      $inputMessage.val('');
+      addChatMessage({
+        username: username,
+        message: message
+      });
+      // tell server to execute 'new message' and send along one parameter
+      socket.emit('new message', message);
+    }
+  }
+
+  // Log a message
+  function log (message, options) {
+    var $el = $('<li>').addClass('log').text(message);
+    addMessageElement($el, options);
+  }
+
+  // Adds the visual chat message to the message list
+  function addChatMessage (data, options) {
+    // Don't fade the message in if there is an 'X was typing'
+    var $typingMessages = getTypingMessages(data);
+    options = options || {};
+    if ($typingMessages.length !== 0) {
+      options.fade = false;
+      $typingMessages.remove();
+    }
+
+    var $usernameDiv = $('<span class="username"/>')
+      .text(data.username)
+      .css('color', getUsernameColor(data.username));
+    var $messageBodyDiv = $('<span class="messageBody">')
+      .text(data.message);
+
+    var typingClass = data.typing ? 'typing' : '';
+    var $messageDiv = $('<li class="message"/>')
+      .data('username', data.username)
+      .addClass(typingClass)
+      .append($usernameDiv, $messageBodyDiv);
+
+    addMessageElement($messageDiv, options);
+  }
+
+  // Adds the visual chat typing message
+  function addChatTyping (data) {
+    data.typing = true;
+    data.message = 'is typing';
+    addChatMessage(data);
+  }
+
+  // Removes the visual chat typing message
+  function removeChatTyping (data) {
+    getTypingMessages(data).fadeOut(function () {
+      $(this).remove();
+    });
+  }
+
+  // Adds a message element to the messages and scrolls to the bottom
+  // el - The element to add as a message
+  // options.fade - If the element should fade-in (default = true)
+  // options.prepend - If the element should prepend
+  //   all other messages (default = false)
+  function addMessageElement (el, options) {
+    var $el = $(el);
+
+    // Setup default options
+    if (!options) {
+      options = {};
+    }
+    if (typeof options.fade === 'undefined') {
+      options.fade = true;
+    }
+    if (typeof options.prepend === 'undefined') {
+      options.prepend = false;
+    }
+
+    // Apply options
+    if (options.fade) {
+      $el.hide().fadeIn(FADE_TIME);
+    }
+    if (options.prepend) {
+      $messages.prepend($el);
+    } else {
+      $messages.append($el);
+    }
+    $messages[0].scrollTop = $messages[0].scrollHeight;
+  }
+
+  // Prevents input from having injected markup
+  function cleanInput (input) {
+    return $('<div/>').text(input).text();
+  }
+
+  // Updates the typing event
+  function updateTyping () {
+    if (connected) {
+      if (!typing) {
+        typing = true;
+        socket.emit('typing');
+      }
+      lastTypingTime = (new Date()).getTime();
+
+      setTimeout(function () {
+        var typingTimer = (new Date()).getTime();
+        var timeDiff = typingTimer - lastTypingTime;
+        if (timeDiff >= TYPING_TIMER_LENGTH && typing) {
+          socket.emit('stop typing');
+          typing = false;
+        }
+      }, TYPING_TIMER_LENGTH);
+    }
+  }
+
+  // Gets the 'X is typing' messages of a user
+  function getTypingMessages (data) {
+    return $('.typing.message').filter(function (i) {
+      return $(this).data('username') === data.username;
+    });
+  }
+
+  // Gets the color of a username through our hash function
+  function getUsernameColor (username) {
+    // Compute hash code
+    var hash = 7;
+    for (var i = 0; i < username.length; i++) {
+       hash = username.charCodeAt(i) + (hash << 5) - hash;
+    }
+    // Calculate color
+    var index = Math.abs(hash % COLORS.length);
+    return COLORS[index];
+  }
+
+  // Keyboard events
+
+  $window.keydown(function (event) {
+    // Auto-focus the current input when a key is typed
+    if (!(event.ctrlKey || event.metaKey || event.altKey)) {
+      $currentInput.focus();
+    }
+    // When the client hits ENTER on their keyboard
+    if (event.which === 13) {
+      if (username) {
+        sendMessage();
+        socket.emit('stop typing');
+        typing = false;
+      } else {
+        setUsername();
+      }
+    }
+  });
+
+  $inputMessage.on('input', function() {
+    updateTyping();
+  });
+
+  // Click events
+
+  // Focus input when clicking anywhere on login page
+  $loginPage.click(function () {
+    $currentInput.focus();
+  });
+
+  // Focus input when clicking on the message input's border
+  $inputMessage.click(function () {
+    $inputMessage.focus();
+  });
+
+  // Socket events
+
+  // Whenever the server emits 'login', log the login message
+  socket.on('login', function (data) {
+    connected = true;
+    // Display the welcome message
+    var message = "Welcome to Socket.IO Chat – ";
+    log(message, {
+      prepend: true
+    });
+    addParticipantsMessage(data);
+  });
+
+  // Whenever the server emits 'new message', update the chat body
+  socket.on('new message', function (data) {
+    addChatMessage(data);
+  });
+
+  // Whenever the server emits 'user joined', log it in the chat body
+  socket.on('user joined', function (data) {
+    log(data.username + ' joined');
+    addParticipantsMessage(data);
+  });
+
+  // Whenever the server emits 'user left', log it in the chat body
+  socket.on('user left', function (data) {
+    log(data.username + ' left');
+    addParticipantsMessage(data);
+    removeChatTyping(data);
+  });
+
+  // Whenever the server emits 'typing', show the typing message
+  socket.on('typing', function (data) {
+    addChatTyping(data);
+  });
+
+  // Whenever the server emits 'stop typing', kill the typing message
+  socket.on('stop typing', function (data) {
+    removeChatTyping(data);
+  });
+
+  socket.on('disconnect', function () {
+    log('you have been disconnected');
+  });
+
+  socket.on('reconnect', function () {
+    log('you have been reconnected');
+    if (username) {
+      socket.emit('add user', username);
+    }
+  });
+
+  socket.on('reconnect_error', function () {
+    log('attempt to reconnect has failed');
+  });
+
+  socket.on('my-name-is', function (serverName) {
+    log('host is now ' + serverName);
+  })
+
+});
--- a/examples/cluster-nginx/server/public/style.css
+++ b/examples/cluster-nginx/server/public/style.css
@@ -0,0 +1,149 @@
+/* Fix user-agent */
+
+* {
+  box-sizing: border-box;
+}
+
+html {
+  font-weight: 300;
+  -webkit-font-smoothing: antialiased;
+}
+
+html, input {
+  font-family:
+    "HelveticaNeue-Light",
+    "Helvetica Neue Light",
+    "Helvetica Neue",
+    Helvetica,
+    Arial,
+    "Lucida Grande",
+    sans-serif;
+}
+
+html, body {
+  height: 100%;
+  margin: 0;
+  padding: 0;
+}
+
+ul {
+  list-style: none;
+  word-wrap: break-word;
+}
+
+/* Pages */
+
+.pages {
+  height: 100%;
+  margin: 0;
+  padding: 0;
+  width: 100%;
+}
+
+.page {
+  height: 100%;
+  position: absolute;
+  width: 100%;
+}
+
+/* Login Page */
+
+.login.page {
+  background-color: #000;
+}
+
+.login.page .form {
+  height: 100px;
+  margin-top: -100px;
+  position: absolute;
+
+  text-align: center;
+  top: 50%;
+  width: 100%;
+}
+
+.login.page .form .usernameInput {
+  background-color: transparent;
+  border: none;
+  border-bottom: 2px solid #fff;
+  outline: none;
+  padding-bottom: 15px;
+  text-align: center;
+  width: 400px;
+}
+
+.login.page .title {
+  font-size: 200%;
+}
+
+.login.page .usernameInput {
+  font-size: 200%;
+  letter-spacing: 3px;
+}
+
+.login.page .title, .login.page .usernameInput {
+  color: #fff;
+  font-weight: 100;
+}
+
+/* Chat page */
+
+.chat.page {
+  display: none;
+}
+
+/* Font */
+
+.messages {
+  font-size: 150%;
+}
+
+.inputMessage {
+  font-size: 100%;
+}
+
+.log {
+  color: gray;
+  font-size: 70%;
+  margin: 5px;
+  text-align: center;
+}
+
+/* Messages */
+
+.chatArea {
+  height: 100%;
+  padding-bottom: 60px;
+}
+
+.messages {
+  height: 100%;
+  margin: 0;
+  overflow-y: scroll;
+  padding: 10px 20px 10px 20px;
+}
+
+.message.typing .messageBody {
+  color: gray;
+}
+
+.username {
+  font-weight: 700;
+  overflow: hidden;
+  padding-right: 15px;
+  text-align: right;
+}
+
+/* Input */
+
+.inputMessage {
+  border: 10px solid #000;
+  bottom: 0;
+  height: 60px;
+  left: 0;
+  outline: none;
+  padding-left: 10px;
+  position: absolute;
+  right: 0;
+  width: 100%;
+}
--- a/examples/custom-parsers/README.md
+++ b/examples/custom-parsers/README.md
@@ -0,0 +1,50 @@
+
+# Socket.IO custom parsers
+
+Since Socket.IO version 2.0.0, you can provide your custom parser, according to the needs of your application.
+
+Several parsers are showcased here:
+
+- the default one: [socket.io-parser](https://github.com/socketio/socket.io-parser)
+- one based on msgpack: [socket.io-msgpack-parser](https://github.com/darrachequesne/socket.io-msgpack-parser)
+- one based on native JSON: [socket.io-json-parser](https://github.com/darrachequesne/socket.io-json-parser)
+- a custom one based on [schemapack](https://github.com/phretaddin/schemapack)
+
+They are tested with various payloads:
+
+- string: `['1', '2', ... '1000']`
+- numeric: `[1, 2, ... 1000]`
+- binary: `Buffer.allocUnsafe(1000), where buf[i] = i`
+
+## How to use
+
+```
+$ npm i && npm start
+```
+
+## Results
+
+| bytes / packet | CONNECT packet | string | numeric | binary    |
+|----------------|----------------|--------|---------|-----------|
+| default        | 1              | 5903   | 3904    | 43 + 1000 |
+| msgpack        | 20             | 3919   | 2646    | 1029      |
+| JSON           | 20             | 5930   | 3931    | 3625      |
+| schemapack     | 20             | 3895   | 2005    | 1005      |
+
+## Comparison
+
+`default parser`
+- supports any serializable datastructure, including Blob and File
+- **but** binary payload is encoded as 2 packets
+
+`msgpack`
+- the size of payloads containing mostly numeric values will be greatly reduced
+- **but** rely on [ArrayBuffer](https://caniuse.com/#feat=typedarrays) in the browser (IE > 9)
+
+`JSON`
+- optimized
+- **but** does not support binary payloads
+
+`schemapack`
+- the most efficient in both speed and size
+- **but** you have to provide a schema for each packet
--- a/examples/custom-parsers/package.json
+++ b/examples/custom-parsers/package.json
@@ -0,0 +1,21 @@
+{
+  "name": "parsers",
+  "version": "1.0.0",
+  "description": "Various socket.io parsers",
+  "scripts": {
+    "build": "webpack --config ./support/webpack.config.js",
+    "start": "npm run build && node ./src/server.js"
+  },
+  "author": "Damien Arrachequesne",
+  "license": "MIT",
+  "dependencies": {
+    "component-emitter": "^1.2.1",
+    "express": "^4.15.2",
+    "schemapack": "^1.4.2",
+    "socket.io": "socketio/socket.io",
+    "socket.io-client": "socketio/socket.io-client",
+    "socket.io-json-parser": "^1.0.0",
+    "socket.io-msgpack-parser": "^1.0.0",
+    "webpack": "^2.4.1"
+  }
+}
--- a/examples/custom-parsers/public/index.html
+++ b/examples/custom-parsers/public/index.html
@@ -0,0 +1,13 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8">
+    <title>Socket.IO custom parsers</title>
+  </head>
+  <body>
+    <script src="client1.bundle.js"></script>
+    <script src="client2.bundle.js"></script>
+    <script src="client3.bundle.js"></script>
+    <script src="client4.bundle.js"></script>
+  </body>
+</html>
--- a/examples/custom-parsers/src/client1.js
+++ b/examples/custom-parsers/src/client1.js
@@ -0,0 +1,8 @@
+
+const socket = require('socket.io-client')('localhost:3001', {});
+
+socket.io.engine.on('data', (data) => console.log('[default]' + ' size= ' + (typeof data === 'string' ? data.length : data.byteLength)));
+
+socket.on('string', (data) => console.log('[default] [string]', data));
+socket.on('numeric', (data) => console.log('[default] [numeric]', data));
+socket.on('binary', (data) => console.log('[default] [binary]', data));
--- a/examples/custom-parsers/src/client2.js
+++ b/examples/custom-parsers/src/client2.js
@@ -0,0 +1,11 @@
+
+const customParser = require('socket.io-msgpack-parser');
+const socket = require('socket.io-client')('http://localhost:3002', {
+  parser: customParser
+});
+
+socket.io.engine.on('data', (data) => console.log('[msgpack]' + ' size= ' + (typeof data === 'string' ? data.length : data.byteLength)));
+
+socket.on('string', (data) => console.log('[msgpack] [string]', data));
+socket.on('numeric', (data) => console.log('[msgpack] [numeric]', data));
+socket.on('binary', (data) => console.log('[msgpack] [binary]', data));
--- a/examples/custom-parsers/src/client3.js
+++ b/examples/custom-parsers/src/client3.js
@@ -0,0 +1,11 @@
+
+const customParser = require('socket.io-json-parser');
+const socket = require('socket.io-client')('localhost:3003', {
+  parser: customParser
+});
+
+socket.io.engine.on('data', (data) => console.log('[json]' + ' size= ' + (typeof data === 'string' ? data.length : data.byteLength)));
+
+socket.on('string', (data) => console.log('[json] [string]', data));
+socket.on('numeric', (data) => console.log('[json] [numeric]', data));
+socket.on('binary', (data) => console.log('[json] [binary]', data));
--- a/examples/custom-parsers/src/client4.js
+++ b/examples/custom-parsers/src/client4.js
@@ -0,0 +1,11 @@
+
+const customParser = require('./custom-parser');
+const socket = require('socket.io-client')('localhost:3004', {
+  parser: customParser
+});
+
+socket.io.engine.on('data', (data) => console.log('[custom]' + ' size= ' + (typeof data === 'string' ? data.length : data.byteLength)));
+
+socket.on('string', (data) => console.log('[custom] [string]', data));
+socket.on('numeric', (data) => console.log('[custom] [numeric]', data));
+socket.on('binary', (data) => console.log('[custom] [binary]', data));
--- a/examples/custom-parsers/src/custom-parser.js
+++ b/examples/custom-parsers/src/custom-parser.js
@@ -0,0 +1,125 @@
+
+const Emitter = require('component-emitter');
+const schemapack = require('schemapack');
+
+/**
+ * Packet types (see https://github.com/socketio/socket.io-protocol)
+ */
+
+const TYPES = {
+  CONNECT: 0,
+  DISCONNECT: 1,
+  EVENT: 2,
+  ACK: 3,
+  ERROR: 4,
+  BINARY_EVENT: 5,
+  BINARY_ACK: 6
+};
+
+const stringSchema = schemapack.build({
+  _id: 'uint8',
+  data: [ 'string' ],
+  nsp: 'string'
+});
+
+const numericSchema = schemapack.build({
+  _id: 'uint8',
+  data: [ 'uint16' ],
+  nsp: 'string'
+});
+
+const binarySchema = schemapack.build({
+  _id: 'uint8',
+  data: 'buffer',
+  nsp: 'string'
+});
+
+const errorPacket = {
+  type: TYPES.ERROR,
+  data: 'parser error'
+};
+
+class Encoder {
+  encode (packet, callback) {
+    switch (packet.type) {
+      case TYPES.EVENT:
+        return callback([ this.pack(packet) ]);
+      default:
+        return callback([ JSON.stringify(packet) ]);
+    }
+  }
+  pack (packet) {
+    let eventName = packet.data[0];
+    let flatPacket = {
+      data: packet.data[1],
+      nsp: packet.nsp
+    };
+    switch (eventName) {
+      case 'string':
+        flatPacket._id = 1;
+        return stringSchema.encode(flatPacket);
+      case 'numeric':
+        flatPacket._id = 2;
+        return numericSchema.encode(flatPacket);
+      case 'binary':
+        flatPacket._id = 3;
+        return binarySchema.encode(flatPacket);
+      default:
+        throw new Error('unknown event name: ' + eventName);
+    }
+  }
+}
+
+class Decoder extends Emitter {
+  add (obj) {
+    if (typeof obj === 'string') {
+      this.parseJSON(obj);
+    } else {
+      this.parseBinary(obj);
+    }
+  }
+  parseJSON (obj) {
+    try {
+      let decoded = JSON.parse(obj);
+      this.emit('decoded', decoded);
+    } catch (e) {
+      this.emit('decoded', errorPacket);
+    }
+  }
+  parseBinary (obj) {
+    let view = new Uint8Array(obj);
+    let packetId = view[0];
+    try {
+      let packet = {
+        type: TYPES.EVENT
+      };
+      let decoded;
+      switch (packetId) {
+        case 1:
+          decoded = stringSchema.decode(obj);
+          packet.data = [ 'string', decoded.data ];
+          packet.nsp = decoded.nsp;
+          break;
+        case 2:
+          decoded = numericSchema.decode(obj);
+          packet.data = [ 'numeric', decoded.data ];
+          packet.nsp = decoded.nsp;
+          break;
+        case 3:
+          decoded = binarySchema.decode(obj);
+          packet.data = [ 'binary', decoded.data.buffer ];
+          packet.nsp = decoded.nsp;
+          break;
+        default:
+          throw new Error('unknown type');
+      }
+      this.emit('decoded', packet);
+    } catch (e) {
+      this.emit('decoded', errorPacket);
+    }
+  }
+  destroy () {}
+}
+
+exports.Encoder = Encoder;
+exports.Decoder = Decoder;
--- a/examples/custom-parsers/src/server.js
+++ b/examples/custom-parsers/src/server.js
@@ -0,0 +1,55 @@
+
+const express = require('express');
+const app = express();
+const server = require('http').createServer(app);
+const path = require('path');
+const port = process.env.PORT || 3000;
+
+app.use(express.static(path.join(__dirname, '../public')));
+
+server.listen(port, () => console.log('>>> http://localhost:' + port));
+
+const io = require('socket.io');
+const msgpackParser = require('socket.io-msgpack-parser');
+const jsonParser = require('socket.io-json-parser');
+const customParser = require('./custom-parser');
+
+let server1 = io(3001, {});
+let server2 = io(3002, {
+  parser: msgpackParser
+});
+let server3 = io(3003, {
+  parser: jsonParser
+});
+let server4 = io(3004, {
+  parser: customParser
+});
+
+let string = [];
+let numeric = [];
+let binary = Buffer.allocUnsafe(1e3);
+for (var i = 0; i < 1e3; i++) {
+  string.push('' + i);
+  numeric.push(i);
+  binary[i] = i;
+}
+
+server1.on('connect', onConnect(1000));
+server2.on('connect', onConnect(2000));
+server3.on('connect', onConnect(3000));
+server4.on('connect', onConnect(4000));
+
+function onConnect (delay) {
+  return function (socket) {
+    console.log('connect ' + socket.id);
+
+    setTimeout(() => {
+      socket.emit('string', string);
+      socket.emit('numeric', numeric);
+      socket.emit('binary', binary);
+    }, delay);
+
+    socket.on('disconnect', () => console.log('disconnect ' + socket.id));
+  };
+}
+
--- a/examples/custom-parsers/support/webpack.config.js
+++ b/examples/custom-parsers/support/webpack.config.js
@@ -0,0 +1,15 @@
+
+const path = require('path');
+
+module.exports = {
+  entry: {
+    client1: './src/client1.js',
+    client2: './src/client2.js',
+    client3: './src/client3.js',
+    client4: './src/client4.js'
+  },
+  output: {
+    path: path.resolve(__dirname, '../public'),
+    filename: '[name].bundle.js'
+  }
+};
--- a/examples/webpack-build-server/README.md
+++ b/examples/webpack-build-server/README.md
@@ -0,0 +1,18 @@
+
+# Socket.IO WebPack build
+
+A sample Webpack build for the server.
+
+## How to use
+
+```
+$ npm i
+$ npm run build
+$ npm start
+```
+
+**Note:**
+
+- the `bufferutil` and `utf-8-validate` are optional dependencies from `ws`, compiled from native code, which are meant to improve performance ([ref](https://github.com/websockets/ws#opt-in-for-performance)). You can also omit them, as they have their JS fallback, and ignore the WebPack warning.
+
+- the server is initiated with `serveClient` set to `false`, so it will not serve the client file.
--- a/examples/webpack-build-server/lib/index.js
+++ b/examples/webpack-build-server/lib/index.js
@@ -0,0 +1,16 @@
+
+const server = require('http').createServer();
+const io = require('socket.io')(server, {
+  serveClient: false,
+  wsEngine: 'ws' // uws is not supported since it is a native module
+});
+const port = process.env.PORT || 3000;
+
+io.on('connect', onConnect);
+server.listen(port, () => console.log('server listening on port ' + port));
+
+function onConnect(socket){
+  console.log('connect ' + socket.id);
+
+  socket.on('disconnect', () => console.log('disconnect ' + socket.id));
+}
--- a/examples/webpack-build-server/package.json
+++ b/examples/webpack-build-server/package.json
@@ -0,0 +1,15 @@
+{
+  "name": "webpack-build-server",
+  "version": "1.0.0",
+  "description": "A sample Webpack build (for the server)",
+  "scripts": {
+    "start": "node dist/server.js",
+    "build": "webpack --config ./support/webpack.config.js"
+  },
+  "author": "Damien Arrachequesne",
+  "license": "MIT",
+  "devDependencies": {
+    "socket.io": "^2.0.3",
+    "webpack": "^2.6.1"
+  }
+}
--- a/examples/webpack-build-server/support/webpack.config.js
+++ b/examples/webpack-build-server/support/webpack.config.js
@@ -0,0 +1,9 @@
+
+module.exports = {
+  entry: './lib/index.js',
+  target: 'node',
+  output: {
+    path: require('path').join(__dirname, '../dist'),
+    filename: 'server.js'
+  }
+};
--- a/examples/webpack-build/README.md
+++ b/examples/webpack-build/README.md
@@ -0,0 +1,20 @@
+
+# Socket.IO WebPack build
+
+A sample Webpack build for the browser.
+
+## How to use
+
+```
+$ npm i
+$ npm run build-all
+```
+
+There are two WebPack configuration:
+
+- the minimal configuration, just bundling the application and its dependencies. The `app.js` file in the `dist` folder is the result of that build.
+
+- a slimmer one, where:
+  - the JSON polyfill needed for IE6/IE7 support has been removed.
+  - the `debug` calls and import have been removed (the [debug](https://github.com/visionmedia/debug) library is included in the build by default).
+  - the source has been uglified (dropping IE8 support), and an associated SourceMap has been generated.
--- a/examples/webpack-build/index.html
+++ b/examples/webpack-build/index.html
@@ -0,0 +1,13 @@
+<!doctype html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <title>Socket.IO WebPack Example</title>
+</head>
+<body>
+
+  <!-- <script src="dist/app.js"></script> -->
+  <script src="dist/app.slim.js"></script>
+
+</body>
+</html>
--- a/examples/webpack-build/lib/index.js
+++ b/examples/webpack-build/lib/index.js
@@ -0,0 +1,12 @@
+
+import io from 'socket.io-client';
+
+const socket = io('http://localhost:3000');
+
+console.log('init');
+
+socket.on('connect', onConnect);
+
+function onConnect(){
+  console.log('connect ' + socket.id);
+}
--- a/examples/webpack-build/package.json
+++ b/examples/webpack-build/package.json
@@ -0,0 +1,21 @@
+{
+  "name": "webpack-build",
+  "version": "1.0.0",
+  "description": "A sample Webpack build",
+  "scripts": {
+    "build": "webpack --config ./support/webpack.config.js",
+    "build-slim": "webpack --config ./support/webpack.config.slim.js",
+    "build-json-parser": "webpack --config ./support/webpack.config.json-parser.js",
+    "build-all": "npm run build && npm run build-slim && npm run build-json-parser"
+  },
+  "author": "Damien Arrachequesne",
+  "license": "MIT",
+  "dependencies": {
+    "socket.io-client": "^2.0.2",
+    "socket.io-json-parser": "^2.1.0"
+  },
+  "devDependencies": {
+    "strip-loader": "^0.1.2",
+    "webpack": "^2.6.1"
+  }
+}
--- a/examples/webpack-build/support/noop.js
+++ b/examples/webpack-build/support/noop.js
@@ -0,0 +1,2 @@
+
+module.exports = function () { return function () {}; };
--- a/examples/webpack-build/support/webpack.config.js
+++ b/examples/webpack-build/support/webpack.config.js
@@ -0,0 +1,8 @@
+
+module.exports = {
+  entry: './lib/index.js',
+  output: {
+    path: require('path').join(__dirname, '../dist'),
+    filename: 'app.js'
+  }
+};
--- a/examples/webpack-build/support/webpack.config.json-parser.js
+++ b/examples/webpack-build/support/webpack.config.json-parser.js
@@ -0,0 +1,33 @@
+
+var webpack = require('webpack');
+
+module.exports = {
+  entry: './lib/index.js',
+  output: {
+    path: require('path').join(__dirname, '../dist'),
+    filename: 'app.json-parser.js'
+  },
+  // generate sourcemap
+  devtool: 'source-map',
+  plugins: [
+    // replace require('debug')() with an noop function
+    new webpack.NormalModuleReplacementPlugin(/debug/, process.cwd() + '/support/noop.js'),
+    // replace socket.io-parser with socket.io-json-parser
+    new webpack.NormalModuleReplacementPlugin(/socket\.io-parser/, 'socket.io-json-parser'),
+    // use uglifyJS (IE9+ support)
+    new webpack.optimize.UglifyJsPlugin({
+      compress: {
+        warnings: false
+      }
+    })
+  ],
+  module: {
+    loaders: [
+      {
+        // strip `debug()` calls
+        test: /\.js$/,
+        loader: 'strip-loader?strip[]=debug'
+      }
+    ]
+  }
+};
--- a/examples/webpack-build/support/webpack.config.slim.js
+++ b/examples/webpack-build/support/webpack.config.slim.js
@@ -0,0 +1,31 @@
+
+var webpack = require('webpack');
+
+module.exports = {
+  entry: './lib/index.js',
+  output: {
+    path: require('path').join(__dirname, '../dist'),
+    filename: 'app.slim.js'
+  },
+  // generate sourcemap
+  devtool: 'source-map',
+  plugins: [
+    // replace require('debug')() with an noop function
+    new webpack.NormalModuleReplacementPlugin(/debug/, process.cwd() + '/support/noop.js'),
+    // use uglifyJS (IE9+ support)
+    new webpack.optimize.UglifyJsPlugin({
+      compress: {
+        warnings: false
+      }
+    })
+  ],
+  module: {
+    loaders: [
+      {
+        // strip `debug()` calls
+        test: /\.js$/,
+        loader: 'strip-loader?strip[]=debug'
+      }
+    ]
+  }
+};
--- a/examples/whiteboard/README.md
+++ b/examples/whiteboard/README.md
@@ -0,0 +1,17 @@
+
+# Socket.IO Collaborative Whiteboard
+
+A simple collaborative whiteboard for socket.io
+
+## How to use
+
+```
+$ npm i && npm start
+```
+
+And point your browser to `http://localhost:3000`. Optionally, specify
+a port by supplying the `PORT` env variable.
+
+## Features
+
+- draw on the whiteboard and all other users will see you drawings live
--- a/examples/whiteboard/index.js
+++ b/examples/whiteboard/index.js
@@ -0,0 +1,16 @@
+
+const express = require('express');
+const app = express();
+const http = require('http').Server(app);
+const io = require('socket.io')(http);
+const port = process.env.PORT || 3000;
+
+app.use(express.static(__dirname + '/public'));
+
+function onConnection(socket){
+  socket.on('drawing', (data) => socket.broadcast.emit('drawing', data));
+}
+
+io.on('connection', onConnection);
+
+http.listen(port, () => console.log('listening on port ' + port));
--- a/examples/whiteboard/package.json
+++ b/examples/whiteboard/package.json
@@ -0,0 +1,19 @@
+{
+  "name": "whiteboard",
+  "version": "1.0.0",
+  "description": "A simple collaborative whiteboard using socket.io",
+  "main": "index.js",
+  "keywords": [
+    "socket.io",
+    "whiteboard"
+  ],
+  "dependencies": {
+    "express": "4.9.x",
+    "socket.io": "latest"
+  },
+  "scripts": {
+    "start": "node index"
+  },
+  "author": "Damien Arrachequesne",
+  "license": "MIT"
+}
--- a/examples/whiteboard/public/index.html
+++ b/examples/whiteboard/public/index.html
@@ -0,0 +1,23 @@
+<!doctype html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <title>Socket.IO whiteboard</title>
+  <link rel="stylesheet" href="style.css">
+</head>
+<body>
+
+  <canvas class="whiteboard" ></canvas>
+
+  <div class="colors">
+    <div class="color black"></div>
+    <div class="color red"></div>
+    <div class="color green"></div>
+    <div class="color blue"></div>
+    <div class="color yellow"></div>
+  </div>
+
+  <script src="/socket.io/socket.io.js"></script>
+  <script src="/main.js"></script>
+</body>
+</html>
--- a/examples/whiteboard/public/main.js
+++ b/examples/whiteboard/public/main.js
@@ -0,0 +1,106 @@
+'use strict';
+
+(function() {
+
+  var socket = io();
+  var canvas = document.getElementsByClassName('whiteboard')[0];
+  var colors = document.getElementsByClassName('color');
+  var context = canvas.getContext('2d');
+
+  var current = {
+    color: 'black'
+  };
+  var drawing = false;
+
+  canvas.addEventListener('mousedown', onMouseDown, false);
+  canvas.addEventListener('mouseup', onMouseUp, false);
+  canvas.addEventListener('mouseout', onMouseUp, false);
+  canvas.addEventListener('mousemove', throttle(onMouseMove, 10), false);
+  
+  //Touch support for mobile devices
+  canvas.addEventListener('touchstart', onMouseDown, false);
+  canvas.addEventListener('touchend', onMouseUp, false);
+  canvas.addEventListener('touchcancel', onMouseUp, false);
+  canvas.addEventListener('touchmove', throttle(onMouseMove, 10), false);
+
+  for (var i = 0; i < colors.length; i++){
+    colors[i].addEventListener('click', onColorUpdate, false);
+  }
+
+  socket.on('drawing', onDrawingEvent);
+
+  window.addEventListener('resize', onResize, false);
+  onResize();
+
+
+  function drawLine(x0, y0, x1, y1, color, emit){
+    context.beginPath();
+    context.moveTo(x0, y0);
+    context.lineTo(x1, y1);
+    context.strokeStyle = color;
+    context.lineWidth = 2;
+    context.stroke();
+    context.closePath();
+
+    if (!emit) { return; }
+    var w = canvas.width;
+    var h = canvas.height;
+
+    socket.emit('drawing', {
+      x0: x0 / w,
+      y0: y0 / h,
+      x1: x1 / w,
+      y1: y1 / h,
+      color: color
+    });
+  }
+
+  function onMouseDown(e){
+    drawing = true;
+    current.x = e.clientX||e.touches[0].clientX;
+    current.y = e.clientY||e.touches[0].clientY;
+  }
+
+  function onMouseUp(e){
+    if (!drawing) { return; }
+    drawing = false;
+    drawLine(current.x, current.y, e.clientX||e.touches[0].clientX, e.clientY||e.touches[0].clientY, current.color, true);
+  }
+
+  function onMouseMove(e){
+    if (!drawing) { return; }
+    drawLine(current.x, current.y, e.clientX||e.touches[0].clientX, e.clientY||e.touches[0].clientY, current.color, true);
+    current.x = e.clientX||e.touches[0].clientX;
+    current.y = e.clientY||e.touches[0].clientY;
+  }
+
+  function onColorUpdate(e){
+    current.color = e.target.className.split(' ')[1];
+  }
+
+  // limit the number of events per second
+  function throttle(callback, delay) {
+    var previousCall = new Date().getTime();
+    return function() {
+      var time = new Date().getTime();
+
+      if ((time - previousCall) >= delay) {
+        previousCall = time;
+        callback.apply(null, arguments);
+      }
+    };
+  }
+
+  function onDrawingEvent(data){
+    var w = canvas.width;
+    var h = canvas.height;
+    drawLine(data.x0 * w, data.y0 * h, data.x1 * w, data.y1 * h, data.color);
+  }
+
+  // make the canvas fill its parent
+  function onResize() {
+    canvas.width = window.innerWidth;
+    canvas.height = window.innerHeight;
+  }
+
+})();
--- a/examples/whiteboard/public/style.css
+++ b/examples/whiteboard/public/style.css
@@ -0,0 +1,44 @@
+
+/**
+ * Fix user-agent
+ */
+
+* {
+  box-sizing: border-box;
+}
+
+html, body {
+  height: 100%;
+  margin: 0;
+  padding: 0;
+}
+
+/**
+ * Canvas
+ */
+
+.whiteboard {
+  height: 100%;
+  width: 100%;
+  position: absolute;
+  left: 0;
+  right: 0;
+  bottom: 0;
+  top: 0;
+}
+
+.colors {
+  position: fixed;
+}
+
+.color {
+  display: inline-block;
+  height: 48px;
+  width: 48px;
+}
+
+.color.black { background-color: black; }
+.color.red { background-color: red; }
+.color.green { background-color: green; }
+.color.blue { background-color: blue; }
+.color.yellow { background-color: yellow; }
--- a/gulpfile.js
+++ b/gulpfile.js
@@ -1,69 +0,0 @@
-const gulp = require('gulp');
-const mocha = require('gulp-mocha');
-const babel = require("gulp-babel");
-const istanbul = require('gulp-istanbul');
-const help = require('gulp-task-listing');
-const del = require('del');
-
-gulp.task('help', help);
-
-gulp.task('default', ['transpile']);
-
-const TRANSPILE_DEST_DIR = './dist';
-
-// By default, individual js files are transformed by babel and exported to /dist
-gulp.task('transpile', function () {
-  return gulp.src("lib/*.js")
-    .pipe(babel({ "presets": ["es2015"] }))
-    .pipe(gulp.dest(TRANSPILE_DEST_DIR));
-});
-
-gulp.task('clean', function () {
-  return del([TRANSPILE_DEST_DIR]);
-})
-
-gulp.task('test', ['transpile'], function(){
-  return gulp.src('test/socket.io.js', {read: false})
-    .pipe(mocha({
-      slow: 200,
-      reporter: 'spec',
-      bail: true,
-      timeout: 10000
-    }))
-    .once('error', function (err) {
-      console.error(err.stack);
-      process.exit(1);
-    })
-    .once('end', function () {
-      process.exit();
-    });
-});
-
-gulp.task('set-compat-node-env', function() {
-  process.env.TEST_VERSION = 'compat';
-});
-
-gulp.task('test-compat', ['set-compat-node-env', 'test']);
-
-gulp.task('istanbul-pre-test', function () {
-  return gulp.src(['lib/**/*.js'])
-    // Covering files
-    .pipe(istanbul())
-    // Force `require` to return covered files
-    .pipe(istanbul.hookRequire());
-});
-
-gulp.task('test-cov', ['istanbul-pre-test'], function(){
-  return gulp.src('test/socket.io.js', {read: false})
-    .pipe(mocha({
-      reporter: 'dot'
-    }))
-    .pipe(istanbul.writeReports())
-    .once('error', function (err){
-      console.error(err.stack);
-      process.exit(1);
-    })
-    .once('end', function (){
-      process.exit();
-    });
-});
--- a/lib/client.js
+++ b/lib/client.js
@@ -24,8 +24,8 @@ module.exports = Client;
 function Client(server, conn){
  this.server = server;
  this.conn = conn;
-  this.encoder = new parser.Encoder();
-  this.decoder = new parser.Decoder();
+  this.encoder = server.encoder;
+  this.decoder = new server.parser.Decoder();
  this.id = conn.id;
  this.request = conn.request;
  this.setup();
@@ -56,17 +56,37 @@ Client.prototype.setup = function(){
 * Connects a client to a namespace.
 *
 * @param {String} name namespace
+ * @param {Object} query the query parameters
 * @api private
 */

 Client.prototype.connect = function(name, query){
-  debug('connecting to namespace %s', name);
-  var nsp = this.server.nsps[name];
-  if (!nsp) {
-    this.packet({ type: parser.ERROR, nsp: name, data : 'Invalid namespace'});
-    return;
+  if (this.server.nsps[name]) {
+    debug('connecting to namespace %s', name);
+    return this.doConnect(name, query);
  }

+  this.server.checkNamespace(name, query, (dynamicNsp) => {
+    if (dynamicNsp) {
+      this.doConnect(name, query);
+    } else {
+      debug('creation of namespace %s was denied', name);
+      this.packet({ type: parser.ERROR, nsp: name, data: 'Invalid namespace' });
+    }
+  });
+};
+
+/**
+ * Connects a client to a namespace.
+ *
+ * @param {String} name namespace
+ * @param {String} query the query parameters
+ * @api private
+ */
+
+Client.prototype.doConnect = function(name, query){
+  var nsp = this.server.of(name);
+
  if ('/' != name && !this.nsps['/']) {
    this.connectBuffer.push(name);
    return;
@@ -153,9 +173,7 @@ Client.prototype.packet = function(packet, opts){
  if ('open' == this.conn.readyState) {
    debug('writing packet %j', packet);
    if (!opts.preEncoded) { // not broadcasting, need to encode
-      this.encoder.encode(packet, function (encodedPackets) { // encode, then write results to engine
-        writeToEngine(encodedPackets);
-      });
+      this.encoder.encode(packet, writeToEngine); // encode, then write results to engine
    } else { // a broadcast pre-encodes a packet
      writeToEngine(packet);
    }
@@ -213,7 +231,7 @@ Client.prototype.onerror = function(err){
      this.sockets[id].onerror(err);
    }
  }
-  this.onclose('client error');
+  this.conn.close();
 };

 /**
--- a/lib/index.js
+++ b/lib/index.js
@@ -1,3 +1,4 @@
+'use strict';

 /**
 * Module dependencies.
@@ -5,13 +6,16 @@

 var http = require('http');
 var read = require('fs').readFileSync;
+var path = require('path');
+var exists = require('fs').existsSync;
 var engine = require('engine.io');
-var client = require('socket.io-client');
-var clientVersion = require('socket.io-client/package').version;
+var clientVersion = require('socket.io-client/package.json').version;
 var Client = require('./client');
 var Emitter = require('events').EventEmitter;
 var Namespace = require('./namespace');
+var ParentNamespace = require('./parent-namespace');
 var Adapter = require('socket.io-adapter');
+var parser = require('socket.io-parser');
 var debug = require('debug')('socket.io:server');
 var url = require('url');

@@ -38,14 +42,17 @@ var clientSourceMap = undefined;

 function Server(srv, opts){
  if (!(this instanceof Server)) return new Server(srv, opts);
-  if ('object' == typeof srv && !srv.listen) {
+  if ('object' == typeof srv && srv instanceof Object && !srv.listen) {
    opts = srv;
    srv = null;
  }
  opts = opts || {};
  this.nsps = {};
+  this.parentNsps = new Map();
  this.path(opts.path || '/socket.io');
  this.serveClient(false !== opts.serveClient);
+  this.parser = opts.parser || parser;
+  this.encoder = new this.parser.Encoder();
  this.adapter(opts.adapter || Adapter);
  this.origins(opts.origins || '*:*');
  this.sockets = this.of('/');
@@ -75,9 +82,11 @@ Server.prototype.checkRequest = function(req, fn) {
        ? parts.port
        : defaultPort;
      var ok =
+        ~this._origins.indexOf(parts.protocol + '//' + parts.hostname + ':' + parts.port) ||
        ~this._origins.indexOf(parts.hostname + ':' + parts.port) ||
        ~this._origins.indexOf(parts.hostname + ':*') ||
        ~this._origins.indexOf('*:' + parts.port);
+      debug('origin %s is %svalid', origin, !!ok ? '' : 'not ');
      return fn(null, !!ok);
    } catch (ex) {
    }
@@ -96,16 +105,21 @@ Server.prototype.checkRequest = function(req, fn) {
 Server.prototype.serveClient = function(v){
  if (!arguments.length) return this._serveClient;
  this._serveClient = v;
-
+  var resolvePath = function(file){
+    var filepath = path.resolve(__dirname, './../../', file);
+    if (exists(filepath)) {
+      return filepath;
+    }
+    return require.resolve(file);
+  };
  if (v && !clientSource) {
-    clientSource = read(require.resolve('socket.io-client/dist/socket.io.min.js'), 'utf-8');
+    clientSource = read(resolvePath( 'socket.io-client/dist/socket.io.js'), 'utf-8');
    try {
-      clientSourceMap = read(require.resolve('socket.io-client/dist/socket.io.js.map'), 'utf-8');
+      clientSourceMap = read(resolvePath( 'socket.io-client/dist/socket.io.js.map'), 'utf-8');
    } catch(err) {
      debug('could not load sourcemap file');
    }
  }
-
  return this;
 };

@@ -148,6 +162,43 @@ Server.prototype.set = function(key, val){
  return this;
 };

+/**
+ * Executes the middleware for an incoming namespace not already created on the server.
+ *
+ * @param {String} name name of incoming namespace
+ * @param {Object} query the query parameters
+ * @param {Function} fn callback
+ * @api private
+ */
+
+Server.prototype.checkNamespace = function(name, query, fn){
+  if (this.parentNsps.size === 0) return fn(false);
+
+  const keysIterator = this.parentNsps.keys();
+
+  const run = () => {
+    let nextFn = keysIterator.next();
+    if (nextFn.done) {
+      return fn(false);
+    }
+    nextFn.value(name, query, (err, allow) => {
+      if (err || !allow) {
+        return run();
+      }
+      if (this.nsps[name]) {
+        // the namespace was created in the meantime
+        debug("dynamic namespace %s already exists", name);
+        return fn(this.nsps[name]);
+      }
+      const namespace = this.parentNsps.get(nextFn.value).createChild(name);
+      debug("dynamic namespace %s was created", name);
+      fn(namespace);
+    });
+  };
+
+  run();
+};
+
 /**
 * Sets the client serving path.
 *
@@ -184,7 +235,7 @@ Server.prototype.adapter = function(v){
 /**
 * Sets the allowed origins for requests.
 *
- * @param {String} v origins
+ * @param {String|String[]} v origins
 * @return {Server|Adapter} self when setting or value when getting
 * @api public
 */
@@ -235,6 +286,31 @@ Server.prototype.attach = function(srv, opts){
  // set origins verification
  opts.allowRequest = opts.allowRequest || this.checkRequest.bind(this);

+  if (this.sockets.fns.length > 0) {
+    this.initEngine(srv, opts);
+    return this;
+  }
+
+  var self = this;
+  var connectPacket = { type: parser.CONNECT, nsp: '/' };
+  this.encoder.encode(connectPacket, function (encodedPacket){
+    // the CONNECT packet will be merged with Engine.IO handshake,
+    // to reduce the number of round trips
+    opts.initialPacket = encodedPacket;
+
+    self.initEngine(srv, opts);
+  });
+  return this;
+};
+
+/**
+ * Initialize engine
+ *
+ * @param {Object} options passed to engine.io
+ * @api private
+ */
+
+Server.prototype.initEngine = function(srv, opts){
  // initialize engine
  debug('creating engine.io instance with opts %j', opts);
  this.eio = engine.attach(srv, opts);
@@ -247,8 +323,6 @@ Server.prototype.attach = function(srv, opts){

  // bind to engine events
  this.bind(this.eio);
-
-  return this;
 };

 /**
@@ -302,9 +376,9 @@ Server.prototype.serve = function(req, res){
  }

  debug('serve client source');
+  res.setHeader("Cache-Control", "public, max-age=0");
  res.setHeader('Content-Type', 'application/javascript');
  res.setHeader('ETag', expectedEtag);
-  res.setHeader('X-SourceMap', 'socket.io.js.map');
  res.writeHead(200);
  res.end(clientSource);
 };
@@ -371,14 +445,26 @@ Server.prototype.onconnection = function(conn){
 /**
 * Looks up a namespace.
 *
- * @param {String} name nsp name
+ * @param {String|RegExp|Function} name nsp name
 * @param {Function} [fn] optional, nsp `connection` ev handler
 * @api public
 */

 Server.prototype.of = function(name, fn){
+  if (typeof name === 'function' || name instanceof RegExp) {
+    const parentNsp = new ParentNamespace(this);
+    debug('initializing parent namespace %s', parentNsp.name);
+    if (typeof name === 'function') {
+      this.parentNsps.set(name, parentNsp);
+    } else {
+      this.parentNsps.set((nsp, conn, next) => next(null, name.test(nsp)), parentNsp);
+    }
+    if (fn) parentNsp.on('connect', fn);
+    return parentNsp;
+  }
+
  if (String(name)[0] !== '/') name = '/' + name;
-  
+
  var nsp = this.nsps[name];
  if (!nsp) {
    debug('initializing namespace %s', name);
@@ -392,7 +478,7 @@ Server.prototype.of = function(name, fn){
 /**
 * Closes server connection
 *
- * @param {Function} [fn] optional, called as `fn([err])` on error OR all conns closed 
+ * @param {Function} [fn] optional, called as `fn([err])` on error OR all conns closed
 * @api public
 */

@@ -420,7 +506,7 @@ var emitterMethods = Object.keys(Emitter.prototype).filter(function(key){
  return typeof Emitter.prototype[key] === 'function';
 });

-emitterMethods.concat(['to', 'in', 'use', 'send', 'write', 'clients', 'compress']).forEach(function(fn){
+emitterMethods.concat(['to', 'in', 'use', 'send', 'write', 'clients', 'compress', 'binary']).forEach(function(fn){
  Server.prototype[fn] = function(){
    return this.sockets[fn].apply(this.sockets, arguments);
  };
--- a/lib/namespace.js
+++ b/lib/namespace.js
@@ -6,8 +6,8 @@
 var Socket = require('./socket');
 var Emitter = require('events').EventEmitter;
 var parser = require('socket.io-parser');
+var hasBin = require('has-binary2');
 var debug = require('debug')('socket.io:namespace');
-var hasBin = require('has-binary');

 /**
 * Module exports.
@@ -56,6 +56,8 @@ function Namespace(server, name){
  this.connected = {};
  this.fns = [];
  this.ids = 0;
+  this.rooms = [];
+  this.flags = {};
  this.initAdapter();
 }

@@ -72,7 +74,6 @@ Namespace.prototype.__proto__ = Emitter.prototype;
 exports.flags.forEach(function(flag){
  Object.defineProperty(Namespace.prototype, flag, {
    get: function() {
-      this.flags = this.flags || {};
      this.flags[flag] = true;
      return this;
    }
@@ -99,6 +100,10 @@ Namespace.prototype.initAdapter = function(){
 */

 Namespace.prototype.use = function(fn){
+  if (this.server.eio && this.name === '/') {
+    debug('removing initial packet');
+    delete this.server.eio.initialPacket;
+  }
  this.fns.push(fn);
  return this;
 };
@@ -141,7 +146,6 @@ Namespace.prototype.run = function(socket, fn){

 Namespace.prototype.to =
 Namespace.prototype.in = function(name){
-  this.rooms = this.rooms || [];
  if (!~this.rooms.indexOf(name)) this.rooms.push(name);
  return this;
 };
@@ -159,25 +163,31 @@ Namespace.prototype.add = function(client, query, fn){
  var self = this;
  this.run(socket, function(err){
    process.nextTick(function(){
-      if ('open' == client.conn.readyState) {
-        if (err) return socket.error(err.data || err.message);
-
-        // track socket
-        self.sockets[socket.id] = socket;
-
-        // it's paramount that the internal `onconnect` logic
-        // fires before user-set events to prevent state order
-        // violations (such as a disconnection before the connection
-        // logic is complete)
-        socket.onconnect();
-        if (fn) fn();
-
-        // fire user-set events
-        self.emit('connect', socket);
-        self.emit('connection', socket);
-      } else {
-        debug('next called after client was closed - ignoring socket');
+      if ("open" !== client.conn.readyState) {
+        debug("next called after client was closed - ignoring socket");
+        socket._cleanup();
+        return;
      }
+
+      if (err) {
+        debug("middleware error, sending CONNECT_ERROR packet to the client");
+        socket._cleanup();
+        return socket.error(err.data || err.message);
+      }
+
+      // track socket
+      self.sockets[socket.id] = socket;
+
+      // it's paramount that the internal `onconnect` logic
+      // fires before user-set events to prevent state order
+      // violations (such as a disconnection before the connection
+      // logic is complete)
+      socket.onconnect();
+      if (fn) fn();
+
+      // fire user-set events
+      self.emit('connect', socket);
+      self.emit('connection', socket);
    });
  });
  return socket;
@@ -207,26 +217,31 @@ Namespace.prototype.remove = function(socket){
 Namespace.prototype.emit = function(ev){
  if (~exports.events.indexOf(ev)) {
    emit.apply(this, arguments);
-  } else {
-    // set up packet object
-    var args = Array.prototype.slice.call(arguments);
-    var parserType = parser.EVENT; // default
-    if (hasBin(args)) { parserType = parser.BINARY_EVENT; } // binary
-
-    var packet = { type: parserType, data: args };
-
-    if ('function' == typeof args[args.length - 1]) {
-      throw new Error('Callbacks are not supported when broadcasting');
-    }
-
-    this.adapter.broadcast(packet, {
-      rooms: this.rooms,
-      flags: this.flags
-    });
-
-    delete this.rooms;
-    delete this.flags;
+    return this;
  }
+  // set up packet object
+  var args = Array.prototype.slice.call(arguments);
+  var packet = {
+    type: (this.flags.binary !== undefined ? this.flags.binary : hasBin(args)) ? parser.BINARY_EVENT : parser.EVENT,
+    data: args
+  };
+
+  if ('function' == typeof args[args.length - 1]) {
+    throw new Error('Callbacks are not supported when broadcasting');
+  }
+
+  var rooms = this.rooms.slice(0);
+  var flags = Object.assign({}, this.flags);
+
+  // reset flags
+  this.rooms = [];
+  this.flags = {};
+
+  this.adapter.broadcast(packet, {
+    rooms: rooms,
+    flags: flags
+  });
+
  return this;
 };

@@ -253,10 +268,13 @@ Namespace.prototype.write = function(){
 */

 Namespace.prototype.clients = function(fn){
+  if(!this.adapter){
+    throw new Error('No adapter for this namespace, are you trying to get the list of clients of a dynamic namespace?')
+  }
  this.adapter.clients(this.rooms, fn);
-  // delete rooms flag for scenario:
+  // reset rooms for scenario:
  // .in('room').clients() (GH-1978)
-  delete this.rooms;
+  this.rooms = [];
  return this;
 };

@@ -269,7 +287,19 @@ Namespace.prototype.clients = function(fn){
 */

 Namespace.prototype.compress = function(compress){
-  this.flags = this.flags || {};
  this.flags.compress = compress;
  return this;
 };
+
+/**
+ * Sets the binary flag
+ *
+ * @param {Boolean} Encode as if it has binary data if `true`, Encode as if it doesnt have binary data if `false`
+ * @return {Socket} self
+ * @api public
+ */
+
+ Namespace.prototype.binary = function (binary) {
+   this.flags.binary = binary;
+   return this;
+ };
--- a/lib/parent-namespace.js
+++ b/lib/parent-namespace.js
@@ -0,0 +1,39 @@
+'use strict';
+
+const Namespace = require('./namespace');
+
+let count = 0;
+
+class ParentNamespace extends Namespace {
+
+  constructor(server) {
+    super(server, '/_' + (count++));
+    this.children = new Set();
+  }
+
+  initAdapter() {}
+
+  emit() {
+    const args = Array.prototype.slice.call(arguments);
+
+    this.children.forEach(nsp => {
+      nsp.rooms = this.rooms;
+      nsp.flags = this.flags;
+      nsp.emit.apply(nsp, args);
+    });
+    this.rooms = [];
+    this.flags = {};
+  }
+
+  createChild(name) {
+    const namespace = new Namespace(this.server, name);
+    namespace.fns = this.fns.slice(0);
+    this.listeners('connect').forEach(listener => namespace.on('connect', listener));
+    this.listeners('connection').forEach(listener => namespace.on('connection', listener));
+    this.children.add(namespace);
+    this.server.nsps[name] = namespace;
+    return namespace;
+  }
+}
+
+module.exports = ParentNamespace;
--- a/lib/socket.js
+++ b/lib/socket.js
@@ -5,10 +5,9 @@

 var Emitter = require('events').EventEmitter;
 var parser = require('socket.io-parser');
+var hasBin = require('has-binary2');
 var url = require('url');
 var debug = require('debug')('socket.io:socket');
-var hasBin = require('has-binary');
-var assign = require('object-assign');

 /**
 * Module exports.
@@ -40,7 +39,8 @@ exports.events = [
 var flags = [
  'json',
  'volatile',
-  'broadcast'
+  'broadcast',
+  'local'
 ];

 /**
@@ -49,6 +49,8 @@ var flags = [

 var emit = Emitter.prototype.emit;

+function noop() {}
+
 /**
 * Interface to a `Client` for a given `Namespace`.
 *
@@ -66,10 +68,15 @@ function Socket(nsp, client, query){
  this.conn = client.conn;
  this.rooms = {};
  this.acks = {};
-  this.connected = true;
-  this.disconnected = false;
+  this.connected = false;
+  this.disconnected = true;
  this.handshake = this.buildHandshake(query);
  this.fns = [];
+  this.flags = {};
+  this._rooms = [];
+
+  // prevents crash when the socket receives an "error" event without listener
+  this.on('error', noop);
 }

 /**
@@ -85,7 +92,6 @@ Socket.prototype.__proto__ = Emitter.prototype;
 flags.forEach(function(flag){
  Object.defineProperty(Socket.prototype, flag, {
    get: function() {
-      this.flags = this.flags || {};
      this.flags[flag] = true;
      return this;
    }
@@ -115,7 +121,7 @@ Socket.prototype.buildHandshake = function(query){
  function buildQuery(){
    var requestQuery = url.parse(self.request.url, true).query;
    //if socket-specific query exist, replace query strings in requestQuery
-    return assign({}, query, requestQuery);
+    return Object.assign({}, requestQuery, query);
  }
  return {
    headers: this.request.headers,
@@ -139,41 +145,42 @@ Socket.prototype.buildHandshake = function(query){
 Socket.prototype.emit = function(ev){
  if (~exports.events.indexOf(ev)) {
    emit.apply(this, arguments);
+    return this;
+  }
+
+  var args = Array.prototype.slice.call(arguments);
+  var packet = {
+    type: (this.flags.binary !== undefined ? this.flags.binary : hasBin(args)) ? parser.BINARY_EVENT : parser.EVENT,
+    data: args
+  };
+
+  // access last argument to see if it's an ACK callback
+  if (typeof args[args.length - 1] === 'function') {
+    if (this._rooms.length || this.flags.broadcast) {
+      throw new Error('Callbacks are not supported when broadcasting');
+    }
+
+    debug('emitting packet with ack id %d', this.nsp.ids);
+    this.acks[this.nsp.ids] = args.pop();
+    packet.id = this.nsp.ids++;
+  }
+
+  var rooms = this._rooms.slice(0);
+  var flags = Object.assign({}, this.flags);
+
+  // reset flags
+  this._rooms = [];
+  this.flags = {};
+
+  if (rooms.length || flags.broadcast) {
+    this.adapter.broadcast(packet, {
+      except: [this.id],
+      rooms: rooms,
+      flags: flags
+    });
  } else {
-    var args = Array.prototype.slice.call(arguments);
-    var packet = {};
-    packet.type = hasBin(args) ? parser.BINARY_EVENT : parser.EVENT;
-    packet.data = args;
-    var flags = this.flags || {};
-
-    // access last argument to see if it's an ACK callback
-    if ('function' == typeof args[args.length - 1]) {
-      if (this._rooms || flags.broadcast) {
-        throw new Error('Callbacks are not supported when broadcasting');
-      }
-
-      debug('emitting packet with ack id %d', this.nsp.ids);
-      this.acks[this.nsp.ids] = args.pop();
-      packet.id = this.nsp.ids++;
-    }
-
-    if (this._rooms || flags.broadcast) {
-      this.adapter.broadcast(packet, {
-        except: [this.id],
-        rooms: this._rooms,
-        flags: flags
-      });
-    } else {
-      // dispatch packet
-      this.packet(packet, {
-        volatile: flags.volatile,
-        compress: flags.compress
-      });
-    }
-
-    // reset flags
-    delete this._rooms;
-    delete this.flags;
+    // dispatch packet
+    this.packet(packet, flags);
  }
  return this;
 };
@@ -188,7 +195,6 @@ Socket.prototype.emit = function(ev){

 Socket.prototype.to =
 Socket.prototype.in = function(name){
-  this._rooms = this._rooms || [];
  if (!~this._rooms.indexOf(name)) this._rooms.push(name);
  return this;
 };
@@ -226,23 +232,31 @@ Socket.prototype.packet = function(packet, opts){
 /**
 * Joins a room.
 *
- * @param {String} room
+ * @param {String|Array} room or array of rooms
 * @param {Function} fn optional, callback
 * @return {Socket} self
 * @api private
 */

-Socket.prototype.join = function(room, fn){
-  debug('joining room %s', room);
+Socket.prototype.join = function(rooms, fn){
+  debug('joining room %s', rooms);
  var self = this;
-  if (this.rooms.hasOwnProperty(room)) {
+  if (!Array.isArray(rooms)) {
+    rooms = [rooms];
+  }
+  rooms = rooms.filter(function (room) {
+    return !self.rooms.hasOwnProperty(room);
+  });
+  if (!rooms.length) {
    fn && fn(null);
    return this;
  }
-  this.adapter.add(this.id, room, function(err){
+  this.adapter.addAll(this.id, rooms, function(err){
    if (err) return fn && fn(err);
-    debug('joined room %s', room);
-    self.rooms[room] = room;
+    debug('joined room %s', rooms);
+    rooms.forEach(function (room) {
+      self.rooms[room] = room;
+    });
    fn && fn(null);
  });
  return this;
@@ -291,9 +305,16 @@ Socket.prototype.leaveAll = function(){

 Socket.prototype.onconnect = function(){
  debug('socket connected - writing packet');
+  this.connected = true;
+  this.disconnected = false;
  this.nsp.connected[this.id] = this;
  this.join(this.id);
-  this.packet({ type: parser.CONNECT });
+  var skip = this.nsp.name === '/' && this.nsp.fns.length === 0;
+  if (skip) {
+    debug('packet already sent in initial handshake');
+  } else {
+    this.packet({ type: parser.CONNECT });
+  }
 };

 /**
@@ -327,7 +348,7 @@ Socket.prototype.onpacket = function(packet){
      break;

    case parser.ERROR:
-      this.emit('error', packet.data);
+      this.onerror(new Error(packet.data));
  }
 };

@@ -366,10 +387,9 @@ Socket.prototype.ack = function(id){
    var args = Array.prototype.slice.call(arguments);
    debug('sending ack %j', args);

-    var type = hasBin(args) ? parser.BINARY_ACK : parser.ACK;
    self.packet({
      id: id,
-      type: type,
+      type: hasBin(args) ? parser.BINARY_ACK : parser.ACK,
      data: args
    });

@@ -412,12 +432,7 @@ Socket.prototype.ondisconnect = function(){
 */

 Socket.prototype.onerror = function(err){
-  if (this.listeners('error').length) {
-    this.emit('error', err);
-  } else {
-    console.error('Missing error handler on `socket`.');
-    console.error(err.stack);
-  }
+  this.emit('error', err);
 };

 /**
@@ -432,7 +447,7 @@ Socket.prototype.onclose = function(reason){
  if (!this.connected) return this;
  debug('closing socket - reason %s', reason);
  this.emit('disconnecting', reason);
-  this.leaveAll();
+  this._cleanup();
  this.nsp.remove(this);
  this.client.remove(this);
  this.connected = false;
@@ -480,11 +495,23 @@ Socket.prototype.disconnect = function(close){
 */

 Socket.prototype.compress = function(compress){
-  this.flags = this.flags || {};
  this.flags.compress = compress;
  return this;
 };

+/**
+ * Sets the binary flag
+ *
+ * @param {Boolean} Encode as if it has binary data if `true`, Encode as if it doesnt have binary data if `false`
+ * @return {Socket} self
+ * @api public
+ */
+
+ Socket.prototype.binary = function (binary) {
+   this.flags.binary = binary;
+   return this;
+ };
+
 /**
 * Dispatch incoming event to socket listeners.
 *
@@ -495,15 +522,20 @@ Socket.prototype.compress = function(compress){
 Socket.prototype.dispatch = function(event){
  debug('dispatching an event %j', event);
  var self = this;
-  this.run(event, function(err){
+  function dispatchSocket(err) {
    process.nextTick(function(){
      if (err) {
        return self.error(err.data || err.message);
      }
-      emit.apply(self, event);
+      if (self.connected) {
+        emit.apply(self, event);
+      } else {
+        debug("ignore packet received after disconnection");
+      }
    });
-  });
-}
+  }
+  this.run(event, dispatchSocket);
+};

 /**
 * Sets up socket middleware.
@@ -544,3 +576,8 @@ Socket.prototype.run = function(event, fn){

  run(0);
 };
+
+Socket.prototype._cleanup = function () {
+  this.leaveAll();
+  this.join = function noop() {};
+}
--- a/package-lock.json
+++ b/package-lock.json
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
 {
  "name": "socket.io",
-  "version": "1.7.2",
+  "version": "2.5.1",
  "description": "node.js realtime framework server",
  "keywords": [
    "realtime",
@@ -21,30 +21,22 @@
    "url": "git://github.com/socketio/socket.io"
  },
  "scripts": {
-    "test": "gulp test"
+    "test": "nyc mocha --reporter spec --slow 200 --bail --timeout 10000 test/socket.io.js"
  },
  "dependencies": {
-    "debug": "2.3.3",
-    "engine.io": "1.8.2",
-    "has-binary": "0.1.7",
-    "object-assign": "4.1.0",
-    "socket.io-adapter": "0.5.0",
-    "socket.io-client": "1.7.2",
-    "socket.io-parser": "2.3.1"
+    "debug": "~4.1.0",
+    "engine.io": "~3.6.0",
+    "has-binary2": "~1.0.2",
+    "socket.io-adapter": "~1.1.0",
+    "socket.io-client": "2.5.0",
+    "socket.io-parser": "~3.4.0"
  },
  "devDependencies": {
-    "babel-preset-es2015": "6.3.13",
-    "del": "2.2.0",
    "expect.js": "0.3.1",
-    "gulp": "3.9.0",
-    "gulp-babel": "6.1.1",
-    "gulp-istanbul": "0.10.3",
-    "gulp-mocha": "2.2.0",
-    "gulp-task-listing": "1.0.1",
-    "istanbul": "0.4.1",
-    "mocha": "2.3.4",
-    "superagent": "1.6.1",
-    "supertest": "1.1.0"
+    "mocha": "^3.5.3",
+    "nyc": "^11.2.1",
+    "superagent": "^3.8.2",
+    "supertest": "^3.0.0"
  },
  "contributors": [
    {
--- a/test/socket.io.js
+++ b/test/socket.io.js
@@ -1,12 +1,7 @@
-var testVersion = process.env.TEST_VERSION;
+'use strict';
+
 var http = require('http').Server;
-var io;
-if (testVersion === 'compat') {
-  console.log('testing compat version');
-  io = require('../dist');
-} else {
-  io = require('../lib');
-}
+var io = require('../lib');
 var fs = require('fs');
 var join = require('path').join;
 var exec = require('child_process').exec;
@@ -28,7 +23,7 @@ function client(srv, nsp, opts){

 describe('socket.io', function(){

-  it('should be the same version as client', function(){
+  it.skip('should be the same version as client', function(){
    var version = require('../package').version;
    expect(version).to.be(require('socket.io-client/package').version);
  });
@@ -251,7 +246,7 @@ describe('socket.io', function(){
      request.get('http://localhost:54013/socket.io/default/')
       .query({ transport: 'polling' })
       .end(function (err, res) {
-          expect(res.status).to.be(400);
+          expect(res.status).to.be(403);
          done();
        });
    });
@@ -262,7 +257,7 @@ describe('socket.io', function(){
       .query({ transport: 'polling' })
       .set('origin', 'http://herp.derp')
       .end(function (err, res) {
-          expect(res.status).to.be(400);
+          expect(res.status).to.be(403);
          done();
       });
    });
@@ -305,7 +300,7 @@ describe('socket.io', function(){
       .set('origin', 'http://herp.derp')
       .query({ transport: 'polling' })
       .end(function (err, res) {
-          expect(res.status).to.be(400);
+          expect(res.status).to.be(403);
          done();
        });
    });
@@ -357,7 +352,18 @@ describe('socket.io', function(){
       .set('origin', 'http://foo.example')
       .query({ transport: 'polling' })
       .end(function (err, res) {
-          expect(res.status).to.be(400);
+          expect(res.status).to.be(403);
+          done();
+        });
+    });
+
+    it('should allow request when using an array of origins', function(done) {
+      io({ origins: [ 'http://foo.example:54024' ] }).listen('54024');
+      request.get('http://localhost:54024/socket.io/default/')
+        .set('origin', 'http://foo.example:54024')
+        .query({ transport: 'polling' })
+        .end(function (err, res) {
+          expect(res.status).to.be(200);
          done();
        });
    });
@@ -432,18 +438,9 @@ describe('socket.io', function(){
  });

  describe('namespaces', function(){
-    var Socket;
-    if (testVersion === 'compat') {
-      Socket = require('../dist/socket');
-    } else {
-      Socket = require('../lib/socket');
-    }
-    var Namespace;
-    if (testVersion === 'compat') {
-      Namespace = require('../dist/namespace');
-    } else {
-      Namespace = require('../lib/namespace');
-    }
+    var Socket = require('../lib/socket');
+    var Namespace = require('../lib/namespace');
+
    it('should be accessible through .sockets', function(){
      var sio = io();
      expect(sio.sockets).to.be.a(Namespace);
@@ -894,6 +891,97 @@ describe('socket.io', function(){
        });
      });
    });
+
+    describe('dynamic namespaces', function () {
+      it('should allow connections to dynamic namespaces with a regex', function(done){
+        const srv = http();
+        const sio = io(srv);
+        let count = 0;
+        srv.listen(function(){
+          const socket = client(srv, '/dynamic-101');
+          let dynamicNsp = sio.of(/^\/dynamic-\d+$/).on('connect', (socket) => {
+            expect(socket.nsp.name).to.be('/dynamic-101');
+            dynamicNsp.emit('hello', 1, '2', { 3: '4'});
+            if (++count === 4) done();
+          }).use((socket, next) => {
+            next();
+            if (++count === 4) done();
+          });
+          socket.on('error', function(err) {
+            expect().fail();
+          });
+          socket.on('connect', () => {
+            if (++count === 4) done();
+          });
+          socket.on('hello', (a, b, c) => {
+            expect(a).to.eql(1);
+            expect(b).to.eql('2');
+            expect(c).to.eql({ 3: '4' });
+            if (++count === 4) done();
+          });
+        });
+      });
+
+      it('should allow connections to dynamic namespaces with a function', function(done){
+        const srv = http();
+        const sio = io(srv);
+        srv.listen(function(){
+          const socket = client(srv, '/dynamic-101');
+          sio.of((name, query, next) => next(null, '/dynamic-101' === name));
+          socket.on('connect', done);
+        });
+      });
+
+      it('should disallow connections when no dynamic namespace matches', function(done){
+        const srv = http();
+        const sio = io(srv);
+        srv.listen(function(){
+          const socket = client(srv, '/abc');
+          sio.of(/^\/dynamic-\d+$/);
+          sio.of((name, query, next) => next(null, '/dynamic-101' === name));
+          socket.on('error', (err) => {
+            expect(err).to.be('Invalid namespace');
+            done();
+          });
+        });
+      });
+
+      it("should handle race conditions with dynamic namespaces (#4136)", (done) => {
+        const srv = http();
+        const sio = io(srv);
+        const counters = {
+          connected: 0,
+          created: 0,
+          events: 0,
+        };
+        const buffer = [];
+        srv.listen(() => {
+          const handler = () => {
+            if (++counters.events === 2) {
+              done();
+            }
+          };
+
+          sio
+            .of((name, query, next) => {
+              buffer.push(next);
+              if (buffer.length === 2) {
+                buffer.forEach((next) => next(null, true));
+              }
+            })
+            .on("connection", (socket) => {
+              if (++counters.connected === 2) {
+                sio.of("/dynamic-101").emit("message");
+              }
+            });
+
+          let one = client(srv, "/dynamic-101");
+          let two = client(srv, "/dynamic-101");
+          one.on("message", handler);
+          two.on("message", handler);
+        });
+      });
+    });
  });

  describe('socket', function(){
@@ -981,12 +1069,12 @@ describe('socket.io', function(){
      var srv = http();
      var sio = io(srv);
      srv.listen(function(){
-        var socket = client(srv);
+        var socket = client(srv, { reconnection: false });
        sio.on('connection', function(s){
          s.on('error', function(err){
            expect(err).to.be.an(Error);
            s.on('disconnect', function(reason){
-              expect(reason).to.be('client error');
+              expect(reason).to.be('forced close');
              done();
            });
          });
@@ -1074,7 +1162,7 @@ describe('socket.io', function(){
        sio.on('connection', function(s){
          fs.readFile(join(__dirname, 'support', 'doge.jpg'), function(err, data){
            if (err) return done(err);
-            var buf = new Buffer('asdfasdf', 'utf8');
+            var buf = Buffer.from('asdfasdf', 'utf8');
            s.emit('multiple', 1, data, '3', [4], buf, [data, 'swag', buf]);
          });
        });
@@ -1091,7 +1179,7 @@ describe('socket.io', function(){
            expect(Buffer.isBuffer(a)).to.be(true);
            done();
          });
-          var buf = new Buffer('abcdefg', 'utf8');
+          var buf = Buffer.from('abcdefg', 'utf8');
          socket.emit('buff', buf);
        });
      });
@@ -1116,7 +1204,7 @@ describe('socket.io', function(){
          });
          fs.readFile(join(__dirname, 'support', 'doge.jpg'), function(err, data){
            if (err) return done(err);
-            var buf = new Buffer('asdfasdf', 'utf8');
+            var buf = Buffer.from('asdfasdf', 'utf8');
            socket.emit('multiple', 1, data, '3', [4], buf, [data, 'swag', buf]);
          });
        });
@@ -1444,7 +1532,7 @@ describe('socket.io', function(){
            expect(Buffer.isBuffer(buf)).to.be(true);
            fn(1, 2);
          });
-          socket.emit('woot', new Buffer(3), function(a, b){
+          socket.emit('woot', Buffer.alloc(3), function(a, b){
            expect(a).to.be(1);
            expect(b).to.be(2);
            done();
@@ -1463,7 +1551,7 @@ describe('socket.io', function(){
            expect(Buffer.isBuffer(a)).to.be(true);
            fn();
          });
-          s.emit('hi', new Buffer(4), function(){
+          s.emit('hi', Buffer.alloc(4), function(){
            done();
          });
        });
@@ -1477,7 +1565,7 @@ describe('socket.io', function(){
        var socket = client(srv);
        sio.on('connection', function(s){
          socket.on('hi', function(fn){
-            fn(new Buffer(1));
+            fn(Buffer.alloc(1));
          });
          s.emit('hi', function(a){
            expect(Buffer.isBuffer(a)).to.be(true);
@@ -1494,7 +1582,7 @@ describe('socket.io', function(){
        var socket = client(srv);
        sio.on('connection', function(s){
          s.on('woot', function(fn){
-            fn(new Buffer(2));
+            fn(Buffer.alloc(2));
          });
          socket.emit('woot', function(a){
            expect(Buffer.isBuffer(a)).to.be(true);
@@ -1569,8 +1657,25 @@ describe('socket.io', function(){
        expect(s.handshake.query.key2).to.be('&=bb');
        done();
      });
+    });

+    it('should see the query options sent in the Socket.IO handshake (specific to the given socket)', (done) => {
+      const srv = http();
+      const sio = io(srv);
+      const socket = client(srv, '/namespace',{ query: { key1: 'a', key2: 'b' }}); // manager-specific query option
+      socket.query = { key2: 'c' }; // socket-specific query option

+      const success = () => {
+        sio.close();
+        socket.close();
+        done();
+      }
+
+      sio.of('/namespace').on('connection', (s) => {
+        expect(s.handshake.query.key1).to.be('a'); // in the query params
+        expect(s.handshake.query.key2).to.be('c'); // in the Socket.IO handshake
+        success();
+      });
    });

    it('should handle very large json', function(done){
@@ -1686,10 +1791,10 @@ describe('socket.io', function(){
      var srv = http();
      var sio = io(srv);
      srv.listen(function(){
-        var socket = client(srv);
+        var socket = client(srv, { reconnection: false });
        sio.on('connection', function(s){
          s.conn.on('upgrade', function(){
-            console.log('\033[96mNote: warning expected and normal in test.\033[39m');
+            console.log('\u001b[96mNote: warning expected and normal in test.\u001b[39m');
            socket.io.engine.write('5woooot');
            setTimeout(function(){
              done();
@@ -1699,11 +1804,28 @@ describe('socket.io', function(){
      });
    });

+    it('should not crash when receiving an error packet without handler', function(done){
+      var srv = http();
+      var sio = io(srv);
+      srv.listen(function(){
+        var socket = client(srv, { reconnection: false });
+        sio.on('connection', function(s){
+          s.conn.on('upgrade', function(){
+            console.log('\u001b[96mNote: warning expected and normal in test.\u001b[39m');
+            socket.io.engine.write('44["handle me please"]');
+            setTimeout(function(){
+              done();
+            }, 100);
+          });
+        });
+      });
+    });
+
    it('should not crash with raw binary', function(done){
      var srv = http();
      var sio = io(srv);
      srv.listen(function(){
-        var socket = client(srv);
+        var socket = client(srv, { reconnection: false });
        sio.on('connection', function(s){
          s.once('error', function(err){
            expect(err.message).to.match(/Illegal attachments/);
@@ -1720,7 +1842,7 @@ describe('socket.io', function(){
      var srv = http();
      var sio = io(srv);
      srv.listen(function(){
-        var socket = client(srv);
+        var socket = client(srv, { reconnection: false });
        sio.on('connection', function(s){
          s.once('error', function(err){
            expect(err.message).to.match(/Illegal attachments/);
@@ -1733,8 +1855,10 @@ describe('socket.io', function(){
      });
    });

-    it('should not crash when messing with Object prototype', function(done){
+    it('should not crash when messing with Object prototype (and other globals)', function(done){
      Object.prototype.foo = 'bar';
+      global.File = '';
+      // global.Blob = [];
      var srv = http();
      var sio = io(srv);
      srv.listen(function(){
@@ -1750,6 +1874,70 @@ describe('socket.io', function(){
      });
    });

+    it("should ignore a packet received after disconnection", (done) => {
+      const srv = http();
+      const sio = io(srv);
+
+      srv.listen(() => {
+        const clientSocket = client(srv);
+
+        const success = () => {
+          clientSocket.close();
+          sio.close();
+          done();
+        };
+
+        sio.on("connection", (socket) => {
+          socket.on("test", () => {
+            done(new Error("should not happen"));
+          });
+          socket.on("disconnect", success);
+        });
+
+        clientSocket.on("connect", () => {
+          clientSocket.emit("test", Buffer.alloc(10));
+          clientSocket.disconnect();
+        });
+      });
+    });
+
+    it("should leave all rooms joined after a middleware failure", (done) => {
+      const srv = http().listen(0);
+      const sio = io(srv);
+      const clientSocket = client(srv, "/");
+
+      sio.use((socket, next) => {
+        socket.join("room1");
+        next(new Error("nope"));
+      });
+
+      clientSocket.on("error", () => {
+        expect(sio.of("/").adapter.rooms).to.eql(0);
+
+        clientSocket.disconnect();
+        sio.close();
+        done();
+      });
+    });
+
+    it("should not join rooms after disconnection", (done) => {
+      const srv = http().listen(0);
+      const sio = io(srv);
+      const clientSocket = client(srv, "/");
+
+      sio.on("connection", (socket) => {
+        socket.disconnect();
+        socket.join("room1");
+      });
+
+      clientSocket.on("disconnect", () => {
+        expect(sio.of("/").adapter.rooms).to.eql(0);
+
+        sio.close();
+        done();
+      });
+    });
+
    it('should always trigger the callback (if provided) when joining a room', function(done){
      var srv = http();
      var sio = io(srv);
@@ -1828,7 +2016,7 @@ describe('socket.io', function(){
        });

        function emit(){
-          sio.emit('bin', new Buffer(10));
+          sio.emit('bin', Buffer.alloc(10));
        }
      });
    });
@@ -2012,8 +2200,8 @@ describe('socket.io', function(){
            socket.join(room, fn);
          });
          socket.on('broadcast', function(){
-            socket.broadcast.to('test').emit('bin', new Buffer(5));
-            socket.emit('bin2', new Buffer(5));
+            socket.broadcast.to('test').emit('bin', Buffer.alloc(5));
+            socket.emit('bin2', Buffer.alloc(5));
          });
        });
      });
@@ -2086,15 +2274,25 @@ describe('socket.io', function(){
        });
      });
    });
+
+    it('allows to join several rooms at once', function(done) {
+      var srv = http();
+      var sio = io(srv);
+
+      srv.listen(function(){
+        var socket = client(srv);
+        sio.on('connection', function(s){
+          s.join(['a', 'b', 'c'], function(){
+            expect(Object.keys(s.rooms)).to.eql([s.id, 'a', 'b', 'c']);
+            done();
+          });
+        });
+      });
+    });
  });

  describe('middleware', function(done){
-    var Socket;
-    if (testVersion === 'compat') {
-      Socket = require('../dist/socket');
-    } else {
-      Socket = require('../lib/socket');
-    }
+    var Socket = require('../lib/socket');

    it('should call functions', function(done){
      var srv = http();
@@ -2178,6 +2376,26 @@ describe('socket.io', function(){
      });
    });

+    it('should only call connection after (lengthy) fns', function(done){
+      var srv = http();
+      var sio = io(srv);
+      var authenticated = false;
+
+      sio.use(function(socket, next){
+        setTimeout(function () {
+          authenticated = true;
+          next();
+        }, 300);
+      });
+      srv.listen(function(){
+        var socket = client(srv);
+        socket.on('connect', function(){
+          expect(authenticated).to.be(true);
+          done();
+        });
+      });
+    });
+
    it('should be ignored if socket gets closed', function(done){
      var srv = http();
      var sio = io(srv);
@@ -2231,6 +2449,55 @@ describe('socket.io', function(){
        });
      });
    });
+
+    it('should disable the merge of handshake packets', function(done){
+      var srv = http();
+      var sio = io();
+      sio.use(function(socket, next){
+        next();
+      });
+      sio.listen(srv);
+      var socket = client(srv);
+      socket.on('connect', function(){
+        done();
+      });
+    });
+
+    it('should work with a custom namespace', (done) => {
+      var srv = http();
+      var sio = io();
+      sio.listen(srv);
+      sio.of('/chat').use(function(socket, next){
+        next();
+      });
+
+      var count = 0;
+      client(srv, '/').on('connect', () => {
+        if (++count === 2) done();
+      });
+      client(srv, '/chat').on('connect', () => {
+        if (++count === 2) done();
+      });
+    });
+
+    it("should only set `connected` to true after the middleware execution", (done) => {
+      const httpServer = http();
+      const sio = io(httpServer);
+
+      const clientSocket = client(httpServer, "/");
+
+      sio.use((socket, next) => {
+        expect(socket.connected).to.be(false);
+        expect(socket.disconnected).to.be(true);
+        next();
+      });
+
+      sio.on("connection", (socket) => {
+        expect(socket.connected).to.be(true);
+        expect(socket.disconnected).to.be(false);
+        done();
+      });
+    });
  });

  describe('socket middleware', function(done){
Author	SHA1	Message	Date
Damien Arrachequesne	88b2cdb6ab	chore(release): 2.5.1 Release notes: https://github.com/socketio/socket.io/releases/tag/2.5.1 Diff: https://github.com/socketio/socket.io/compare/2.5.0...2.5.1	2024-06-19 10:48:24 +02:00
Damien Arrachequesne	d30630ba10	fix: add a noop handler for the error event Backported from main: `15af22fc22`	2024-06-19 10:46:29 +02:00
Damien Arrachequesne	f927ba29ef	test: fix tests on Node.js > 18 Reference: https://nodejs.org/api/buffer.html#class-blob	2024-06-19 10:44:04 +02:00
Damien Arrachequesne	baa6804440	chore(release): 2.5.0 Release notes: https://github.com/socketio/socket.io/releases/tag/2.5.0 Diff: https://github.com/socketio/socket.io/compare/2.4.1...2.5.0	2022-06-26 09:49:21 +02:00
Damien Arrachequesne	f223178eb6	fix: prevent the socket from joining a room after disconnection Calling `socket.join()` after disconnection would lead to a memory leak, because the room was never removed from the memory: ```js io.on("connection", (socket) => { socket.disconnect(); socket.join("room1"); // leak }); ``` Related: - https://github.com/socketio/socket.io/issues/4067 - https://github.com/socketio/socket.io/issues/4380 Backported from `18f3fdab12`	2022-06-26 08:54:51 +02:00
Damien Arrachequesne	226cc16165	fix: only set 'connected' to true after middleware execution The Socket instance is only considered connected when the "connection" event is emitted, and not during the middleware(s) execution. ```js io.use((socket, next) => { console.log(socket.connected); // prints "false" next(); }); io.on("connection", (socket) => { console.log(socket.connected); // prints "true" }); ``` Related: https://github.com/socketio/socket.io/issues/4129 Backported from `02b0f73e2c`	2022-06-26 08:46:28 +02:00
Damien Arrachequesne	05e1278cfa	fix: fix race condition in dynamic namespaces Using an async operation with `io.use()` could lead to the creation of several instances of a same namespace, each of them overriding the previous one. Example: ```js io.use(async (nsp, auth, next) => { await anOperationThatTakesSomeTime(); next(); }); ``` Related: https://github.com/socketio/socket.io/issues/4136 Backported from `9d86397243`	2022-06-26 08:41:16 +02:00
Damien Arrachequesne	22d4bdf00d	fix: ignore packet received after disconnection Related: https://github.com/socketio/socket.io/issues/3095 Backported from `494c64e44f`	2022-06-26 08:35:42 +02:00
Damien Arrachequesne	dfded53593	chore: update engine.io version to 3.6.0 Release notes: https://github.com/socketio/engine.io/releases/tag/3.6.0 Diff: https://github.com/socketio/engine.io/compare/3.5.0...3.6.0	2022-06-26 08:13:06 +02:00
Damien Arrachequesne	e6b869738c	chore(release): 2.4.1 Diff: https://github.com/socketio/socket.io/compare/2.4.0...2.4.1	2021-01-07 10:59:46 +01:00
Damien Arrachequesne	a169050947	revert: fix(security): do not allow all origins by default This reverts commit `f78a575f66`. This commit contains a breaking change which deviates from semver, which we try to follow as closely as possible. That's why this change is reverted and we will rather suggest users to upgrade to v3. Related: https://github.com/socketio/socket.io/discussions/3741	2021-01-07 10:51:55 +01:00
Damien Arrachequesne	873fdc55ed	chore(release): 2.4.0 Diff: https://github.com/socketio/socket.io/compare/2.3.0...2.4.0	2021-01-05 00:27:13 +01:00
Damien Arrachequesne	f78a575f66	fix(security): do not allow all origins by default BREAKING CHANGE: previously, all origins were allowed by default, which meant that a Socket.IO server sent the necessary CORS headers (`Access-Control-Allow-xxx`) to any domain by default. Please note that you are not impacted if: - you are using Socket.IO v2 and the `origins` option to restrict the list of allowed domains - you are using Socket.IO v3 (disabled by default) This commit also removes the support for '' matchers and protocol-less URL: ``` io.origins('https://example.com:443'); => io.origins(['https://example.com']); io.origins('localhost:3000'); => io.origins(['http://localhost:3000']); io.origins('http://localhost:'); => io.origins(['http://localhost:3000']); io.origins('*:3000'); => io.origins(['http://localhost:3000']); ``` To restore the previous behavior (please use with caution): ```js io.origins((_, callback) => { callback(null, true); }); ``` See also: - https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS - https://socket.io/docs/v3/handling-cors/ - https://socket.io/docs/v3/migrating-from-2-x-to-3-0/#CORS-handling Thanks a lot to https://github.com/ni8walk3r for the security report.	2021-01-04 22:34:09 +01:00
Sebastiaan Marynissen	d33a619905	fix: properly overwrite the query sent in the handshake The `query` option of the Manager had the priority over the one of the Socket instance, which meant updating the Socket#query object on the client-side was not reflected in the Socket#handshake object on the server-side. Please note that the behavior of the `query` option is still a bit weird in Socket.IO v2, as it only applies to non-default namespace. This is fixed in v3: - https://socket.io/docs/v3/migrating-from-2-x-to-3-0/#Add-a-clear-distinction-between-the-Manager-query-option-and-the-Socket-query-option - https://socket.io/docs/v3/middlewares/#Sending-credentials Fixes https://github.com/socketio/socket.io/issues/3495	2021-01-04 11:34:24 +01:00
Damien Arrachequesne	3951a79359	chore: bump engine.io version Diff: https://github.com/socketio/engine.io/compare/3.4.2...3.5.0	2021-01-04 10:50:13 +01:00
Damien Arrachequesne	6fa026fc94	ci: migrate to GitHub Actions Due to the recent changes to the Travis CI platform (see [1]), we will now use GitHub Actions to run the tests. Reference: https://docs.github.com/en/free-pro-team@latest/actions/guides/building-and-testing-nodejs [1]: https://blog.travis-ci.com/2020-11-02-travis-ci-new-billing	2021-01-04 10:46:44 +01:00
Damien Arrachequesne	47161a65d4	[chore] Release 2.3.0 Diff: https://github.com/socketio/socket.io/compare/2.2.0...2.3.0	2019-09-20 12:18:39 +02:00
Damien Arrachequesne	cf39362014	[chore] Bump socket.io-parser to version 3.4.0 Diff: https://github.com/socketio/socket.io-parser/compare/3.3.0...3.4.0	2019-09-20 11:04:11 +02:00
flaambe	4d01b2c84c	test: remove deprecated Buffer usage (#3481 )	2019-09-20 10:50:12 +02:00
Jonatan Juárez	82271921db	[docs] Fix the default value of the 'origins' parameter (#3464 ) Fix documentation about default origins value. The default should read `:` instead of `*	2019-09-20 10:37:54 +02:00
Damien Arrachequesne	1150eb50e9	[chore] Bump engine.io to version 3.4.0 Diff: https://github.com/socketio/engine.io/compare/3.3.1...3.4.0	2019-09-20 10:31:25 +02:00
Grant Timmerman	9c1e73c752	[chore] Update the license of the chat example (#3410 ) There was no obvious reason to use BSD instead of MIT for that very basic chat app. Closes #3411	2019-03-15 22:22:22 +01:00
Damien Arrachequesne	df05b73bb9	[chore] Release 2.2.0	2018-11-29 00:00:45 +01:00
Markko Legonkov	b00ae50be6	[feat] Add cache-control header when serving the client source (#2907 )	2018-11-20 08:02:04 +01:00
Nadir Hussain Laskar	d3c653d876	[docs] Add Touch Support to the whiteboard example (#3104 )	2018-11-20 08:01:09 +01:00
Antonio	a7fbd1ac4a	[fix] Throw an error when trying to access the clients of a dynamic namespace (#3355 ) Accessing the clients of a dynamic namespace throws because doing `io.of(/your-regex/g)` returns a namespace with no adapter and the clients methods tries to access `namespace.adapter.clients`.	2018-11-20 07:40:11 +01:00
Damien Arrachequesne	190d22b46e	[chore] Bump dependencies - engine.io: https://github.com/socketio/engine.io/compare/3.2.0...3.3.1 - socket.io-parser: https://github.com/socketio/socket.io-parser/compare/3.2.0..3.3.0	2018-11-20 07:33:41 +01:00
Damien Arrachequesne	7b8fba7ea2	[test] Update Travis configuration Reference: https://github.com/nodejs/Release	2018-11-20 07:32:39 +01:00
Emmanuel DEMEY	e5f0ceaee0	[docs] Use new JavaScript syntax inside the README (#3360 )	2018-11-08 00:26:54 +01:00
Damien Arrachequesne	7e35f901b8	[docs] fix `this` scope in the chat example `user is typing` messages were not properly removed Closes #3291	2018-08-28 09:05:44 +02:00
Damien Arrachequesne	2dbec77a38	[chore] Update issue template	2018-08-21 13:21:14 +02:00
Andrew Stelmach	d97d873aee	[docs] update README.md (#3309 )	2018-08-18 23:32:07 +02:00
Damien Arrachequesne	e0b2cb0c5a	[chore] Release 2.1.1	2018-05-17 23:22:49 +02:00
Sleiman Sleiman	1decae341c	[feat] Add local flag to the socket object (#3219 ) To match the behaviour on the namespace (see #2628).	2018-04-27 13:03:25 +02:00
Donut	0279c47c8c	[docs] Convert the chat example to ES6 (#3227 )	2018-04-27 13:00:27 +02:00
Damien Arrachequesne	2917942b3e	[docs] Clarify private messaging in the emit cheatsheet (#3232 ) The previous version was confusing, as `socket.to(socket.id).emit()` does nothing. Fixes #3220	2018-04-27 12:50:31 +02:00
Damien Arrachequesne	db831a3de4	[chore] Release 2.1.0	2018-03-29 23:30:03 +02:00
Damien Arrachequesne	ac945d1eba	[feat] Add support for dynamic namespaces (#3195 ) This follows #3187, with a slightly different API. A dynamic namespace can be created with: ```js io.of(/^\/dynamic-\d+$/).on('connect', (socket) => { /* ... */ }); ```	2018-03-29 23:08:08 +02:00
Scott Gress	ad0c052eff	[docs] Add note in docs for `origins(fn)` about `error` needing to be a string. (#2895 )	2018-03-10 09:03:28 +01:00
Damien Arrachequesne	1f1d64bab6	[fix] Include the protocol in the origins check (#3198 ) Previously, the protocol was not taken in account, which caused the following behaviour: ```js io.origins('https://foo.example.com:443'); // ok as a string io.origins(['https://foo.example.com:443'); // not ok as an array ``` Fixes #3190	2018-03-10 08:56:42 +01:00
Damien Arrachequesne	f4fc517e0f	[fix] Properly emit 'connect' when using a custom namespace (#3197 ) When using a custom namespace with a middleware, the client did not receive the 'connect' event. Fixes #3082	2018-03-10 08:51:22 +01:00
Jumper Chen	be61ba0a20	[docs] Add link to a Dart client implementation (#2940 )	2018-03-01 00:23:45 +01:00
Damien Arrachequesne	c0c79f019e	[feat] Add support for dynamic namespaces (#3187 )	2018-03-01 00:22:16 +01:00
Damien Arrachequesne	dea5214f21	[chore] Bump superagent and supertest versions (#3186 )	2018-02-28 23:19:19 +01:00
Damien Arrachequesne	b1941d5dfe	[chore] Bump engine.io to version 3.2.0	2018-02-28 23:10:40 +01:00
Miguel Piedrafita	a23007a635	[docs] Update license year (#3153 )	2018-02-28 23:03:02 +01:00
Damien Arrachequesne	f48a06c040	[feat] Add a 'binary' flag (#3185 ) So that the call to the `has-binary` method can be skipped. Usage: ``` // with binary data socket.binary(true).emit("binary", obj); // without binary data socket.binary(false).emit("string", obj); // call to hasBin socket.emit("guess", obj); ```	2018-02-28 23:00:16 +01:00
Damien Arrachequesne	0539a2c4fd	[test] Update travis configuration	2018-02-28 22:56:28 +01:00
Devlin Pajaron	c06ac071d0	[docs] Fix typo (#3157 )	2018-02-25 09:26:24 +01:00
Damien Arrachequesne	52b09609db	[chore] Bump debug to version 3.1.0	2018-02-25 09:22:40 +01:00
Damien Arrachequesne	1c108a35e4	[chore] Release 2.0.4	2017-10-22 15:16:29 +02:00
Thiago Santos	f333479080	[test] Use npm scripts instead of gulp (#3078 )	2017-10-16 07:46:42 +02:00
Carson McKinstry	3f611654f2	[docs] Fix a grammar mistake in the API docs (#3076 )	2017-10-07 15:08:14 +02:00
Vyacheslav Aristov	e26b71c78e	[docs] Fix typo in API docs (#3066 )	2017-10-07 14:36:02 +02:00
Haku	3386e155a8	[docs] Actually prevent input from having injected markup in chat example (#2987 )	2017-08-27 08:40:26 +02:00
Stanley288	3684d590f5	[docs] Use path.join instead of concatenating paths (#3014 )	2017-08-26 07:44:25 +02:00
Damien Arrachequesne	dd69abbeee	[fix] Reset rooms object before broadcasting from namespace (#3039 )	2017-08-26 07:36:26 +02:00
Damien Arrachequesne	1f0e64a6da	[fix] Do not throw when receiving an unhandled error packet (#3038 )	2017-08-26 07:35:57 +02:00
Gabriel Hautclocq	9d170a75d0	[docs] Add io.emit in the cheat sheet (#2992 )	2017-07-01 07:57:34 +02:00
Nicolas Coden	7199d1b6ef	[docs] Fix misnamed 'Object.keys' in API docs (#2979 )	2017-06-19 12:16:26 +02:00
Damien Arrachequesne	bf7afb14cb	[docs] Update Webpack server example (#2976 )	2017-06-15 23:40:43 +02:00
Damien Arrachequesne	410f5bcb8e	[docs] Update API documentation (#2973 )	2017-06-13 23:05:26 +02:00
Damien Arrachequesne	65ece01135	[chore] Release 2.0.3	2017-06-12 14:05:46 +02:00
Damien Arrachequesne	db0c69969e	[fix] Reset rooms object before broadcasting (#2970 ) It seems packets could be delivered to wrong room in some case, if the _rooms array was not reset before the next emit.	2017-06-12 14:01:35 +02:00
Damien Arrachequesne	94df7bcdfd	[fix] Fix middleware initialization (#2969 ) Fix "TypeError: Cannot convert undefined or null to object" when a middleware is added before the engine is properly attached.	2017-06-12 14:00:48 +02:00
Ra'Shaun Stovall	9a014e2df4	[docs] Update slack badge (#2961 ) Update badge to https://slackin-socketio.now.sh/badge.svg	2017-06-08 12:28:56 +02:00
Damien Arrachequesne	2b10f1b3a4	[docs] Update webpack example (#2960 )	2017-06-03 13:53:03 +02:00
Damien Arrachequesne	a10dc8d92d	[chore] Release 2.0.2	2017-06-01 14:01:24 +02:00
Damien Arrachequesne	2b216902e1	[fix] Fix timing issues with middleware (#2948 ) Using a middleware could previously lead to a connecting client receiving a connect event from the server before the server triggers its own connect event.	2017-05-22 13:01:59 +02:00
Damien Arrachequesne	832b8fc6d9	[chore] Release 2.0.1	2017-05-09 01:40:46 +02:00
Damien Arrachequesne	a0056904c1	[fix] Update path of client file (#2934 )	2017-05-09 01:36:40 +02:00
Damien Arrachequesne	3367eaa948	[chore] Release 2.0.0	2017-05-09 01:09:19 +02:00
Damien Arrachequesne	6c0705f733	[docs] Add an example of custom parser (#2929 )	2017-05-09 00:46:01 +02:00
Damien Arrachequesne	1980fb4a03	[chore] Merge history of 1.7.x and 0.9.x branches (#2930 )	2017-05-09 00:45:17 +02:00
Xavier Damman	0d07c47f81	[chore] Added backers and sponsors on the README (#2933 )	2017-05-09 00:41:46 +02:00
Damien Arrachequesne	a086588747	[chore] Bump dependencies (#2926 )	2017-04-28 22:33:40 +02:00
Damien Arrachequesne	87b06ad362	[feat] Move binary detection to the parser (#2923 )	2017-04-25 00:38:07 +02:00
Caleb	199eec648e	[docs] Replace non-breaking space with proper whitespace (#2913 )	2017-04-19 22:19:57 +02:00
Faraz Patankar	f1b39a6b1d	[docs] Update emit cheatsheet (#2906 )	2017-04-03 07:20:38 +02:00
Damien Arrachequesne	240b154960	[docs] Explicitly document that Server extends EventEmitter (#2874 )	2017-03-29 14:13:04 +02:00
efkan	c5b7738730	[docs] Add server.engine.generateId attribute (#2880 )	2017-03-29 13:52:07 +02:00
Simen Bekkhus	03f3bc9ab3	[docs] Fix wrong space character in README (#2900 )	2017-03-27 13:15:19 +02:00
SwhGo_oN	e40accf7a1	[docs] Fix documentation for 'connect' event (#2898 )	2017-03-19 00:33:59 +01:00
Damien Arrachequesne	01a4623613	[feat] Allow to join several rooms at once (#2879 )	2017-02-26 09:15:32 +01:00
Damien Arrachequesne	2d5b0026c5	[docs] Add webpack build example (#2828 )	2017-02-22 12:48:46 +01:00
Damien Arrachequesne	5ae06e6285	[chore] Bump socket.io-adapter to version 1.0.0 (#2867 )	2017-02-17 07:33:43 +01:00
sgress454	4d8f68c7dc	[chore] Bump engine.io to version 2.0.2 (#2864 ) Includes the following (from engine.io changelog): * [fix] Initialize the WebSocket server in the Server constructor (#476) * [chore] Bump ws to version 1.1.2 (vulnerability fix) (#480)	2017-02-16 22:01:53 +01:00
Tim Ruffles	5b79ab1af1	[docs] Update the wording to match the code example (#2853 )	2017-02-13 23:52:07 +01:00
Damien Arrachequesne	54ff591b07	[feature] Merge Engine.IO and Socket.IO handshake packets (#2833 )	2017-02-01 15:28:14 +01:00
H3rby7	e1facd5155	[docs] Small addition to the Express Readme Part (#2846 )	2017-02-01 15:23:56 +01:00
Damien Arrachequesne	3b92cc2b26	[feature] Allow the use of custom parsers (#2829 )	2017-01-24 07:10:19 +01:00
Damien Arrachequesne	3d695c60f1	[chore] Bump engine.io to version 2.0.0 (#2832 )	2017-01-23 23:16:51 +01:00
Antoine LUCAS	3b5f4339a7	[fix] Use path.resolve by default and require.resolve as a fallback (#2797 ) Browserify doesn't support require.resolve, and as a consequence, makes nexe fail the compilation. This PR attempts to get the path of the socket.io-client file via path.resolve and falls back to the original require.resolve if this file cannot be found.	2017-01-22 07:21:45 +01:00
Damien Arrachequesne	23c9dd34d5	[docs] Add a 'Features' section in the README (#2824 )	2017-01-16 23:16:46 +01:00
Damien Arrachequesne	e28b475428	[docs] Add httpd cluster example (#2819 )	2017-01-16 08:33:22 +01:00
Damien Arrachequesne	f7eed6e397	[docs] Add haproxy cluster example (#2818 )	2017-01-16 08:33:09 +01:00
Damien Arrachequesne	988852986a	[docs] Add nginx cluster example (#2817 )	2017-01-16 08:32:53 +01:00
Damien Arrachequesne	8eaba085de	[docs] Implement whiteboard example (#2810 )	2017-01-16 08:32:33 +01:00
Tom Atkinson	2258a6a6e3	[fix] Properly close the connection on error (#2681 )	2017-01-16 08:29:11 +01:00
Tom Atkinson	ad658b8cc2	[perf] Use shared instance of the encoder (#2825 )	2017-01-16 08:25:52 +01:00
Tom Atkinson	e24434a0a0	[perf] Reset properties instead of deleting them (#2826 ) Deleting properties is a v8 'optimization killer'	2017-01-16 08:23:22 +01:00
Damien Arrachequesne	b754cff2b4	[docs] Fix documentation for `local` flag (#2816 )	2017-01-10 18:10:56 +01:00
Damien Arrachequesne	706ca2a0c1	[docs] Add emit cheatsheet (#2815 )	2017-01-10 17:54:09 +01:00
Damien Arrachequesne	accd0bd64a	[docs] Add pingInterval/pingTimeout/transports options in the API documentation (#2814 )	2017-01-10 17:50:38 +01:00
Damien Arrachequesne	131a2befec	[docs] Add an example for socket.join() method (#2813 )	2017-01-10 17:46:54 +01:00
Damien Arrachequesne	0be865f614	[docs] Fix a typo on `clients` method in the API documentation (#2812 )	2017-01-10 17:41:31 +01:00
Damien Arrachequesne	01b262fbe0	[chore] Update issue template with fiddle (#2811 )	2017-01-10 10:16:27 +01:00
Bella	f260439933	[chore] Update copyright year LICENSE to 2017 (#2803 )	2017-01-06 17:11:03 +01:00
Andrea Accardo	e04de3c2c8	[docs] Fix wrong argument name in API.md (#2802 )	2017-01-04 06:37:12 +01:00
Ian Bro	a27802e19e	[fix] Prevent null from being accepted as argument (#2606 )	2016-12-30 16:22:16 +01:00
Gatsbill	c46d4481bd	[perf] micro-optimisations (#2793 )	2016-12-30 16:18:09 +01:00
bananaapple	d82190016f	[docs] Add install script on Readme.md (#2780 )	2016-12-30 16:11:26 +01:00
Damien Arrachequesne	255b845596	[docs] API documentation (#2784 )	2016-12-30 16:10:54 +01:00
				`@@ -0,0 +1,2 @@`

				`module.exports = function () { return function () {}; };`