Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Updated Readme #355

Merged
merged 11 commits into from
Jan 21, 2020
Merged

Updated Readme #355

Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
aa13ed8
fix: Delete existing will message on client connect
robertsLando Jan 14, 2020
931b7b5
fix: Delete will even if no will specified on clinet connect
robertsLando Jan 15, 2020
27d206a
chore: test for multiple will with same clientid
robertsLando Jan 15, 2020
8fd6f90
fix: Improved test using clientDisconnect event
robertsLando Jan 15, 2020
cd7ea5c
Merge https://github.com/mcollina/aedes
robertsLando Jan 15, 2020
ff75c4d
Merge https://github.com/mcollina/aedes
robertsLando Jan 21, 2020
7ef4ae3
docs: Plugins and features table
robertsLando Jan 21, 2020
12c9635
docs: Updated plugins with mqemitter links
robertsLando Jan 21, 2020
16a72ce
docs: Clarify what mqemitter and persistence are used for
robertsLando Jan 21, 2020
71a7d34
docs: Redirect to plugins in aedes options
robertsLando Jan 21, 2020
14dbdb8
docs: Added benchmark mosca vs aedes
robertsLando Jan 21, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
97 changes: 88 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,19 +8,24 @@
[![NPM version](https://img.shields.io/npm/v/aedes.svg?style=flat)](https://www.npmjs.com/package/aedes)
[![NPM downloads](https://img.shields.io/npm/dm/aedes.svg?style=flat)](https://www.npmjs.com/package/aedes)

[![js-standard-style](https://cdn.rawgit.com/feross/standard/master/badge.svg)](https://github.com/feross/standard)

Barebone MQTT server that can run on any stream server.

[![js-standard-style](https://cdn.rawgit.com/feross/standard/master/badge.svg)](https://github.com/feross/standard)
| QoS 0 | QoS 1 | QoS 2 | auth | [bridge][bridge_protocol] | $SYS topics | SSL | [dynamic topics][dynamic_topics] | cluster | websockets | plugin system | MQTT 5 |
| ----- | ----- | ----- | ---- | ------------------------- | ----------- | --- | -------------------------------- | ------- | ---------- | ------------- | ------ |
| ✔ | ✔ | ✔ | ✔ | ? | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✘ |

* [Install](#install)
* [Example](#example)
* [API](#api)
* [TODO](#todo)
* [Plugins](#plugins)
* [Collaborators](#collaborators)
* [Acknowledgements](#acknowledgements)
* [Mosca Vs Aedes](#mosca-vs-aedes)
* [License](#license)


<a name="install"></a>
## Install
To install aedes, simply use npm:
Expand Down Expand Up @@ -60,6 +65,29 @@ server.listen(8883, function () {
})
```

### WEBSOCKETS

```js
var aedes = require('./aedes')()
var server = require('net').createServer(aedes.handle)
var httpServer = require('http').createServer()
var ws = require('websocket-stream')
var port = 1883
var wsPort = 8888

server.listen(port, function () {
console.log('server listening on port', port)
})

ws.createServer({
server: httpServer
}, aedes.handle)

httpServer.listen(wsPort, function () {
console.log('websocket server listening on port', wsPort)
})
```

<a name="api"></a>
## API

Expand Down Expand Up @@ -94,13 +122,8 @@ Creates a new instance of Aedes.

Options:

* `mq`: an instance of [MQEmitter](http://npm.im/mqemitter),
such as [MQEmitterRedis](http://npm.im/mqemitter-redis)
or [MQEmitterMongoDB](http://npm.im/mqemitter-mongodb)
* `persistence`: an instance of [AedesPersistence](http://npm.im/aedes-persistence),
such as [aedes-persistence-redis](http://npm.im/aedes-persistence-redis),
[aedes-persistence-nedb](http://npm.im/aedes-persistence-nedb)
or [aedes-persistence-mongodb](http://npm.im/aedes-persistence-mongodb)
* `mq`: an instance of [MQEmitter](http://npm.im/mqemitter), check [plugins](#plugins) for more mqemitters options. Used to share messages between multiple brokers instances (ex: clusters)
* `persistence`: an instance of [AedesPersistence](http://npm.im/aedes-persistence), check [plugins](#plugins) for more persistence options. It's used to store *QoS > 1*, *retained*, *will* packets and subscriptions in memory or on disk (if not specified default persistence is in memory)
* `concurrency`: the max number of messages delivered concurrently,
defaults to `100`
* `heartbeatInterval`: the interval at which the broker heartbeat is
Expand Down Expand Up @@ -475,6 +498,23 @@ You can subscribe on the following `$SYS` topics to get client presence:
- `$SYS/+/disconnect/clients` - will inform about client disconnections.
The payload will contain the `clientId` of the connected/disconnected client

## Plugins
mcollina marked this conversation as resolved.
Show resolved Hide resolved

- [aedes-persistence](https://github.com/moscajs/aedes-persistence): In-memory implementation of an Aedes persistence
- [aedes-persistence-mongodb](https://github.com/moscajs/aedes-persistence-mongodb): MongoDB persistence for Aedes
- [aedes-persistence-redis](https://github.com/moscajs/aedes-persistence-redis): Redis persistence for Aedes
- [aedes-persistence-level](https://github.com/moscajs/aedes-persistence-level): LevelDB persistence for Aedes
- [aedes-persistence-nedb](https://github.com/ovhemert/aedes-persistence-nedb#readme): NeDB persistence for Aedes
- [mqemitter](https://github.com/mcollina/mqemitter): An Opinionated Message Queue with an emitter-style API
- [mqemitter-redis](https://github.com/mcollina/mqemitter-redis): Redis-powered mqemitter
- [mqemitter-mongodb](https://github.com/mcollina/mqemitter-mongodb): Mongodb based mqemitter
- [mqemitter-child-process](https://github.com/mcollina/mqemitter-child-process): Share the same mqemitter between a hierarchy of child processes
- [mqemitter-cs](https://github.com/mcollina/mqemitter-cs): Expose a MQEmitter via a simple client/server protocol
- [mqemitter-p2p](https://github.com/mcollina/mqemitter-p2p): A P2P implementation of MQEmitter, based on HyperEmitter and a Merkle DAG
- [mqemitter-aerospike](https://github.com/GavinDmello/mqemitter-aerospike): Aerospike mqemitter based on @mcollina 's mqemitter
- [aedes-logging](https://github.com/moscajs/aedes-logging): Logging module for Aedes, based on Pino
- [aedes-stats](https://github.com/moscajs/aedes-stats): Stats for Aedes
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should probably include links to the mqemitter equivalents as well.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Now I will add missings mqemitters links. COuld you check also if all the ticks on the table of features are correct? I have a '?' on bridge as I don't understand what it means

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

readme has '?' on bridge. what does it mean ?

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what i mean to highlight is - aedes either supports bridge or not. so documentation should represent that accurately.


## Collaborators

* [__Gavin D'mello__](https://github.com/GavinDmello)
Expand All @@ -488,6 +528,45 @@ This library is born after a lot of discussion with all
production. This addresses your concerns about performance and
stability.

## Mosca vs Aedes

Example benchmark test with 1000 clients sending 5000 QoS 1 messsages. Used [mqtt-benchmark](https://github.com/krylovsk/mqtt-benchmark) with command:

`mqtt-benchmark --broker tcp://localhost:1883 --clients 1000 --qos 1 --count 5000`

### Aedes

```
========= TOTAL (1000) =========
Total Ratio: 1.000 (5000000/5000000)
Total Runtime (sec): 178.495
Average Runtime (sec): 177.845
Msg time min (ms): 0.077
Msg time max (ms): 199.805
Msg time mean mean (ms): 35.403
Msg time mean std (ms): 0.042
Average Bandwidth (msg/sec): 28.115
Total Bandwidth (msg/sec): 28114.678
```

### Mosca

```
========= TOTAL (1000) =========
Total Ratio: 1.000 (5000000/5000000)
Total Runtime (sec): 264.934
Average Runtime (sec): 264.190
Msg time min (ms): 0.070
Msg time max (ms): 168.116
Msg time mean mean (ms): 52.629
Msg time mean std (ms): 0.074
Average Bandwidth (msg/sec): 18.926
Total Bandwidth (msg/sec): 18925.942
```

## License

MIT

[dynamic_topics]: https://github.com/mqtt/mqtt.github.io/wiki/are_topics_dynamic
[bridge_protocol]: https://github.com/mqtt/mqtt.github.io/wiki/bridge_protocol