socket.io/Readme.md

socket.io

How to use

var http = require('http').Server();
var sockets = require('socket.io')(http);
sockets.on('connection', function(socket){
  socket.on('event', function(data){});
  socket.on('disconnect', function(){});
});

API

Server

Exposed by require('socket.io').

Server()

Creates a new Server. Works with and without new:

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:

• static sets the value for Server#static()
• path sets the value for Server#path()

Options are always passed to the engine.io Server that gets created.

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#static(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.

// pass a server and the `static` option
var io = require('socket.io')(http, { static: false });

// or pass no server and then you can call the method
var io = require('socket.io')();
io.static(false);
io.attach(http);

Server#path(v:String):Server

Sets the path v under which engine.io and the static files will be served. Defaults to /socket.io.

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#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 right away.

Server#emit

Emits an event to all connected clients. The following two are equivalent:

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.

Namespace

Represents a pool of sockets connected under a given scope identified by a pathname (eg: /chat).

By default the client always connects to /.

Namespace#name:String

The namespace identifier property.

License

MIT