RPC WebSocket is a wrapper for standard websockets that adds support for message types, RPC, and for before/after send/receive events. It is an alternative to ajax, socket.io, and JSON-RPC.

eriksank

rpc-websocket

_RPC WebSocket_ is a wrapper for standard websockets that adds support for message types, RPC, and for before/after send/receive events.

_RPC WebSocket_ is a wrapper for standard websockets that adds support for message types, RPC, and for before/after send/receive events. It is an alternative to ajax, socket.io, and JSON-RPC.

        "description" : "RPC WebSocket is a wrapper for standard websockets that adds support for message types, RPC, and for before/after send/receive events.",

        "description" : "RPC WebSocket is a wrapper for standard websockets that adds support for message types, RPC, and for before/after send/receive events. It is an alternative to ajax, socket.io, and JSON-RPC.",

        "author" : "Erik Poupaert <erik@sankuru.biz>",

          "url": "git@github.com:eriksank/rpc-websocket.git"

          "url": "https://github.com/eriksank/rpc-websocket/issues"

                "underscore" : "jashkenas/underscore",

                "eventemitter4" : "eriksank/EventEmitter4"

                "engine.io" : "Automattic/engine.io",

                "engine.io-client": "Automattic/engine.io-client"

2.1\.  [The short story](#theshortstory)  

4\.  [Browser support](#browsersupport)  

5.1\.  [Running the examples](#runningtheexamples)  

6\.  [Events supported](#eventssupported)  

7.1.1\.  [RpcSocket(webSocket)](#rpcsocketwebsocket)  

7.1.2\.  [send(messageType, userData)](#sendmessagetypeuserdata)  

7.1.3\.  [rpc(messageType, userData, replyHandler)](#rpcmessagetypeuserdatareplyhandler)  

7.2.1\.  [RpcServer(server)](#rpcserverserver)  

8\.  [Development tools](#developmenttools)  

11.1\.  [What is wrong with ajax](#whatiswrongwithajax)  

11.2\.  [What is wrong with JSON-RPC](#whatiswrongwithjson-rpc)  

11.3\.  [What is wrong with socket.io](#whatiswrongwithsocket.io)  

13\.  [Other publications](#otherpublications)  

Distributed computing allows for distributed lambdas (=functions). If invoking a local function, looks like this:

In that case, the same function invocation, as function doing the computation on a remote server, that is, a Remote Procedure Call (RPC) looks like that:

_Rpc WebSocket_ allows you to make remote function calls over a websocket.

* *message types*: Each message is always assigned a type. This allows us to transparently route messages to different handler functions.

* *RPC*: This feature implements the ability to call functions on the server using websockets. It is an alternative to ajax and to JSON-RPC.

* *before/after send/receive events*: For the purposes of logging, encryption, and compression, we need the ability to intercept incoming and outgoing messages before they are delivered to their handler functions. Depending on the application, there may be other reasons to apply wholesale changes to each incoming or outgoing message. We could, for example, add validation logic before sending messages.

I have tested _Rpc WebSocket_ with the [engine.io](https://github.com/Automattic/engine.io) and [engine.io-client](https://github.com/Automattic/engine.io-client) transport mechanisms, but you should most likely be able to use alternative websocket implementations.

You can install _RPC-WebSocket_ with *npm*:

If you want to use *engine.io* on the server side as the transport layer, you can install it with *npm*:

On the client side you can use *engine.io-client*:

The module comes with a _browserified_ version:

        browser-support/rpc-websocket-bundle.js

        browser-support/rpc-websocket-bundle.min.js

You can use _RPC WebSocket_ directly in the browser like this:

var webSocket = new WebSocket('ws://html5rocks.websocket.org/echo');

In order to support older browsers, you may want to use something like the _engine.io-client_ wrapper for the browser. In older browsers, it will simulate the websocket logic using older transmission mechanisms.

Open two terminals. In order to run example 1, in one terminal, start the server:

In the other terminal, you can execute the client:

		{
		"name" : "rpc-websocket",
		"version": "0.7.4",
		"description" : "RPC WebSocket is a wrapper for standard websockets that adds support for message types, RPC, and for before/after send/receive events.",
		"version": "0.7.5",
		"description" : "RPC WebSocket is a wrapper for standard websockets that adds support for message types, RPC, and for before/after send/receive events. It is an alternative to ajax, socket.io, and JSON-RPC.",
		"author" : "Erik Poupaert <erik@sankuru.biz>",
		@@ -6,0 +6,0 @@ "main" : "index.js",

		@@ -43,3 +43,3 @@ #RPC WebSocket
		##1\. Synopsis
		_RPC WebSocket_ is a wrapper for standard websockets that adds support for message types, RPC, and for before/after send/receive events.
		_RPC WebSocket_ is a wrapper for standard websockets that adds support for message types, RPC, and for before/after send/receive events. It is an alternative to ajax, socket.io, and JSON-RPC.

		@@ -46,0 +46,0 @@

		##Synopsis
		_RPC WebSocket_ is a wrapper for standard websockets that adds support for message types, RPC, and for before/after send/receive events.
		_RPC WebSocket_ is a wrapper for standard websockets that adds support for message types, RPC, and for before/after send/receive events. It is an alternative to ajax, socket.io, and JSON-RPC.

Improved metrics