Backbone.ioBind

ioBind is a plugin for Backbone that makes it easy to bind Socket.io events to models and collections. This can be as easy as using the included replacement for Backbone.sync, or you can bind to your own events. Or both!

Latest Update to Github

Loading...
Loading...
Fork me on GitHub
git clone https://github.com/logicalparadox/backbone.iobind.git

ioBind

@param{ String }eventName
@param{ Object }iofrom active socket.io connection
@param{ Function }callback
@param{ Object }context(optional): Object to interpret as this on callback
@apipublic

Bind and handle trigger of socket.io event for collections.

Guidelines

Do NOT bind to reserved backbone events, such as change, remove, and add.

Proxy these events using different event tags such as update, delete, and create.

The socket.io socket must either exist at window.socket, Backbone.socket,
or this.socket or it must be passed as the second argument.

Example

  • Model definition has url: my_model
  • Model instance has id: abc123

Create a new bind (client-side):

model.ioBind('update', window.io, this.updateView, this);

Send socket.io message (server-side)

socket.emit( 'my_model/abc123:update', { title: 'My New Title' } );
View Source 
Backbone.Collection.prototype.ioBind = function (eventName, io, callback, context) {
  var ioEvents = this._ioEvents || (this._ioEvents = {})
    , globalName = this.url + ':' + eventName
    , self = this;
  if ('function' == typeof io) {
    context = callback;
    callback = io;
    io = this.socket || window.socket || Backbone.socket;
  }
  var event = {
    name: eventName,
    global: globalName,
    cbLocal: callback,
    cbGlobal: function (data) {
      self.trigger(eventName, data);
    }
  };
  this.bind(event.name, event.cbLocal, context);
  io.on(event.global, event.cbGlobal);
  if (!ioEvents[event.name]) {
    ioEvents[event.name] = [event];
  } else {
    ioEvents[event.name].push(event);
  }
  return this;
};

ioUnbind

@param{ String }eventName
@param{ Object }iofrom active socket.io connection
@param{ Function }callback(optional) If not provided will remove all callbacks for `eventName`
@apipublic

Unbind model triggers and stop listening for server events for a specific event
and optional callback.

The socket.io socket must either exist at window.socket, Backbone.socket,
or this.socket or it must be passed as the second argument.

View Source 
Backbone.Collection.prototype.ioUnbind = function (eventName, io, callback) {
  var ioEvents = this._ioEvents || (this._ioEvents = {})
    , globalName = this.url + ':' + eventName;
  if ('function' == typeof io) {
    callback = io;
    io = this.socket || window.socket || Backbone.socket;
  }
  var events = ioEvents[eventName];
  if (!_.isEmpty(events)) {
    if (callback && 'function' === typeof callback) {
      for (var i = 0, l = events.length; i < l; i++) {
        if (callback == events[i].cbLocal) {
          this.unbind(events[i].name, events[i].cbLocal);
          io.removeListener(events[i].global, events[i].cbGlobal);
          events[i] = false;
        }
      }
      events = _.compact(events);
    } else {
      this.unbind(eventName);
      io.removeAllListeners(globalName);
    }
    if (events.length === 0) {
      delete ioEvents[eventName];
    }
  }
  return this;
};

ioUnbindAll

@param{ Object }iofrom active socket.io connection
@apipublic

Unbind all callbacks and server listening events for the given model.

The socket.io socket must either exist at window.socket, Backbone.socket,
or this.socket or it must be passed as the only argument.

View Source 
Backbone.Collection.prototype.ioUnbindAll = function (io) {
  var ioEvents = this._ioEvents || (this._ioEvents = {});
  if (!io) io = this.socket || window.socket || Backbone.socket;
  for (var ev in ioEvents) {
    this.ioUnbind(ev, io);
  }
  return this;
};