Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
session middleware for socket.io
branch: master

This branch is even with turbonetix:master

Failed to load latest commit information.
lib fixed potential runtime error
spec fixed issue with sessin
.gitignore added dev env
.npmignore added dev env
.travis.yml added dev env
Gruntfile.coffee added dev env
LICENSE updated license
README.md updated doc
index.js added first test
package.json Updated deps

README.md

Build Status NPM version David DM

Session middleware for socket.io v1.x;

Examples

var socketSessions = require('socket.io-handshake');
var io = require('socket.io')(3000);
io.use( socketSessions() );

Using connect-redis for our session store.

var session = require('express-session');
var RedisStore = require('connect-redis')(session);
var sessionStore = new RedisStore();
var cookieParser = require('cookie-parser');
var socketHandshake = require('socket.io-handshake');

var io = require('socket.io')(3000);
io.use(socketHandshake({store: sessionStore, key:'sid', secret:'secret', parser:cookieParser()}));

To access the session data.

io.on('connection' function (sock) {
  if (!sock.handshake.session.name) {
    sock.emit('get name');
  };
  sock.on('set nama', function (name) {
    sock.handhsake.session.name = name;
    sock.handshake.session.save();
  });
});

Installation and Environment Setup

Install node.js (See download and install instructions here: http://nodejs.org/).

Clone this repository

> git clone git@github.com:turbonetix/socket.io-handshake.git

cd into the directory and install the dependencies

> cd socket.io-handshake
> npm install && npm shrinkwrap --dev

Running Tests

Install coffee-script

> npm install coffee-script -g

Tests are run using grunt. You must first globally install the grunt-cli with npm.

> sudo npm install -g grunt-cli

Unit Tests

To run the tests, just run grunt

> grunt spec

TODO

Something went wrong with that request. Please try again.