# primus-multiplex

> Simple multiplexing for Primus

Latest version **3.2.1** (published 2016-08-09) · MIT license · 0 weekly downloads

## Install

```sh
npm install primus-multiplex
pnpm add primus-multiplex
yarn add primus-multiplex
bun add primus-multiplex
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.2.1 |
| Published | 2016-08-09 |
| First published | 2013-07-25 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Jonathan Brumley |
| Maintainers | cayasso, lpinca |
| Keywords | multiplex, realtime, websocket, engine.io, socket.io, primus, sockjs, rooms, browserchannel, publish, subscribe |

## Links

- npm: https://www.npmjs.com/package/primus-multiplex
- Repository: https://github.com/cayasso/primus-multiplex
- Issues: https://github.com/cayasso/primus-multiplex/issues
- npm.io page: https://npm.io/package/primus-multiplex

## Dependencies (2)

- [predefine](https://npm.io/package/predefine.md) 0.1.x
- [eventemitter3](https://npm.io/package/eventemitter3.md) 1.2.x

## Alternatives

- [@opentelemetry/exporter-zipkin](https://npm.io/package/@opentelemetry/exporter-zipkin.md) — 14.8M weekly downloads
- [pusher-js](https://npm.io/package/pusher-js.md) — 2.0M weekly downloads
- [browserify](https://npm.io/package/browserify.md) — 1.7M weekly downloads
- [sqs-consumer](https://npm.io/package/sqs-consumer.md) — 1.7M weekly downloads
- [@sanity/eventsource](https://npm.io/package/@sanity/eventsource.md) — 930.8K weekly downloads

## Recent versions

- 3.2.1 (latest) — 2016-08-09
- 3.2.0 — 2015-06-22
- 3.1.0 — 2014-12-02
- 3.0.3 — 2014-09-14
- 3.0.2 — 2014-04-30
- 3.0.1 — 2014-02-19
- 3.0.0 — 2014-02-11
- 2.2.2 — 2014-01-08
- 2.2.1 — 2014-01-02
- 2.2.0 — 2013-12-07
- 2.1.1 — 2013-11-19
- 2.1.0 — 2013-11-18
- 2.0.1 — 2013-11-05
- 2.0.0 — 2013-11-04
- 1.1.2 — 2013-11-01
- … 9 more at https://npm.io/package/primus-multiplex/versions

## README

# Primus Multiplex

[![Build Status](https://img.shields.io/travis/cayasso/primus-multiplex/master.svg)](https://travis-ci.org/cayasso/primus-multiplex)
[![NPM version](https://img.shields.io/npm/v/primus-multiplex.svg)](https://www.npmjs.com/package/primus-multiplex)

Node.JS module that adds mutiplexing to [Primus](https://github.com/primus/primus).

## Installation

```
$ npm install primus-multiplex
```

## Usage

### On the Server

```javascript
var Primus = require('primus');
var multiplex = require('primus-multiplex');
var server = require('http').createServer();

// primus instance
var primus = new Primus(server, { transformer: 'sockjs', parser: 'JSON' });

// add multiplex to Primus
primus.plugin('multiplex', multiplex);

var news = primus.channel('news');
news.on('connection', function (spark) {

  spark.write('hi from the news channel');

  spark.on('data', function (data) {
    spark.write(data);
  });

});

var sport = primus.channel('sport');
sport.on('connection', function (spark) {

  spark.write('hi from the sport channel');

  spark.on('data', function (data) {
    spark.write(data);
  });

});

server.listen(8080);
```

### On the Client

```javascript
var primus = Primus.connect('ws://localhost:8080');

// Connect to channels
var news = primus.channel('news');
var sport = primus.channel('sport');

// Send message
news.write('hi news channel');
sport.write('hi sport channel');

