ObjDist
Distributes objects between server and clients via Socket.IO-socket-like transports. Works on a KVCObject, by opening a channel on each node in the object tree, streaming only relevant, minimal updates in each channel.
Use ObjSync on clients in order to receive.
Public API
- (constructor)(< Socket.IO-server-like>transport, [< object >options])
Creates and returns a new ObjDist object, which communicates viatransport
.
Valid options:- prefix - string - prefix to all channel names. Cannot be empty string. Default: 'root'
Inherits all methods of KVCObject. All updates are automatically (and minimally) synced.
Example
Server-side
var io = ;var ObjDist = ; var transport = io;var dist = transport; dist;
Client-side A, connecting to root, receiving all updates
var io = ;var ObjSync = ; var transport = io;var sync = transport; sync;
Client-side B, connection to root/person, receiving only updates in the
person
-subtree
var io = ;var ObjSync = ; var transport = io;var sync = transport; sync;