https://github.com/lependu/fastify-wamp-router

Web Application Messaging Protocol router for fastify
https://github.com/lependu/fastify-wamp-router

broker dealer fastify-plugin nodejs publish-subscribe rpc-server wamp-router

Last synced: 2 months ago
JSON representation

Web Application Messaging Protocol router for fastify

• Host: GitHub
• URL: https://github.com/lependu/fastify-wamp-router
• Owner: lependu
• License: mit
• Created: 2018-06-25T13:19:55.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2020-05-11T17:17:50.000Z (over 4 years ago)
• Last Synced: 2024-10-07T17:19:49.485Z (3 months ago)
• Topics: broker, dealer, fastify-plugin, nodejs, publish-subscribe, rpc-server, wamp-router
• Language: JavaScript
• Homepage:
• Size: 15.6 KB
• Stars: 8
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# fastify-wamp-router

[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](http://standardjs.com/)

[![Build Status](https://travis-ci.org/lependu/fastify-wamp-router.svg?branch=master)](https://travis-ci.org/lependu/fastify-wamp-router)

[![Greenkeeper badge](https://badges.greenkeeper.io/lependu/fastify-wamp-router.svg)](https://greenkeeper.io/)

[![Known Vulnerabilities](https://snyk.io/test/github/lependu/fastify-wamp-router/badge.svg)](https://snyk.io/test/github/lependu/fastify-wamp-router)

[![Coverage Status](https://coveralls.io/repos/github/lependu/fastify-wamp-router/badge.svg?branch=master)](https://coveralls.io/github/lependu/fastify-wamp-router?branch=master)

![npm](https://img.shields.io/npm/v/fastify-wamp-router.svg)

![npm](https://img.shields.io/npm/dm/fastify-wamp-router.svg)

WAMP *(Web Application Messaging Protocol)* router for fastify.

Under the hood it shares [ivaylopivanov/wamp-server](https://github.com/ivaylopivanov/wamp-server) instance,

which implements [Basic Profife](https://tools.ietf.org/html/draft-oberstet-hybi-tavendo-wamp-02#page-7)

following [WAMP](https://tools.ietf.org/html/draft-oberstet-hybi-tavendo-wamp-02) standards.

The options that you pass to `register` will be passed to the `wamp-server`.

## Versions

> :warning: Please, bear in mind, that `wamp-server` depends on `[email protected]` which requires `>[email protected]`.

| version | branch | fastify | wapm-server | ws | end of support |

|---------|--------|---------|-------------|----|----------------|  

|`0.3.x`  | [0.3.x](https://github.com/lependu/fastify-wamp-router/tree/0.3.x) | [1.x](https://github.com/fastify/fastify/tree/1.x) | [0.0.9](https://github.com/ivaylopivanov/wamp-server) | [6.x](https://github.com/websockets/ws) | 2019-09-01 |

|`>=0.4.0`| [master](https://github.com/lependu/fastify-wamp-router) | [2.x](https://github.com/fastify/fastify) | [0.0.9](https://github.com/ivaylopivanov/wamp-server) | [6.x](https://github.com/websockets/ws) |      TBD     |

## Install

```

$ npm i --save fastify-wamp-router 

```

## Example

```js

const Fastify = require('fastify')

const fastifyWamp = require('fastify-wamp-router')

const fastify = Fastify()

fastify.register('fastify-wamp', { 

  port 3443, 

  realms: ['fastify.wamp.pubsub', 'fastify.wamp.rpc'],

}

fastify.listen(3000)

```

You can connect to the router with any [authobahn.js](https://github.com/crossbario/autobahn-js) compatible library.

## Reference

- `port` `{number}` The port of the websocket connection.

- `realms` `{array|string}` The name(s) of the realm(s).

## Debugging

You can use the `DEBUG=wamp:*` environment variable.

## License

Licensed under [MIT](./LICENSE).