Simple rooms wrapper for Primus
npm install primus-rooms
Node.JS module that adds room capabilities to a Primus server.
``
npm install primus-rooms
`javascript
var Primus = require('primus');
var Rooms = require('primus-rooms');
var server = require('http').createServer();
// primus instance
var primus = new Primus(server, { transformer: 'websockets' });
// add rooms to Primus
primus.plugin('rooms', Rooms);
primus.on('connection', function (spark) {
spark.on('data', function(data) {
data = data || {};
var action = data.action;
var room = data.room;
// join a room
if ('join' === action) {
spark.join(room, function () {
// send message to this client
spark.write('you joined room ' + room);
// send message to all clients except this one
spark.room(room).except(spark.id).write(spark.id + ' joined room ' + room);
});
}
// leave a room
if ('leave' === action) {
spark.leave(room, function () {
// send message to this client
spark.write('you left room ' + room);
});
}
});
});
server.listen(8080);
`
`javascript
var primus = Primus.connect('ws://localhost:8080');
primus.on('open', function () {
// Send request to join the news room
primus.write({ action: 'join', room: 'news' });
// Send request to leave the news room
primus.write({ action: 'leave', room: 'news' });
// print server message
primus.on('data', function (message) {
console.log(message);
});
});
`
`javascript`
primus.write({ room: 'chat', msg: 'Hello some one' });
`javascript
primus.on('connection', function(spark){
spark.on('data', function(data){
var room = data.room;
var message = data.msg;
// check if spark is already in this room
if (~spark.rooms().indexOf(room)) {
send();
} else {
// join the room
spark.join(room, function(){
send();
});
}
// send to all clients in the room
function send() {
spark.room(room).write(message);
}
});
});
`
`javascript`
spark1.join('user:*');
spark2.join('user::');
spark3.join('user:::123');
Then later in your code send a message as normal like this:
`javascript`
// All clients of the rooms above should receive 'hello'.
primus.in('user:jb:abc:123').write('hello');
All clients that joined rooms user:, user::, user::*:123 should receive the hello message.
`javascript
// All clients of the rooms above should receive 'hello'.
spark1.on('data', function ondata(msg) {
console.log(msg); //-> hello
});
spark2.on('data', function ondata(msg) {
console.log(msg); //-> hello
});
spark3.on('data', function ondata(msg) {
console.log(msg); //-> hello
});
`
in the rooms options when instantiating primus.`javascript
var Primus = require('primus');
var Rooms = require('primus-rooms');
var server = require('http').createServer();// disabling wildcard
var primus = new Primus(server, { rooms: { wildcard: false } });
// add rooms to Primus
primus.plugin('rooms', Rooms);
`For more examples on how to use
check the wildcard tests.API
$3
Set your own
adapter for rooms, by default primus-rooms comes
with its own memory adapter primus-rooms-adapter but its easy to provide a custom one.`javascript
// as argument
var primus = new Primus(url, {
transformer: 'sockjs',
rooms: { adapter: myAdapter }
});
primus.plugin('rooms', Rooms);// by setting the property
primus.adapter = new MyAdapter();
`For more information on how to create your own custom adapter check out the documentation of primus-rooms-adapter.
$3
Join multiple sparks to a
or multiple rooms, fn is optional callback.`javascript
primus.join([spark1, spark2, spark3], 'news', fn);// to multiple rooms
primus.join([spark1, spark2, spark3], 'news sport', fn);
`Join multiple sparks to a
or multiple rooms by passing spark ids.`javascript
primus.join(['1389028863093$0', '1389028862534$1', '1389028862896$3'], 'news', fn);// to multiple rooms
primus.join(['1389028863093$0', '1389028862534$1', '1389028862896$3'], 'news sport', fn);
`You can also mix ids with instances in the array:
javascript
primus.join([spark1, spark2, '1389028862896$3'], 'news', fn);
`You can also pass a single spark instance or id to join a room or multiple rooms:
javascript
primus.join(spark, 'news', fn);
`
This is also equivalent:javascript
primus.join('1389028863093$0', 'news', fn);
`$3
Remove multiple sparks from a
or multiple rooms, fn is optional callback.`javascript
primus.leave([spark1, spark2, spark3], 'news', fn);// multiple rooms
primus.leave([spark1, spark2, spark3], 'news sport', fn);
`Remove multiple sparks from a
or multiple rooms by passing spark ids.`javascript
primus.leave(['1389028863093$0', '1389028862534$1', '1389028862896$3'], 'news', fn);// multiple rooms
primus.leave(['1389028863093$0', '1389028862534$1', '1389028862896$3'], 'news sport', fn);
`You can also mix ids with instances in the array:
javascript
primus.leave([spark1, spark2, '1389028862896$3'], 'news', fn);
`You can also pass a single spark instance or id to leave a room or multiple rooms:
javascript
primus.leave(spark, 'news', fn);
`
This is also equivalent:javascript
primus.leave('1389028863093$0', 'news', fn);
`$3
Target a specific
or rooms for broadcasting a message.`javascript
primus.room('room').write('hi');
` is an equivalent method to room:`javascript
primus.in('room').write('hi');
`$3
Send a message to a specific
.`javascript
primus.room('room').write('hi');
`
or to multiple rooms at once:javascript
primus.room('sport news art').write('hi');
`$3
Broadcast messages to clients in a room except to those especified.
javascript
primus.room('room').except('1386018854525$0 1386018854526$1').write('hi');
`or pass an array:
javascript
var except = ['1386018854525$0', '1386018854526$1'];
primus.room('room').except(except).write('hi');
`$3
Get all client
connected to a specific room.
If no callback is passed the function will return synchronously the ids
but please remember that NOT all adapters are guaranteed to be able to do
this operation synchronously.`javascript
primus.room('room').clients(fn);
`or synchronously if adapter supports it:
javascript
var clients = primus.room('room').clients();
console.log(clients);
`$3
Remove all clients from a
or multiple rooms.`javascript
primus.room('sport').empty();// or
primus.empty('sport');
`or multiple rooms at the same time:
javascript
primus.room('news sport').empty();// or
primus.empty('news sport');
`$3
javascript
primus.room('room').transform(function transform(packet) {
var spark = this;
if (spark.user.name === 'John Doe') {
packet.data[0] = 'hi ' + spark.user.name;
} // If you want to prevent the
data event from happening,
// simply return false and the event won't be sent.}).write('hi');
`This also work asynchronously:
javascript
primus.room('room').transform(function transform(packet, done) {
var spark = this;
if (spark.user.name === 'John Doe') {
setTimeout(function () {
packet.data[0] = 'hi ' + spark.user.name;
done();
});
} // If you want to prevent the
data event from happening,
// simply do done(undefined, false) and the event won't be sent.}).write('hi');
`$3
Get all active rooms on the server.
javascript
primus.rooms();
`Get all rooms a specific spark is connected to.
javascript
primus.rooms(spark, fn);
`You can also use the spark id:
javascript
primus.rooms(spark.id, fn);// or
primus.rooms('1386018854525$0', fn);
`$3
Check if a
is empty, fn is optional callback.`javascript
primus.isRoomEmpty('sport', fn);
`$3
The
event is emitted every time a spark has joined a room.
First argument of the callback is the room and second argument is the spark.`javascript
primus.on('joinroom', function (room, spark) {
console.log(spark.id + ' joined ' + room);
});
`$3
The
event is emitted every time a spark has left a room.
First argument of the callback is the room and second argument is the spark.`javascript
primus.on('leaveroom', function (room, spark) {
console.log(spark.id + ' left ' + room);
});
`$3
The
event is emitted every time the leaveAll method
is called on a spark or when the end event is emitted on the client.
First argument of the callback is an array with all rooms client joined.`javascript
primus.on('leaveallrooms', function (rooms, spark) {
console.log(spark.id + ' leaving all rooms:', rooms);
});
`$3
The
event is emitted every time a spark encounter an error when joining or leaving a room.
First argument of the callback is the error object and second argument is the spark.`javascript
primus.on('roomserror', function (error, spark) {
console.log('room error from ' + spark.id, error);
});
`$3
Join client to a
, fn is optional callback.`javascript
spark.join('room');
`Join multiple rooms at once.
javascript
spark.join('room1 room2 room3', fn);
`$3
Target a specific
.`javascript
spark.room('room').write('hi');
spark.room('room').clients(fn);
` is an equivalent method to room:`javascript
spark.in('room').write('hi');
spark.in('room').clients(fn);
`$3
Send a message to a specific
.`javascript
spark.room('room').write('hi');
`$3
Broadcast messages to clients in a room except to those specified.
javascript
spark.room('room').except('1386018854525$0 1386018854526$1').write('hi');
`or pass an array:
javascript
var except = ['1386018854525$0', '1386018854526$1'];
spark.room('room').except(except).write('hi');
`$3
Get all client
connected to specific room.
If no callback is passed the function will return synchronously the ids
but please remember that NOT all adapters are guaranteed to be able to do
this operation synchronously.`javascript
spark.room('room').clients(fn);
`or synchronously if adapter supports it:
javascript
var clients = spark.room('room').clients();
console.log(clients);
`$3
javascript
spark.room('room').transform(function transform(packet) {
var spark = this;
if (spark.user.name === 'John Doe') {
packet.data[0] = 'hi ' + spark.user.name;
} // If you want to prevent the
data event from happening,
// simply return false and the event won't be sent.}).write('hi');
`This also work asynchronously:
javascript
spark.room('room').transform(function transform(packet, done) {
var spark = this;
if (spark.user.name === 'John Doe') {
setTimeout(function () {
packet.data[0] = 'hi ' + spark.user.name;
done();
});
} // If you want to prevent the
data event from happening,
// simply do done(undefined, false) and the event won't be sent.}).write('hi');
`$3
Leave a specific
, fn is optional callback.`javascript
spark.leave('room', fn);
`Leave multiple rooms at once.
javascript
spark.leave('room1 room2 room3', fn);
`$3
Leave all rooms the client has joined,
is optional callback.`javascript
spark.leaveAll(fn);
`$3
Get all rooms client is connected to.
javascript
spark.rooms();
`$3
Check if a
is empty, fn is optional callback.`javascript
spark.isRoomEmpty('sport', fn);
`$3
The
event is emitted every time a spark has joined a room.
First argument of the callback is the room.`javascript
spark.on('joinroom', function (room) {
console.log(room);
});
`$3
The
event is emitted every time a spark has left a room.
First argument of the callback is the room.`javascript
spark.on('leaveroom', function (room) {
console.log(room);
});
`$3
The
event is emitted every time the leaveAll method
is called on a spark or when the connection gets closed.
First argument of the callback is an array with all rooms client joined.`javascript
spark.on('leaveallrooms', function (rooms) {
console.log(rooms);
});
`$3
The
event is emitted every time a spark encounter an error when joining or leaving a room.
First argument of the callback is the error object.`javascript
spark.on('roomserror', function (error) {
console.log(error);
});
`Run tests
bash
$ make test
`` * primus-multiplex
* primus-emitter
* primus-resource
(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.