Skip to content

Latest commit

 

History

History
93 lines (60 loc) · 3.01 KB

README.md

File metadata and controls

93 lines (60 loc) · 3.01 KB
Raw

wamp1

Very simple WAMP v1 implementation

Build Status Coverage Status Dependency Status

Installation

$ npm install wamp1
$ component install Swatinem/wamp1

Rational

So far there is basically one WAMP implementation for the client side, AutobahnJS. It claims to be tiny without dependencies. It is actually >100K with a lot of dependencies embedded. Plus it has a very ugly promises-based API.

I think I can do better :-)

note: This only implements WAMP1, which is fundamentally different from the still working draft WAMP2, which is a lot more complex.

note: This does not include WAMP-CRA, that should be a separate library on top of this one.

Usage

new Wamp(url, [options], [callback])

Creates a websocket connection to url and optionally calls callback with the resulting welcome message.

If options.omitSubscribe is set to true, subscribe and unsubscribe calls will not be sent to the server. The events however are routed to the specified callbacks. This is useful in case the server will send out events regardless of whether the client subscribed or not. It will simply reduce network chatter.

wamp.socket

This is the underlying WebSocket object. It is using ws in node and stagas/websocket in component, both of which have the same API.

wamp.on(event, callback)

Wamp will forward any event that was subcribed to to a generic event event. It will emit a error event in case the protocol version is not supported or in case the server sends callresults that were not requested.

wamp.sessionId

This property reflects the session id that the server generates and sends via the handshake.

wamp.subscribe(event, callback)

Subscribe to event on the server. The callback is called when the server sends that event.

wamp.unsubscribe(event, [callback])

Unsubscribe from event on the server. This takes care of multiple listeners for you.

wamp.publish(event, data, [excludeMe] | [exclude] , [eligible])

Publish an event with data to the server. See the spec for the optional arguments that control the users getting this event.

wamp.prefix(prefix, uri)

This registers the prefix as uri on the server. Really, using complete URIs as event identifiers is just overkill, better to use simple names to begin with.

wamp.call(method, [args…], callback(error, result))

This calls method remotely on the server, passing in args. The callback is called either with an error or with the result from the server.

License

LGPLv3

Released as free software as part of ChatGrape