cantina-socket.io

Socket.io for Cantina

Dependencies

• app.server - A Server object that eventually starts listening.

Provides

• app.io - And socket.io instance.

Hooks

• io:handshake (socket, cb) - Operate on a socket object right after connection.

Events

• io:listening - The server is now listening for socket connections.
• io:connected (socket) - A new socket connection was made.
• io:disconnected (socket) - A socket was disconnected.

Configuration

Any configuration specified for the socket.io conf key will be passed to the socket.io initialization.

Usage

Your app can implement a hook for io:handshake if it needs to perform any socket handshaking.

Example

app.hook('io:handshake').add(function(socket, next) {
  // If the socket should be denied then call done with the appropriate error.
  next(new Error('Handshake error for socket: ' + JSON.stringify(socket)));
 
  // Do other stuff.
 
  // Finish the handshake.
  next();
});

---

Developed by Terra Eclipse

Terra Eclipse, Inc. is a nationally recognized political technology and strategy firm located in Aptos, CA and Washington, D.C.

---

License: MIT

Copyright (C) 2015 Terra Eclipse, Inc. (http://www.terraeclipse.com)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.