Incrementally modifying codebase to come in line with Node 0.9 and socket.io 0.9

onedayitwillmake · onedayitwillmake · commit 4d46f3860b48 · 2013-02-10T18:58:14.000-05:00
diff --git a/DemoHelloWorld.html b/DemoHelloWorld.html
@@ -26,7 +26,7 @@
 	<!--lib-->
 	<script src="js/lib/caat.js"></script>
 	<script src="js/lib/Stats.js"></script>
-	<script src="js/lib/socket.io.js"></script>
+	<script src="node_modules/socket.io/node_modules/socket.io-client/dist/socket.io.js"></script>
 	<script src="js/lib/SortedLookupTable.js"></script>
 	<script src="js/lib/RequestAnimationFrame.js"></script>
 
diff --git a/js/model/Constants.js b/js/model/Constants.js
@@ -24,9 +24,17 @@ Version:
 
 		SERVER_SETTING:
 		{
-			CLIENT_ID	: 0,						// If an object has a client id of zero, that means it is owned by the server
-			SOCKET_ADDRESS: "localhost",
-			SOCKET_PORT	: 8081
+			CLIENT_ID		: 0,						// If an object has a client id of zero, that means it is owned by the server
+			SOCKET_PROTOCOL	: "http",
+			SOCKET_DOMAIN	: "localhost",
+			SOCKET_PORT		: 8081,
+
+			/** @return {string} */
+			GET_URI			: function() {
+				return  RealtimeMultiplayerGame.Constants.SERVER_SETTING.SOCKET_PROTOCOL
+					+ "://" + RealtimeMultiplayerGame.Constants.SERVER_SETTING.SOCKET_DOMAIN
+					+ ":" + RealtimeMultiplayerGame.Constants.SERVER_SETTING.SOCKET_PORT;
+			}
 		},
 
 		CLIENT_SETTING:
