Skip to content

Commit f46760b

Browse files
gvilarinoindutny
authored andcommitted
package: node version requirement >= 0.12.0
1 parent d8cc578 commit f46760b

File tree

2 files changed

+15
-3
lines changed

2 files changed

+15
-3
lines changed

README.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
# Sticky session
22

3-
A simple performant way to use [socket.io](http://socket.io/) with a
4-
[cluster](http://nodejs.org/docs/latest/api/cluster.html).
3+
A simple performant way to use [socket.io][0] with a [cluster][1].
54

65
## Installation
76

@@ -39,6 +38,14 @@ Sticky-sessions module is balancing requests using their IP address. Thus
3938
client will always connect to same worker server, and socket.io will work as
4039
expected, but on multiple processes!
4140

41+
#### Note about `node` version
42+
43+
`sticky-session` requires `node` to be at least `0.12.0` because it relies on
44+
`net.createServer`'s [`pauseOnConnect` flag][2].
45+
46+
A deeper, step-by-step explanation on how this works can be found in
47+
[`elad/node-cluster-socket.io`][3]
48+
4249
#### LICENSE
4350

4451
This software is licensed under the MIT License.
@@ -63,3 +70,8 @@ NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
6370
DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
6471
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
6572
USE OR OTHER DEALINGS IN THE SOFTWARE.
73+
74+
[0]: http://socket.io/
75+
[1]: http://nodejs.org/docs/latest/api/cluster.html
76+
[2]: https://nodejs.org/api/net.html#net_net_createserver_options_connectionlistener
77+
[3]: https://github.com/elad/node-cluster-socket.io

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
"ip": "^1.0.0"
99
},
1010
"engines": {
11-
"node": ">= 0.6.0"
11+
"node": ">= 0.12.0"
1212
},
1313
"devDependencies": {
1414
"debug": "^2.2.0",

0 commit comments

Comments
 (0)