Merge pull request #74 from hackmushroom/master

Added socket.broadcast.emit functionality to javascript client events

Author: oncesk

README.md

@@ -109,6 +109,10 @@ Install ***nodejs*** components in ***application.ext.yii-node-socket.lib.js.ser
 ```bash
 $> npm install
 ```
+If you get errors issuing this command try the following:
+```bash
+$> npm install --no-bin-links
+```
 
 Congratulation, installation completed!
 
@@ -119,7 +123,7 @@ Congratulation, installation completed!
 Use (**./yiic node-socket**)
 
 ```bash
-$> ./yiic node-socket # show help
+$> ./yiic help node-socket # show help
 $> ./yiic node-socket/start # start server
 $> ./yiic node-socket/stop # stop server
 $> ./yiic node-socket/restart # restart server
@@ -249,18 +253,25 @@ socket.onConnect(function () {
 ####Emit events
 
 You can emit event to:
- - all clients
+ - all clients (including the event sender)
+ - all clients (excluding the event sender - broadcasting. Only javascript currently supports broadcasting. PHP broadcasting coming soon)
  - clients in concrete room
 
-
 Global events:
 
 ```javascript
 
 socket.emit('global.event', {
 	message : {
 		id : 12,
-		title : 'This is a test message'
+		title : 'This is a test message to all including sender'
+	}
+});
+
+socket.broadcast.emit('global.event', {
+	message : {
+		id : 12,
+		title : 'This is a test message to all excluding sender'
 	}
 });
 

examples/events/views/index.php

@@ -4,7 +4,7 @@
  */
 ?>
 <h3>Instruction</h3>
-<b>Don't forget run nodejs server <i style="color: #079c59">./yiic node-socket start</i> before example usage</b>
+<b>Don't forget run nodejs server <i style="color: #079c59">./yiic node-socket/start</i> before example usage</b>
 <ul>
 	<li>1. Open "Go to this page for catch events example" page for catching events</li>
 	<li>2. Open "Send simple event" or "Send simple room event" and see result on "Go to this page for catch events example"</li>

lib/js/client/client.template.js

@@ -126,6 +126,8 @@
 			(scope.type == 'global' ? '' : ':' + scope.id)
 		);
 
+		owner.broadcast = false;
+		
 		/**
 		 *
 		 * @param event
@@ -136,9 +138,12 @@
 			socket.emit('event:emit', {
 				'event' : event,
 				'scope' : scope,
-				'data' : data
+				'data' : data,
+                'broadcast' : owner.broadcast
 			});
+            owner.broadcast = false;
 		};
+		
 	}
 
 	/**
@@ -648,6 +653,11 @@
 
 		var systemEventsHandlerBinder = new SystemEventsHandlerBinder(this);
 
+		this.__defineGetter__('broadcast', function () {
+            self._eventEmitter.broadcast = true;
+            return self;
+        });
+
 		this.getId = function () {
 			return '';
 		};

lib/js/server/events/client/event.emit.js

@@ -8,15 +8,24 @@ var public_data = {
 
 	handler : function (packet) {
 		if (packet['event'] && packet['scope'] && packet['scope']['type']) {
+			var client = public_data.componentManager.get('io').of('/client');
 			if (packet['scope']['type'] == 'global') {
-				//  global event -> for all clients
-				public_data.componentManager.get('io').of('/client').emit(
-					'global:' + packet['event'],
-					packet['data'] || {}
-				);
+				if (packet['broadcast'] === true) {
+					//  global event -> for all clients excluding sender
+					client.except(this.id).emit(
+						'global:' + packet['event'],
+						packet['data'] || {}
+					);
+				} else {
+					//  global event -> for all clients including sender
+					client.emit(
+						'global:' + packet['event'],
+						packet['data'] || {}
+					);
+				}
 			} else if (packet['scope']['type'] == 'room' && packet['scope']['id']) {
 				//  room event -> for sockets in concrete room
-				public_data.componentManager.get('io').of('/client').in('room:' + packet['scope']['id']).emit(
+				client.in('room:' + packet['scope']['id']).emit(
 					'room:' + packet['scope']['id'] + ':' + packet['event'],
 					packet['data'] || {},
 					true