diff --git a/js/network/ClientNetChannel.js b/js/network/ClientNetChannel.js
@@ -60,8 +60,15 @@ Version:
 
 
 		setupSocketIO: function() {
-		    this.socketio = new io.Socket(RealtimeMultiplayerGame.Constants.SERVER_SETTING.SOCKET_ADDRESS, {port: RealtimeMultiplayerGame.Constants.SERVER_SETTING.SOCKET_PORT, transports:['websocket', 'xhr-polling', 'jsonp-polling'], reconnect: false, rememberTransport: false});
-			this.socketio.connect();
+			var socket = io.connect('http://localhost');
+			socket.on('news', function (data) {
+				console.log(data);
+				socket.emit('my other event', { my: 'data' });
+			});
+
+
+			debugger;
+		    this.socketio = new io.connect( RealtimeMultiplayerGame.Constants.SERVER_SETTING.GET_URI(), {transports:['websocket', 'xhr-polling', 'jsonp-polling'], reconnect: false, rememberTransport: false});
 
 			var that = this;
 			this.socketio.on('connect', function(){ that.onSocketConnect() });
diff --git a/js/network/ServerNetChannel.js b/js/network/ServerNetChannel.js
@@ -1,41 +1,36 @@
 /**
-File:
-	ServerNetChannel.js
-Created By:
-	Mario Gonzalez
-Project:
-	RealtimeMultiplayerNodeJS
-Abstract:
-	This class is responsible for managing the socket connection for each client
-
- 	-> ClientNetChannel talks to this object
-	<--> ServerNetChannel talks to it's GameController via delegation
- 	  <-- ServerNetChannel broadcast the message to all clients
-
-Basic Usage:
+ File:
+ 	ServerNetChannel.js
+ Created By:
+ 	Mario Gonzalez
+ Project:
+ 	RealtimeMultiplayerNodeJS
+ Abstract:
+	 This class is responsible for managing the socket connection for each client
+
+	 -> ClientNetChannel talks to this object
+	 <--> ServerNetChannel talks to it's GameController via delegation
+	 <-- ServerNetChannel broadcast the message to all clients
+
+ Basic Usage:
  	TODO: UPDATE USAGE
-Version:
-	1.0
-*/
-(function(){
-	// Node.JS Imports
-	var http = require('http');
-    var url = require('url');
-    var fs = require('fs');
-    var sys = require(process.binding('natives').util ? 'util' : 'sys');
-	var io = require('../lib/Socket.IO-node');
-
-	// Local variables for private things in this class
+ Version:
+	 1.1.0
+ */
+(function () {
+	/**
+	 *
+	 * The auto-incrimented ID to use for the next client
+	 */
 	var nextClientID = RealtimeMultiplayerGame.Constants.SERVER_SETTING.CLIENT_ID;
 
-	// Retrieve the namespace
-	RealtimeMultiplayerGame.namespace("RealtimeMultiplayerGame.network");
+	RealtimeMultiplayerGame.namespace( "RealtimeMultiplayerGame.network" );
 
 	/**
 	 * Creates a new ServerNetChannel instance
 	 * @param {RealtimeMultiplayerGame.network.ServerNetChannelDelegateProtocol} aDelegate A delegate that conforms to RealtimeMultiplayerGame.network.ServerNetChannelDelegateProtocol
 	 */
-	RealtimeMultiplayerGame.network.ServerNetChannel = function( aDelegate ) {
+	RealtimeMultiplayerGame.network.ServerNetChannel = function ( aDelegate ) {
 		this.clients = new SortedLookupTable();
 
 		this.setDelegate( aDelegate );
@@ -46,35 +41,42 @@ Version:
 	};
 
 	RealtimeMultiplayerGame.network.ServerNetChannel.prototype = {
-		httpserver				: null,					// A minimal HTTP server which socket.io can listen on
-		socketio 				: null,					// Socket.IO server
+		socketio				: null,					// Socket.IO server
 		clients					: null,					// SortedLookupTable
 		delegate				: null,					// Should conform to ServerNetChannel delegate
 		outgoingSequenceNumber	: 0,					// A unique ID for each message
 		cmdMap					: {},					// Map the CMD constants to functions
-	// Methods
+
+		// Methods
 		/**
 		 * Initializes socket.io
 		 */
-		setupSocketIO: function() {
-			// Create a minimal http server to listen
-			this.httpserver = http.createServer(function(req, res) {});
-			this.httpserver.listen( RealtimeMultiplayerGame.Constants.SERVER_SETTING.SOCKET_PORT );
-			// Start socket.io
-			this.socketio = io.listen(this.httpserver);
-
+		setupSocketIO: function () {
+			var server = require( 'http' ).createServer( function ( req, res ) {
+			} );
+			server.listen( RealtimeMultiplayerGame.Constants.SERVER_SETTING.SOCKET_PORT );
+			this.socketio = require( 'socket.io' ).listen( server );
 
 			var that = this;
-			this.socketio.on('connection', function(client){ that.onSocketConnection(client) });
-			this.socketio.on('clientMessage', function(data, client){ that.onSocketMessage( data, client ) });
-			this.socketio.on('clientDisconnect', function(client){ that.onSocketClosed(client) });
+			this.socketio.on( 'connection', function ( client ) {
+				console.log(client);
+				that.onSocketConnection( client )
+			} );
+			this.socketio.on( 'clientMessage', function ( data, client ) {
+				console.log(data)
+				that.onSocketMessage( data, client )
+			} );
+			this.socketio.on( 'clientDisconnect', function ( client ) {
+				console.log(client)
+				that.onSocketClosed( client )
+			} );
 		},
 
-		setupWSServer: function() {
+		setupWSServer: function () {
 
-			var profiler = require('v8-profiler');
-			var util = require('util');
-			var ws = require("../lib/bonsai-ws/ws.js");
+			var profiler = require( 'v8-profiler' );
+			var util = require( 'util' );
+			var ws = require( "../lib/bonsai-ws/ws.js" );
 
 			this.clientCount = 0;
 			this.maxClients = 8;
@@ -83,29 +85,29 @@ Version:
 			var that = this;
 
 			this.$ = new ws.Server( false );
-			this.$.onConnect = function(conn) {
+			this.$.onConnect = function ( conn ) {
 				var aClient = new RealtimeMultiplayerGame.network.Client( conn, that.getNextClientID() );
 
 				// Send the first message back to the client, which gives them a clientid
-				var connectMessage = new RealtimeMultiplayerGame.model.NetChannelMessage( ++this.outgoingSequenceNumber, aClient.getClientid(), true, RealtimeMultiplayerGame.Constants.CMDS.SERVER_CONNECT, { gameClock: that.delegate.getGameClock() });
+				var connectMessage = new RealtimeMultiplayerGame.model.NetChannelMessage( ++this.outgoingSequenceNumber, aClient.getClientid(), true, RealtimeMultiplayerGame.Constants.CMDS.SERVER_CONNECT, { gameClock: that.delegate.getGameClock() } );
 				connectMessage.messageTime = that.delegate.getGameClock();
-				aClient.getConnection().send( RealtimeMultiplayerGame.modules.bison.encode(connectMessage) );
+				aClient.getConnection().send( RealtimeMultiplayerGame.modules.bison.encode( connectMessage ) );
 
 				// Add to our list of connected users
 				that.clients.setObjectForKey( aClient, aClient.getSessionId() );
 			};
 
-			this.$.onMessage = function(conn, msg) {
-				console.log("MESSAGE RECEIVED", msg);
+			this.$.onMessage = function ( conn, msg ) {
+				console.log( "MESSAGE RECEIVED", msg );
 			};
 
-			this.$.onClose = function(conn) {
-				that.removeClient(conn.$clientID);
-				console.log("Disconnected!");
+			this.$.onClose = function ( conn ) {
+				that.removeClient( conn.$clientID );
+				console.log( "Disconnected!" );
 			};
 
-			this.removeClient = function(id) {
-				if (this.socketClients[id]) {
+			this.removeClient = function ( id ) {
+				if ( this.socketClients[id] ) {
 					this.clientCount--;
 					this.socketClients[id].remove();
 					delete this.socketClients[id];
@@ -118,19 +120,18 @@ Version:
 		/**
 		 * Map RealtimeMultiplayerGame.Constants.CMDS to functions
 		 */
-		setupCmdMap: function() {
+		setupCmdMap: function () {
 			this.cmdMap = {};
 			this.cmdMap[RealtimeMultiplayerGame.Constants.CMDS.PLAYER_JOINED] = this.onPlayerJoined;
 		},
 
 		/**
 		 * Checks all the clients to see if its ready for a new message.
 		 * If they are, have the client perform delta-compression on the worldDescription and send it off.
-		 * @param gameClock		   The current (zero-based) game clock
+		 * @param gameClock       The current (zero-based) game clock
 		 * @param worldDescription A description of all the entities currently in the world
 		 */
-		tick: function( gameClock, worldDescription )
-		{
+		tick: function ( gameClock, worldDescription ) {
 			var worldEntityDescriptionString = worldDescription.getEntityDescriptionAsString();
 			var entityDescriptionObject = {
 				entities: worldEntityDescriptionString,
@@ -139,30 +140,29 @@ Version:
 			};
 
 			// Send client the current world info
-			this.clients.forEach( function(key, client)
-			{
+			this.clients.forEach( function ( key, client ) {
 				// Collapse delta - store the world state
 				client.entityDescriptionBuffer.push( entityDescriptionObject );
 
 				// Ask if enough time passed, and send a new world update
-				if ( client.canSendMessage(gameClock) ) {
-					client.sendQueuedCommands(gameClock);
+				if ( client.canSendMessage( gameClock ) ) {
+					client.sendQueuedCommands( gameClock );
 				}
 
 			}, this );
 		},
 
-	// Socket.IO callbacks
+		// Socket.IO callbacks
 		/**
 		 * Callback from socket.io when a client has connected
 		 * @param clientConnection
 		 */
-		onSocketConnection: function( clientConnection ) {
+		onSocketConnection: function ( clientConnection ) {
 
 			var aClient = new RealtimeMultiplayerGame.network.Client( clientConnection, this.getNextClientID() );
 
 			// Send the first message back to the client, which gives them a clientid
-			var connectMessage = new RealtimeMultiplayerGame.model.NetChannelMessage( ++this.outgoingSequenceNumber, aClient.getClientid(), true, RealtimeMultiplayerGame.Constants.CMDS.SERVER_CONNECT, { gameClock: this.delegate.getGameClock() });
+			var connectMessage = new RealtimeMultiplayerGame.model.NetChannelMessage( ++this.outgoingSequenceNumber, aClient.getClientid(), true, RealtimeMultiplayerGame.Constants.CMDS.SERVER_CONNECT, { gameClock: this.delegate.getGameClock() } );
 			connectMessage.messageTime = this.delegate.getGameClock();
 			aClient.getConnection().send( connectMessage );
 
@@ -174,10 +174,10 @@ Version:
 		 * Callback from socket.io when a client has disconnected
 		 * @param client
 		 */
-		onSocketClosed: function( clientConnection ) {
+		onSocketClosed: function ( clientConnection ) {
 			var client = this.clients.objectForKey( clientConnection.sessionId );
-			if(!client) {
-				console.warn("(ServerNetChannel)::onSocketClosed - ERROR - Attempting to remove client that was not found in our list! ");
+			if ( !client ) {
+				console.warn( "(ServerNetChannel)::onSocketClosed - ERROR - Attempting to remove client that was not found in our list! " );
 				return;
 			}
 
@@ -192,54 +192,60 @@ Version:
 		 * @param data
 		 * @param connection
 		 */
-		onSocketMessage: function( data, connection )
-		{
-			var client = this.clients.objectForKey(connection.sessionId);
+		onSocketMessage: function ( data, connection ) {
+			var client = this.clients.objectForKey( connection.sessionId );
 			//that.CMD_TO_FUNCTION[decodedMessage.cmds.cmd].apply(that, [connection, decodedMessage]);
 
 			// Allow the client to track that data was received
-			if(client) {
+			if ( client ) {
 				client.onMessage( data );
 			} else {
-				console.log("(NetChannel)::onSocketMessage - no such client!");
+				console.log( "(NetChannel)::onSocketMessage - no such client!" );
 				return;
 			}
-			
+
 			//// Call the mapped function, always pass the connection. Also pass data if available
-			if( this.cmdMap[data.cmd] ) {
-				this.cmdMap[data.cmd].call(this, client, data);
-			} else if (this.delegate.cmdMap[data.cmd]) { // See if delegate has function mapped
-				this.delegate.cmdMap[data.cmd].call(this.delegate, client, data);
+			if ( this.cmdMap[data.cmd] ) {
+				this.cmdMap[data.cmd].call( this, client, data );
+			} else if ( this.delegate.cmdMap[data.cmd] ) { // See if delegate has function mapped
+				this.delegate.cmdMap[data.cmd].call( this.delegate, client, data );
 			} else { // Display error
-				console.log("(NetChannel)::onSocketMessage could not map '" + data.cmd + "' to function!");
+				console.log( "(NetChannel)::onSocketMessage could not map '" + data.cmd + "' to function!" );
 			}
 		},
 
-	////// Game callbacks
+		////// Game callbacks
 		/**
 		 * Callback for when a player has joined the match.
 		 * Note that joining the match, happens after connecting.
 		 * For example a player might be able to connect to the match, and watch the game for a while then want to join the match
 		 * @param client
 		 * @param data
 		 */
-		onPlayerJoined: function( client, data ) {
-			console.log( client.getClientid() + " joined the game!");
-			this.delegate.shouldAddPlayer( client.getClientid(), data);
+		onPlayerJoined: function ( client, data ) {
+			console.log( client.getClientid() + " joined the game!" );
+			this.delegate.shouldAddPlayer( client.getClientid(), data );
 			client.getConnection().send( data );
 		},
 
-	// Accessors
-		getNextClientID: function() { return ++nextClientID },
+		/*************
+		 * ACCESSORS *
+		 *************/
+
+
+		getNextClientID: function () {
+			return ++nextClientID
+		},
+
 		/**
 		 * Checks that an object contains the required methods and sets it as the delegate for this ServerNetChannel instance
 		 * @param {RealtimeMultiplayerGame.network.ServerNetChannelDelegateProtocol} aDelegate A delegate that conforms to RealtimeMultiplayerGame.network.ServerNetChannelDelegateProtocol
 		 */
-		setDelegate: function( aDelegate ) {
+		setDelegate: function ( aDelegate ) {
 			var theInterface = RealtimeMultiplayerGame.network.ServerNetChannelDelegateProtocol;
-			for (var member in theInterface) {
+			for ( var member in theInterface ) {
 				if ( (typeof aDelegate[member] != typeof theInterface[member]) ) {
-					console.log("object failed to implement interface member " + member);
+					console.log( "object failed to implement interface member " + member );
 					return false;
 				}
 			}
@@ -253,12 +259,19 @@ Version:
 	 * Required methods for the ServerNetChannel delegate
 	 */
 	RealtimeMultiplayerGame.network.ServerNetChannelDelegateProtocol = {
-		setupCmdMap: function() {},
-		shouldUpdatePlayer: function( clientID, data ) {},
-		shouldAddPlayer: function( clientID, data ) {},
-		shouldRemovePlayer: function( clientID ) {},
-		getNextEntityID: function() {},
-		getGameClock: function() {},
-		log: function(){}
+		setupCmdMap: function () {
+		},
+		shouldUpdatePlayer: function ( clientID, data ) {
+		},
+		shouldAddPlayer: function ( clientID, data ) {
+		},
+		shouldRemovePlayer: function ( clientID ) {
+		},
+		getNextEntityID: function () {
+		},
+		getGameClock: function () {
+		},
+		log: function () {
+		}
 	}
 })();
