# wamp.io

> Implementation of the WebSocket Application Messaging Protocol (WAMP) for WebSocket.IO or Engine.IO

Latest version **0.0.4** (published 2013-05-29) · 0 weekly downloads

## Install

```sh
npm install wamp.io
pnpm add wamp.io
yarn add wamp.io
bun add wamp.io
```

## Health

**Score 10/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; low quality score; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.4 |
| Published | 2013-05-29 |
| First published | 2012-05-14 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.6.0 |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Nico Kaiser |
| Maintainers | nicokaiser |

## Links

- npm: https://www.npmjs.com/package/wamp.io
- Repository: https://github.com/nicokaiser/wamp.io
- Issues: https://github.com/nicokaiser/wamp.io/issues
- npm.io page: https://npm.io/package/wamp.io

## Dependencies (2)

- [when](https://npm.io/package/when.md) *
- [debug](https://npm.io/package/debug.md) *

## Recent versions

- 0.0.4 (latest) — 2013-05-29
- 0.0.3 — 2013-03-06
- 0.0.2 — 2013-02-27
- 0.0.1 — 2012-05-14

## README

# WAMP.IO: Autobahn WebSockets RPC/PubSub

This is an implentation of the [WebSocket Application Messaging Protocol (WAMP)](http://www.tavendo.de/autobahn/protocol.html) proposed by Travendo.

It attaches to a [WebSocket server](https://github.com/einaros/ws/) and provides mechanisms for

- **Request and Response** and
- **Publish and Subscribe**

## Usage

### Simple PubSub server

By default, wamp.io provides a simple PubSub server that enables client to subscribe to any topic and to send events to any topic.

#### Attach WAMP to a WebSocket.IO server

```js
var wsio = require('websocket.io')
  , wamp = require('wamp.io');

var ws = wsio.listen(9000);
var app = wamp.attach(ws);
```

#### Attach WAMP to an Engine.IO server

```js
var eio = require('engine.io')
  , wamp = require('wamp.io');

var engine = eio.listen(9000);
var app = wamp.attach(engine);
```

### Simple RPC server

The server emits the `call` event when an RPC function is called. Results can be returned using the callback parameter.

```js
var wsio = require('websocket.io')
  , wamp = require('wamp.io');

var ws = wsio.listen(9000);
var app = wamp.attach(ws);

app.on('call', function(procUri, args, cb) {
  if (procUri === 'isEven') {
    cb(null, args[0] % 2 == 0);
  }
});
```

### Simple RPC client
```js
var when = require('when')
  , wamp = require('wamp.io');
  
var app = wamp.connect('ws://localhost:9000',
    // WAMP session was established
    function (session) 
    {
      console.log('new wamp session');
      
      session.call("test:isEven", 2)      
        .promise.then(
            // RPC success callback
            function (reply)
            {
              console.log("result: " + reply);
            },

            // RPC error callback
            function (error, desc) 
            {        
              console.log("error: " + desc);
            }
        );      
    },

    // WAMP session is gone
    function (session) 
    {
      console.log('wamp session is gone');
    }
  );  
```


## License 

(The MIT License)

Copyright (c) 2013 Nico Kaiser <nico@kaiser.me>

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
'Software'), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

---
_Source: https://npm.io/package/wamp.io · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._