aedes-persistence-redis

Aedes Persistence, backed by Redis.

See aedes-persistence for the full API, and Aedes for usage.

Install

1npm install aedes aedes-persistence-redis --save

Upgrade

Please check UPGRADE.md when upgrading from a previous version.

API

aedesPersistenceRedis([opts])

Creates a new instance of aedes-persistence-redis. It takes all the same options of ioredis, which is used internally to connect to Redis.

This constructor creates two connections to Redis.

Example:

1aedesPersistenceRedis({
2  port: 6379,          // Redis port
3  host: '127.0.0.1',   // Redis host
4  family: 4,           // 4 (IPv4) or 6 (IPv6)
5  password: 'auth',
6  db: 0,
7  maxSessionDelivery: 100, // maximum offline messages deliverable on client CONNECT, default is 1000
8  packetTTL: function (packet) { // offline message TTL, default is disabled
9    return 10 //seconds
10  }
11})

Alternatively, you can pass in an externally created Redis connection using the conn option. This can be useful when connecting to a Redis cluster, for example.

Example:

1aedesPersistenceRedis({
2  conn: new Redis.Cluster([{
3    port: 6379,
4    host: '127.0.0.1'
5  }, {
6    port: 6380,
7    host: '127.0.0.1'
8  }]),
9  cluster: true
10})

The same as above but with cluster option:

1aedesPersistenceRedis({
2  cluster: [{
3    port: 6379,
4    host: '127.0.0.1'
5  }, {
6    port: 6380,
7    host: '127.0.0.1'
8  }]
9})

Changes in v4.x

v4 has changed the subscriptions key schema to enhance performance. Please check related PR for more details.

License

MIT