Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
57 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
Copyright (C) 2013 by Maciej Małecki | ||
|
||
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
# primus-redis | ||
[![Build Status](https://travis-ci.org/mmalecki/primus-redis.png)](https://travis-ci.org/mmalecki/primus-redis) | ||
`primus-redis` is a Redis store for [Primus](https://github.com/primus/primus). | ||
It takes care of distributing messages to other instances using [Redis Pub/Sub](http://redis.io/topics/pubsub). | ||
|
||
## Usage | ||
|
||
### Single Redis instance | ||
You can use `primus-redis` with a single Redis instance, but it's not | ||
recommended in production environment, since it makes Redis a single point of | ||
failure. | ||
|
||
|
||
```js | ||
var http = require('http'), | ||
Primus = require('primus'), | ||
PrimusRedis = require('primus-redis'); | ||
|
||
var server = http.createServer(); | ||
var primus = new Primus(server, { | ||
redis: { | ||
host: 'localhost', | ||
port: 6379, | ||
channel: 'primus' // Optional, defaults to `'primus`' | ||
}, | ||
transformer: 'websockets' | ||
}); | ||
primus.use('Redis', PrimusRedis); | ||
|
||
// | ||
// This'll take care of sending the message to all other instances connected | ||
// to the same Redis channel. | ||
// | ||
primus.write('Hello world!'); | ||
``` | ||
|
||
### Sentinel | ||
TODO |