Node DDP Client
A callback style DDP (Meteor's Distributed Data Protocol) node client, originally based alansikora's node-js_ddp-client and Meteor's python client. Uses a more callback style approach.
The client implements version 1 of DDP, as well as fallbacks to pre1 and pre2.
Installation
npm install ddp
Authentication
Built-in authentication support was removed in ddp 0.7.0 due to changes in Meteor version 0.8.2.
One can authenticate using plain-text logins as follows:
// logging in with e-mailddpclient; // logging in with usernameddpclient;
You can also use vsivsi/ddp-login.
Example
Please see the example in examples/example.js
. Or here for reference:
var DDPClient = ; var ddpclient = // All properties optional, defaults shown host : "localhost" port : 3000 ssl : false autoReconnect : true autoReconnectTimer : 500 maintainCollections : true ddpVersion : '1' // ['1', 'pre2', 'pre1'] available // uses the SockJs protocol to create the connection // this still uses websockets, but allows to get the benefits // from projects like meteorhacks:cluster // (for load balancing and service discovery) // do not use `path` option when you are using useSockJs useSockJs: true // Use a full url instead of a set of `host`, `port` and `ssl` // do not set `useSockJs` option if `url` is used url: 'wss://example.com/websocket'; /* * Connect to the Meteor Server */ddpclient; /* * Useful for debugging and learning the ddp protocol */ddpclient; /* * Close the ddp connection. This will close the socket, removing it * from the event-loop, allowing your application to terminate gracefully */ddpclient; /* * If you need to do something specific on close or errors. * You can also disable autoReconnect and * call ddpclient.connect() when you are ready to re-connect.*/ddpclient; ddpclient; /* * You can access the EJSON object used by ddp. */var oid = ;
SockJS Mode
By using the useSockJs
option like below, DDP connection will use SockJs protocol to establish the WebSocket connection.
var ddpClient = useSockJs: true ;
Meteor server uses SockJs to implement it's DDP server. With this mode, we can get the benefits provided by meteorhacks:cluster. Some of those are load balancing and service discovery.
- For load balancing you don't need to anything.
- For service discovery, just use the
path
option to identify the service you are referring to.
With this mode,
path
option has a special meaning. So, thing twice before usingpath
option when you are using this option.
Unimplemented Features
The node DDP client does not implement ordered collections, something that while in the DDP spec has not been implemented in Meteor yet.
Thanks
Many thanks to Alan Sikora for the ddp-client which formed the inspiration for this code.
Contributions:
- Tom Coleman (@tmeasday)
- Thomas Sarlandie (@sarfata)
- Mason Gravitt (@emgee3)
- Mike Bannister (@possiblities)
- Chris Mather (@eventedmind)
- James Gill (@jagill)
- Vaughn Iverson (@vsivsi)