// Receive message
news.on('data', function (msg) {
  console.log(msg);
});
sport.on('data', function (msg) {
  console.log(msg);
});
```

## API

### Server

#### primus.channel(name)

Create a new channel on the server.

```javascript
var news = primus.channel('news');
news.on('connection', fn);
```

#### channel.write(message)

Broadcast a message to all connected `Sparks` in the channel.

```javascript
news.write(message);
```

#### channel.forEach(fn)

Iterare over all `Sparks` in a channel. This could also be used
for broadcasting to specific `Sparks`.

```javascript
news.forEach(function (spark, id, connections) {
  spark.write('message');
});
```

#### channel.destroy()

Destroy the channel removing all 'Sparks' and event listeners.
This will emit a `close` event.

```javascript
news.on('connection', function (spark) {
  news.destroy();
});
```

#### channel.on('close', fn)

Triggers when the destroy method is called.

```javascript
news.on('connection', function (spark) {
  news.destroy();
});

news.on('close', function () {
  console.log('channel was destroyed');
});
```

#### spark.end([fn])

End the connection.

```javascript
news.on('connection', function (spark) {
  spark.end(fn);
});
```

### Client

#### channel.write(message)

Send a message to the server.

```javascript
news.write('hi server');
```

#### channel.end()

Disconnect from a channel.

```javascript
var news = primus.channel('news');
news.end();
```

#### channel.on('data', fn)
Receive `data` from the server from the corresponding `channel`.

```javascript
news.on('data', function(msg) {
  console.log('Received message from news channel', msg);
});
```

### Events on main Spark (Server)

There are two useful events that will be triggered on the main primus `Spark` object, that can be very usefull for handling dynamic subscriptions, subscription notifications, etc.

#### spark.on('subscribe', fn)

Triggers when a connection is subscribed to a channel. Callback will return with `channel` object
and its `spark` object.

```javascript
primus.on('connection', function(spark) {
  spark.on('subscribe', function(channel, channelSpark) {
    console.log('spark %s subscribed to channel %s', channelSpark.id, channel.name);
    // do stuff with the channel spark
  });
});
```
#### spark.on('unsubscribe', fn)

Triggers when connection is unsubscribed from a channel. Callback will return the `channel` object
and its `spark` object.

```javascript
primus.on('connection', function(spark) {
  spark.on('unsubscribe', function(channel, channelSpark) {
    console.log('spark %s unsubscribed from channel %s', channelSpark.id, channel.name);
    // channel spark is about to die
  });
});
```

## Protocol

Each message consists of an array of four parts: `type` (`Number`), `id` (`String`),
`topic` (`String`), and `payload` (`Mixed`).

There are three valid message types:

 * `Packet#MESSAGE` (`0`)  send a message with `payload` on a `topic`.
 * `Packet#SUBSCRIBE` (`1`) subscribe to a given `topic`.
 * `Packet#UNSUBSCRIBE` (`2`) unsubscribe from a `topic`.

The `topic` identifies a channel registered on the server side.
The `id` represent a unique connection identifier generated on the client side.

Each request to subscribe to a topic from a given client has a unique id.
This makes it possible for a single client to open multiple independent
channel connection to a single server-side service.

Invalid messages are simply ignored.

It's important to notice that the namespace is shared between both
parties and it is not a good idea to use the same topic names on the
client and on the server side. Both parties may express a will to
unsubscribe itself or other party from a topic.

## Run tests

``` bash
$ make test
```

## Inspiration

This library was inspire by this great post:

* https://www.rabbitmq.com/blog/2012/02/23/how-to-compose-apps-using-websockets/

## Other plugins

PrimusMultiplex is compatible with the following plugins, check the [examples](https://github.com/cayasso/primus-multiplex/tree/master/examples/node) to see more.

 * [primus-rooms](https://github.com/cayasso/primus-rooms)
 * [primus-emitter](https://github.com/cayasso/primus-emitter)
 * [primus-resource](https://github.com/cayasso/primus-resource)

## License

(The MIT License)

Copyright (c) 2013 Jonathan Brumley <cayasso@gmail.com>

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/primus-multiplex · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._