# socket.io-rpc [](http://badge.fury.io/js/socket.io-rpc)
Minimalistic remote procedure call(RPC/RMI) library bootstrapped on socket.io and when.js. Has two client libraries-one for general use, other for AngularJS.
Whole library is heavily depending on promises. When calling over network, promise is always returned.
## ChangeLog
0.0.8 -> 0.0.9 Switched from Q to when.js for better performance
0.1.3 -> 0.1.4 Added a directive to angularJS client to make instantiating a controller with rpc channel less of a chore
## Browser support
numbers are for standalone client(author's guess):
IE FIREFOX SAFARI CHROME OPERA IPHONE ANDROID
8.0+ 3.5+ 4.0+ 4.0+ 10.5+ 2.0+ 2.0+
## Usage example
###Serverside
var io = require('socket.io').listen(server);
var when = require('when'); // you can use any other http://promises-aplus.github.io/promises-spec/ compliant library
var rpc = require('socket.io-rpc');
rpc.createServer(io, app);
rpc.expose('myChannel', {
//plain JS function
getTime: function () {
return new Date();
},
//returns a promise, which when resolved will resolve promise on client-side with the result
myAsyncTest: function (param) {
var deffered = when.defer();
setTimeout(function(){
deffered.resolve("String generated asynchronously serverside with " + param);
},1000);
return deffered.promise;
}
});
io.sockets.on('connection', function (socket) {
rpc.loadClientChannel(socket,'clientChannel', function (socket, fns) {
fns.fnOnClient("calling client ").then(function (ret) {
console.log("client returned: " + ret);
});
});
});
###In browser
// for optimal performace download and use here minified version, use this for development or for non-performance critical scenarios
###In browser for AngularJS
Angular socket.io-rpc test/showcase
getTime:
asyncTest: {{ asyncTest }}
###With authentication (server)
rpc.expose('myChannel', {
...
},
function (handshake, callback) {
console.dir(handshake);
if (handshake.pswd === 'super secret password') { //or any other kind of logic you need
callback(true);
} else {
callback(false);
}
}
);
###With authentication (browser)
RPC.loadChannel('myChannel', { pswd: "super secret password" }).then(
function (channel) {
...
}
);