Skip to content

Commit

Permalink
better docs about mqemitters and persistences
Browse files Browse the repository at this point in the history
  • Loading branch information
robertsLando committed Apr 24, 2020
1 parent 7277a96 commit 3ec55c7
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/Aedes.md
Expand Up @@ -35,9 +35,9 @@
## new Aedes([options]) / new Aedes.Server([options])

- options `<object>`
- `mq` [`<MQEmitter>`](../README.md#mqemitter) a middleware helps to deliver messages to subscribed clients. __Default__: `mqemitter`
- `mq` [`<MQEmitter>`](../README.md#mqemitter) middleware used to deliver messages to subscribed clients. In a cluster environment it is used also to share messages between brokers instances. __Default__: `mqemitter`
- `concurrency` `<number>` maximum number of concurrent messages delivered by `mq`. __Default__: `100`
- `persistence` [`<Persistence>`](../README.md#persistence) a middleware stores _QoS > 0, retained, will_ packets and subscriptions. __Default__: `aedes-persistence`
- `persistence` [`<Persistence>`](../README.md#persistence) middleware that stores _QoS > 0, retained, will_ packets and _subscriptions_. __Default__: `aedes-persistence` (_in memory_)
- `queueLimit` `<number>` maximum number of queued messages before client session is established. If number of queued items exceeds, `connectionError` throws an error `Client queue limit reached`. __Default__: `42`
- `maxClientsIdLength` option to override MQTT 3.1.0 clients Id length limit. __Default__: `23`
- `heartbeatInterval` `<number>` an interval in millisconds at which server beats its health signal in `$SYS/<aedes.id>/heartbeat` topic. __Default__: `60000`
Expand Down

0 comments on commit 3ec55c7

Please sign in to comment.