From b5aaffa4302a72bdae31a19026767eef1cdc2d7a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lasse=20=C3=96=C3=B6rni?= Date: Fri, 25 Oct 2013 17:29:06 +0300 Subject: [PATCH] Added initial code. --- LICENSE | 176 ++++++++++++++++++++++++++++++++++++++++ Test.js | 21 +++++ index.html | 11 +++ src/DataDeserializer.js | 115 ++++++++++++++++++++++++++ src/DataSerializer.js | 134 ++++++++++++++++++++++++++++++ src/WebSocketClient.js | 111 +++++++++++++++++++++++++ 6 files changed, 568 insertions(+) create mode 100644 LICENSE create mode 100644 Test.js create mode 100644 index.html create mode 100644 src/DataDeserializer.js create mode 100644 src/DataSerializer.js create mode 100644 src/WebSocketClient.js diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..d9a10c0 --- /dev/null +++ b/LICENSE @@ -0,0 +1,176 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS diff --git a/Test.js b/Test.js new file mode 100644 index 0000000..6abc62d --- /dev/null +++ b/Test.js @@ -0,0 +1,21 @@ +// For conditions of distribution and use, see copyright notice in LICENSE + +var client = new WebSocketClient(); + +client.addCallback("Connect", onConnect); +client.addCallback("Message", onMessageReceived); +client.connect("localhost", 2345); + +function onConnect() { + console.log("Connected to server"); + var ds = client.startNewMessage(cLoginMessage, 1024); // Login + var loginData = {"name": "Test User"}; + var loginText = JSON.stringify(loginData); + ds.addUtf8String(loginText); + client.endAndQueueMessage(ds); +} + +function onMessageReceived(dd) { + console.log("Got message, data size " + dd.size + " message ID " + dd.readU16()); + +} diff --git a/index.html b/index.html new file mode 100644 index 0000000..c572b6e --- /dev/null +++ b/index.html @@ -0,0 +1,11 @@ + + + WebTundra networking test + + + + + + + + diff --git a/src/DataDeserializer.js b/src/DataDeserializer.js new file mode 100644 index 0000000..277f281 --- /dev/null +++ b/src/DataDeserializer.js @@ -0,0 +1,115 @@ +// For conditions of distribution and use, see copyright notice in LICENSE + +function DataDeserializer(arrayBuffer) { + this.arrayBuffer = arrayBuffer; + this.bytes = new Uint8Array(arrayBuffer); + this.bitPos = 0; + this.bytePos = 0; + this.size = this.bytes.length; +} + +DataDeserializer.prototype = { + resetTraversal: function() { + this.bitPos = 0; + this.bytePos = 0; + }, + + readU8 : function() { + if (this.bitPos == 0) + return this.bytes[this.bytePos++]; + else + return this.readBits(8); + }, + + readU16 : function() { + return this.readU8() | (this.readU8() << 8); + }, + + readU32 : function() { + return this.readU8() | (this.readU8() << 8) | (this.readU8() << 16) | (this.readU8() << 24); + }, + + readVLE : function() { + var low = readU8(); + if ((low & 128) == 0) + return low; + low = low & 127; + var med = readU8(); + if ((med & 128) == 0) + return low | (med << 7); + med = med & 127; + var high = readU16(); + return low | (med << 7) | (high << 14); + }, + + readBits : function(bitCount) { + var ret = 0; + var shift = 0; + while (bitCount > 0) { + if (this.bytes[this.bytePos] & (1 << this.bitPos)) + ret = ret | (1 << shift); + this.bitPos++; + if (this.bitPos > 7) { + this.bitPos = 0; + this.bytePos++; + } + shift++; + bitCount--; + } + + return ret; + }, + + readUtf8Char : function() { + /// \todo add error handling + var char1 = this.readU8(); + if (char1 < 0x80) + return char1; + else if (char1 < 0xe0) { + var char2 = this.readU8(); + return (char2 & 0x3f) | ((char1 & 0x1f) << 6); + } + else if (char1 < 0xf0) { + var char2 = this.readU8(); + var char3 = this.readU8(); + return (char3 & 0x3f) | ((char2 & 0x3f) << 6) | ((char1 & 0xf) << 12); + } + else if (char1 < 0xf8) { + var char2 = this.readU8(); + var char3 = this.readU8(); + var char4 = this.readU8(); + return (char4 & 0x3f) | ((char3 & 0x3f) << 6) | ((char2 & 0x3f) << 12) | ((char1 & 0x7) << 18); + } + else if (char1 < 0xfc) { + var char2 = this.readU8(); + var char3 = this.readU8(); + var char4 = this.readU8(); + var char5 = this.readU8(); + return (char5 & 0x3f) | ((char4 & 0x3f) << 6) | ((char3 & 0x3f) << 12) | ((char2 & 0x3f) << 18) | ((char1 & 0x3) << 24); + } + else { + var char2 = this.readU8(); + var char3 = this.readU8(); + var char4 = this.readU8(); + var char5 = this.readU8(); + var char6 = this.readU8(); + return (char6 & 0x3f) | ((char5 & 0x3f) << 6) | ((char4 & 0x3f) << 12) | ((char3 & 0x3f) << 18) | ((char2 & 0x3f) << 24) | + ((char1 & 0x1) << 30); + } + }, + + readUtf8String : function() { + var endPos = this.bytePos + this.readU16(); + var ret = ""; + while (this.bytePos < endPos) + ret += String.fromCharCode(this.readUtf8Char()); + }, + + bytesLeft : function() { + return this.bytePos >= this.size ? 0 : this.size - this.bytePos; + }, + + bitsLeft : function() { + return this.bytePos >= this.size ? 0 : (this.size - this.bytePos) * 8 - this.bitPos; + } +} diff --git a/src/DataSerializer.js b/src/DataSerializer.js new file mode 100644 index 0000000..f08c01a --- /dev/null +++ b/src/DataSerializer.js @@ -0,0 +1,134 @@ +// For conditions of distribution and use, see copyright notice in LICENSE + +function DataSerializer(lengthBytes) { + this.arrayBuffer = new ArrayBuffer(lengthBytes); + this.bytes = new Uint8Array(this.arrayBuffer); + this.bitPos = 0; + this.bytePos = 0; +} + +DataSerializer.prototype = { + addU8 : function(value) { + if (this.bitPos == 0) + this.bytes[this.bytePos++] = value; + else + this.addBits(8, value); + }, + + addU16 : function(value) { + this.addU8(value & 255); + this.addU8(value >> 8); + }, + + addU32 : function(value) { + this.addU8(value & 255); + this.addU8((value >> 8) & 255); + this.addU8((value >> 16) & 255); + this.addU8((value >> 24) & 255); + }, + + addVLE : function(value) { + if (value < 128) + this.addU8(value); + else if (value < 16384) { + this.addU8((value & 127) | 128); + this.addU8(value >> 7); + } + else { + this.addU8((value & 127) | 128); + this.addU8(((value >> 7) & 127) | 128); + this.addU16(value >> 14); + } + }, + + addBits : function(bitCount, value) { + var shift = 0; + while (bitCount > 0) { + if (value & (1 << shift)) + this.bytes[this.bytePos] = this.bytes[this.bytePos] | (1 << this.bitPos); + else + this.bytes[this.bytePos] = this.bytes[this.bytePos] & (255 - (1 << this.bitPos)); + this.bitPos++; + if (this.bitPos > 7) { + this.bitPos = 0; + this.bytePos++; + } + shift++; + bitCount--; + } + }, + + countUtf8ByteSize : function(value) { + var bytes = 0; + for (var i = 0; i < value.length; i++) { + var c = value.charCodeAt(i); + if (c < 0x80) + bytes++; + else if (c < 0x800) + bytes += 2; + else if (c < 0x10000) + bytes += 3; + else if (c < 0x200000) + bytes += 4; + else if (c < 0x4000000) + bytes += 5; + else + bytes += 6; + } + return bytes; + }, + + addUtf8Char : function(value) { + if (value < 0x80) + this.addU8(value); + else if (value < 0x800) { + this.addU8(0xc0 | ((value >> 6) & 0x1f)); + addU8(0x80 | (value & 0x3f)); + } + else if (value < 0x10000) { + addU8(0xe0 | ((value >> 12) & 0xf)); + addU8(0x80 | ((value >> 6) & 0x3f)); + addU8(0x80 | (value & 0x3f)); + } + else if (value < 0x200000) { + addU8(0xf0 | ((value >> 18) & 0x7)); + addU8(0x80 | ((value >> 12) & 0x3f)); + addU8(0x80 | ((value >> 6) & 0x3f)); + addU8(0x80 | (value & 0x3f)); + } + else if (value < 0x4000000) { + addU8(0xf8 | ((value >> 24) & 0x3)); + addU8(0x80 | ((value >> 18) & 0x3f)); + addU8(0x80 | ((value >> 12) & 0x3f)); + addU8(0x80 | ((value >> 6) & 0x3f)); + addU8(0x80 | (value & 0x3f)); + } + else { + addU8(0xfc | ((value >> 30) & 0x1)); + addU8(0x80 | ((value >> 24) & 0x3f)); + addU8(0x80 | ((value >> 18) & 0x3f)); + addU8(0x80 | ((value >> 12) & 0x3f)); + addU8(0x80 | ((value >> 6) & 0x3f)); + addU8(0x80 | (value & 0x3f)); + } + }, + + addUtf8String : function(value) { + this.addU16(this.countUtf8ByteSize(value)); + for (var i = 0; i < value.length; i++) + this.addUtf8Char(value.charCodeAt(i)); + }, + + bytesFilled : function() { + if (this.bitPos == 0) + return this.bytePos; + else + return this.bytePos + 1; + }, + + truncate : function() { + var newLength = this.bytesFilled(); + this.arrayBuffer = this.arrayBuffer.slice(0, newLength); + this.bytes = new Uint8Array(this.arrayBuffer); + } +} \ No newline at end of file diff --git a/src/WebSocketClient.js b/src/WebSocketClient.js new file mode 100644 index 0000000..36dc79a --- /dev/null +++ b/src/WebSocketClient.js @@ -0,0 +1,111 @@ +// For conditions of distribution and use, see copyright notice in LICENSE + +var cLoginMessage = 100; + +function WebSocketClient() { + this.webSocket = null; + this.url = ""; + this.callbacks = []; +} + +WebSocketClient.prototype = { + // Connect to a Tundra server + connect : function(host, port) { + this.url = "ws://" + host + ":" + port; + + try { + if (window.WebSocket) + this.webSocket = new window.WebSocket(this.url); + else if (window.MozWebSocket) + this.webSocket = new window.MozWebSocket(this.url); + else + { + console.log("Browser does not support WebSocket"); + return false; + } + this.webSocket.binaryType = 'arraybuffer'; + } + catch (e) { + console.error("Exception while connecting WebSocket: " + e.stack); + } + + this.webSocket.onopen = function(evt) { + this.triggerCallbacks("Connect"); + }.bind(this); + + this.webSocket.onclose = function(evt) { + this.triggerCallbacks("Disconnect"); + this.webSocket = null; + }.bind(this); + + this.webSocket.onmessage = function(evt) { + var dd = new DataDeserializer(evt.data); + this.triggerCallbacks("Message", dd); + }.bind(this); + + this.webSocket.onerror = function(evt) { + this.triggerCallbacks("Error"); + }.bind(this); + + /// \todo use keepalive-timer to avoid disconnection if connection idle for a long time + return true; + }, + + // Disconnect from a Tundra server + disconnect : function() { + if (this.webSocket) { + this.webSocket.close() + this.webSocket = null; + } + }, + + // Begin a new message. Returns the DataSerializer to which the message payload can be written. + startNewMessage : function(msgId, maxBytes) { + var ds = new DataSerializer(maxBytes); + ds.addU16(msgId); + return ds; + }, + + // Send the message to the server using a filled DataSerializer + endAndQueueMessage : function(ds) { + if (this.webSocket) { + ds.truncate(); + this.webSocket.send(ds.arrayBuffer); + } + else + console.error("No connection, can not send message"); + }, + + // Add networking callback. Eventname is "Connect", "Disconnect", "Message" or "Error" + addCallback : function(eventName, callback) { + if (this.callbacks[eventName] === undefined) + this.callbacks[eventName] = []; + this.callbacks[eventName].push(callback); + }, + + // Remove networking callback. + removeCallback : function(eventName, callback) { + if (this.callbacks[eventName] !== undefined) + { + var callbacks = this.callbacks[eventName]; + for (var i = 0; i < callbacks.length; ++i) + { + if (callbacks[i] === callback) + { + callbacks.splice(i, 1); + break; + } + } + } + }, + + // Internal function to trigger networking callbacks + triggerCallbacks : function(eventName, data) { + if (this.callbacks[eventName] !== undefined) + { + var callbacks = this.callbacks[eventName]; + for (var i = 0; i < callbacks.length; ++i) + callbacks[i](data); + } + } +} \ No newline at end of file