* read binary data off of the receive queue.
*/
-/* [module]
- * import Util from "./util";
- */
+import * as Log from './util/logging.js';
/*jslint browser: true, bitwise: true */
/*global Util*/
-/* [module] export default */ function Websock() {
+export default function Websock() {
"use strict";
this._websocket = null; // WebSocket object
};
};
-(function () {
- "use strict";
- // this has performance issues in some versions Chromium, and
- // doesn't gain a tremendous amount of performance increase in Firefox
- // at the moment. It may be valuable to turn it on in the future.
- var ENABLE_COPYWITHIN = false;
-
- var MAX_RQ_GROW_SIZE = 40 * 1024 * 1024; // 40 MiB
+// this has performance issues in some versions Chromium, and
+// doesn't gain a tremendous amount of performance increase in Firefox
+// at the moment. It may be valuable to turn it on in the future.
+var ENABLE_COPYWITHIN = false;
+
+var MAX_RQ_GROW_SIZE = 40 * 1024 * 1024; // 40 MiB
+
+var typedArrayToString = (function () {
+ // This is only for PhantomJS, which doesn't like apply-ing
+ // with Typed Arrays
+ try {
+ var arr = new Uint8Array([1, 2, 3]);
+ String.fromCharCode.apply(null, arr);
+ return function (a) { return String.fromCharCode.apply(null, a); };
+ } catch (ex) {
+ return function (a) {
+ return String.fromCharCode.apply(
+ null, Array.prototype.slice.call(a));
+ };
+ }
+})();
- var typedArrayToString = (function () {
- // This is only for PhantomJS, which doesn't like apply-ing
- // with Typed Arrays
- try {
- var arr = new Uint8Array([1, 2, 3]);
- String.fromCharCode.apply(null, arr);
- return function (a) { return String.fromCharCode.apply(null, a); };
- } catch (ex) {
- return function (a) {
- return String.fromCharCode.apply(
- null, Array.prototype.slice.call(a));
- };
+Websock.prototype = {
+ // Getters and Setters
+ get_sQ: function () {
+ return this._sQ;
+ },
+
+ get_rQ: function () {
+ return this._rQ;
+ },
+
+ get_rQi: function () {
+ return this._rQi;
+ },
+
+ set_rQi: function (val) {
+ this._rQi = val;
+ },
+
+ // Receive Queue
+ rQlen: function () {
+ return this._rQlen - this._rQi;
+ },
+
+ rQpeek8: function () {
+ return this._rQ[this._rQi];
+ },
+
+ rQshift8: function () {
+ return this._rQ[this._rQi++];
+ },
+
+ rQskip8: function () {
+ this._rQi++;
+ },
+
+ rQskipBytes: function (num) {
+ this._rQi += num;
+ },
+
+ // TODO(directxman12): test performance with these vs a DataView
+ rQshift16: function () {
+ return (this._rQ[this._rQi++] << 8) +
+ this._rQ[this._rQi++];
+ },
+
+ rQshift32: function () {
+ return (this._rQ[this._rQi++] << 24) +
+ (this._rQ[this._rQi++] << 16) +
+ (this._rQ[this._rQi++] << 8) +
+ this._rQ[this._rQi++];
+ },
+
+ rQshiftStr: function (len) {
+ if (typeof(len) === 'undefined') { len = this.rQlen(); }
+ var arr = new Uint8Array(this._rQ.buffer, this._rQi, len);
+ this._rQi += len;
+ return typedArrayToString(arr);
+ },
+
+ rQshiftBytes: function (len) {
+ if (typeof(len) === 'undefined') { len = this.rQlen(); }
+ this._rQi += len;
+ return new Uint8Array(this._rQ.buffer, this._rQi - len, len);
+ },
+
+ rQshiftTo: function (target, len) {
+ if (len === undefined) { len = this.rQlen(); }
+ // TODO: make this just use set with views when using a ArrayBuffer to store the rQ
+ target.set(new Uint8Array(this._rQ.buffer, this._rQi, len));
+ this._rQi += len;
+ },
+
+ rQwhole: function () {
+ return new Uint8Array(this._rQ.buffer, 0, this._rQlen);
+ },
+
+ rQslice: function (start, end) {
+ if (end) {
+ return new Uint8Array(this._rQ.buffer, this._rQi + start, end - start);
+ } else {
+ return new Uint8Array(this._rQ.buffer, this._rQi + start, this._rQlen - this._rQi - start);
}
- })();
-
- Websock.prototype = {
- // Getters and Setters
- get_sQ: function () {
- return this._sQ;
- },
-
- get_rQ: function () {
- return this._rQ;
- },
-
- get_rQi: function () {
- return this._rQi;
- },
-
- set_rQi: function (val) {
- this._rQi = val;
- },
-
- // Receive Queue
- rQlen: function () {
- return this._rQlen - this._rQi;
- },
-
- rQpeek8: function () {
- return this._rQ[this._rQi];
- },
-
- rQshift8: function () {
- return this._rQ[this._rQi++];
- },
-
- rQskip8: function () {
- this._rQi++;
- },
-
- rQskipBytes: function (num) {
- this._rQi += num;
- },
-
- // TODO(directxman12): test performance with these vs a DataView
- rQshift16: function () {
- return (this._rQ[this._rQi++] << 8) +
- this._rQ[this._rQi++];
- },
-
- rQshift32: function () {
- return (this._rQ[this._rQi++] << 24) +
- (this._rQ[this._rQi++] << 16) +
- (this._rQ[this._rQi++] << 8) +
- this._rQ[this._rQi++];
- },
-
- rQshiftStr: function (len) {
- if (typeof(len) === 'undefined') { len = this.rQlen(); }
- var arr = new Uint8Array(this._rQ.buffer, this._rQi, len);
- this._rQi += len;
- return typedArrayToString(arr);
- },
-
- rQshiftBytes: function (len) {
- if (typeof(len) === 'undefined') { len = this.rQlen(); }
- this._rQi += len;
- return new Uint8Array(this._rQ.buffer, this._rQi - len, len);
- },
-
- rQshiftTo: function (target, len) {
- if (len === undefined) { len = this.rQlen(); }
- // TODO: make this just use set with views when using a ArrayBuffer to store the rQ
- target.set(new Uint8Array(this._rQ.buffer, this._rQi, len));
- this._rQi += len;
- },
-
- rQwhole: function () {
- return new Uint8Array(this._rQ.buffer, 0, this._rQlen);
- },
-
- rQslice: function (start, end) {
- if (end) {
- return new Uint8Array(this._rQ.buffer, this._rQi + start, end - start);
- } else {
- return new Uint8Array(this._rQ.buffer, this._rQi + start, this._rQlen - this._rQi - start);
- }
- },
-
- // Check to see if we must wait for 'num' bytes (default to FBU.bytes)
- // to be available in the receive queue. Return true if we need to
- // wait (and possibly print a debug message), otherwise false.
- rQwait: function (msg, num, goback) {
- var rQlen = this._rQlen - this._rQi; // Skip rQlen() function call
- if (rQlen < num) {
- if (goback) {
- if (this._rQi < goback) {
- throw new Error("rQwait cannot backup " + goback + " bytes");
- }
- this._rQi -= goback;
+ },
+
+ // Check to see if we must wait for 'num' bytes (default to FBU.bytes)
+ // to be available in the receive queue. Return true if we need to
+ // wait (and possibly print a debug message), otherwise false.
+ rQwait: function (msg, num, goback) {
+ var rQlen = this._rQlen - this._rQi; // Skip rQlen() function call
+ if (rQlen < num) {
+ if (goback) {
+ if (this._rQi < goback) {
+ throw new Error("rQwait cannot backup " + goback + " bytes");
}
- return true; // true means need more data
+ this._rQi -= goback;
}
- return false;
- },
+ return true; // true means need more data
+ }
+ return false;
+ },
- // Send Queue
+ // Send Queue
- flush: function () {
- if (this._websocket.bufferedAmount !== 0) {
- Util.Debug("bufferedAmount: " + this._websocket.bufferedAmount);
- }
+ flush: function () {
+ if (this._websocket.bufferedAmount !== 0) {
+ Log.Debug("bufferedAmount: " + this._websocket.bufferedAmount);
+ }
- if (this._sQlen > 0 && this._websocket.readyState === WebSocket.OPEN) {
- this._websocket.send(this._encode_message());
- this._sQlen = 0;
+ if (this._sQlen > 0 && this._websocket.readyState === WebSocket.OPEN) {
+ this._websocket.send(this._encode_message());
+ this._sQlen = 0;
+ }
+ },
+
+ send: function (arr) {
+ this._sQ.set(arr, this._sQlen);
+ this._sQlen += arr.length;
+ this.flush();
+ },
+
+ send_string: function (str) {
+ this.send(str.split('').map(function (chr) {
+ return chr.charCodeAt(0);
+ }));
+ },
+
+ // Event Handlers
+ off: function (evt) {
+ this._eventHandlers[evt] = function () {};
+ },
+
+ on: function (evt, handler) {
+ this._eventHandlers[evt] = handler;
+ },
+
+ _allocate_buffers: function () {
+ this._rQ = new Uint8Array(this._rQbufferSize);
+ this._sQ = new Uint8Array(this._sQbufferSize);
+ },
+
+ init: function () {
+ this._allocate_buffers();
+ this._rQi = 0;
+ this._websocket = null;
+ },
+
+ open: function (uri, protocols) {
+ var ws_schema = uri.match(/^([a-z]+):\/\//)[1];
+ this.init();
+
+ this._websocket = new WebSocket(uri, protocols);
+ this._websocket.binaryType = 'arraybuffer';
+
+ this._websocket.onmessage = this._recv_message.bind(this);
+ this._websocket.onopen = (function () {
+ Log.Debug('>> WebSock.onopen');
+ if (this._websocket.protocol) {
+ Log.Info("Server choose sub-protocol: " + this._websocket.protocol);
}
- },
-
- send: function (arr) {
- this._sQ.set(arr, this._sQlen);
- this._sQlen += arr.length;
- this.flush();
- },
-
- send_string: function (str) {
- this.send(str.split('').map(function (chr) {
- return chr.charCodeAt(0);
- }));
- },
-
- // Event Handlers
- off: function (evt) {
- this._eventHandlers[evt] = function () {};
- },
-
- on: function (evt, handler) {
- this._eventHandlers[evt] = handler;
- },
-
- _allocate_buffers: function () {
- this._rQ = new Uint8Array(this._rQbufferSize);
- this._sQ = new Uint8Array(this._sQbufferSize);
- },
-
- init: function () {
- this._allocate_buffers();
- this._rQi = 0;
- this._websocket = null;
- },
-
- open: function (uri, protocols) {
- var ws_schema = uri.match(/^([a-z]+):\/\//)[1];
- this.init();
-
- this._websocket = new WebSocket(uri, protocols);
- this._websocket.binaryType = 'arraybuffer';
-
- this._websocket.onmessage = this._recv_message.bind(this);
- this._websocket.onopen = (function () {
- Util.Debug('>> WebSock.onopen');
- if (this._websocket.protocol) {
- Util.Info("Server choose sub-protocol: " + this._websocket.protocol);
- }
-
- this._eventHandlers.open();
- Util.Debug("<< WebSock.onopen");
- }).bind(this);
- this._websocket.onclose = (function (e) {
- Util.Debug(">> WebSock.onclose");
- this._eventHandlers.close(e);
- Util.Debug("<< WebSock.onclose");
- }).bind(this);
- this._websocket.onerror = (function (e) {
- Util.Debug(">> WebSock.onerror: " + e);
- this._eventHandlers.error(e);
- Util.Debug("<< WebSock.onerror: " + e);
- }).bind(this);
- },
-
- close: function () {
- if (this._websocket) {
- if ((this._websocket.readyState === WebSocket.OPEN) ||
- (this._websocket.readyState === WebSocket.CONNECTING)) {
- Util.Info("Closing WebSocket connection");
- this._websocket.close();
- }
- this._websocket.onmessage = function (e) { return; };
+ this._eventHandlers.open();
+ Log.Debug("<< WebSock.onopen");
+ }).bind(this);
+ this._websocket.onclose = (function (e) {
+ Log.Debug(">> WebSock.onclose");
+ this._eventHandlers.close(e);
+ Log.Debug("<< WebSock.onclose");
+ }).bind(this);
+ this._websocket.onerror = (function (e) {
+ Log.Debug(">> WebSock.onerror: " + e);
+ this._eventHandlers.error(e);
+ Log.Debug("<< WebSock.onerror: " + e);
+ }).bind(this);
+ },
+
+ close: function () {
+ if (this._websocket) {
+ if ((this._websocket.readyState === WebSocket.OPEN) ||
+ (this._websocket.readyState === WebSocket.CONNECTING)) {
+ Log.Info("Closing WebSocket connection");
+ this._websocket.close();
}
- },
-
- // private methods
- _encode_message: function () {
- // Put in a binary arraybuffer
- // according to the spec, you can send ArrayBufferViews with the send method
- return new Uint8Array(this._sQ.buffer, 0, this._sQlen);
- },
-
- _expand_compact_rQ: function (min_fit) {
- var resizeNeeded = min_fit || this._rQlen - this._rQi > this._rQbufferSize / 2;
- if (resizeNeeded) {
- if (!min_fit) {
- // just double the size if we need to do compaction
- this._rQbufferSize *= 2;
- } else {
- // otherwise, make sure we satisy rQlen - rQi + min_fit < rQbufferSize / 8
- this._rQbufferSize = (this._rQlen - this._rQi + min_fit) * 8;
- }
+
+ this._websocket.onmessage = function (e) { return; };
+ }
+ },
+
+ // private methods
+ _encode_message: function () {
+ // Put in a binary arraybuffer
+ // according to the spec, you can send ArrayBufferViews with the send method
+ return new Uint8Array(this._sQ.buffer, 0, this._sQlen);
+ },
+
+ _expand_compact_rQ: function (min_fit) {
+ var resizeNeeded = min_fit || this._rQlen - this._rQi > this._rQbufferSize / 2;
+ if (resizeNeeded) {
+ if (!min_fit) {
+ // just double the size if we need to do compaction
+ this._rQbufferSize *= 2;
+ } else {
+ // otherwise, make sure we satisy rQlen - rQi + min_fit < rQbufferSize / 8
+ this._rQbufferSize = (this._rQlen - this._rQi + min_fit) * 8;
}
+ }
- // we don't want to grow unboundedly
- if (this._rQbufferSize > MAX_RQ_GROW_SIZE) {
- this._rQbufferSize = MAX_RQ_GROW_SIZE;
- if (this._rQbufferSize - this._rQlen - this._rQi < min_fit) {
- throw new Exception("Receive Queue buffer exceeded " + MAX_RQ_GROW_SIZE + " bytes, and the new message could not fit");
- }
+ // we don't want to grow unboundedly
+ if (this._rQbufferSize > MAX_RQ_GROW_SIZE) {
+ this._rQbufferSize = MAX_RQ_GROW_SIZE;
+ if (this._rQbufferSize - this._rQlen - this._rQi < min_fit) {
+ throw new Exception("Receive Queue buffer exceeded " + MAX_RQ_GROW_SIZE + " bytes, and the new message could not fit");
}
+ }
- if (resizeNeeded) {
- var old_rQbuffer = this._rQ.buffer;
- this._rQmax = this._rQbufferSize / 8;
- this._rQ = new Uint8Array(this._rQbufferSize);
- this._rQ.set(new Uint8Array(old_rQbuffer, this._rQi));
+ if (resizeNeeded) {
+ var old_rQbuffer = this._rQ.buffer;
+ this._rQmax = this._rQbufferSize / 8;
+ this._rQ = new Uint8Array(this._rQbufferSize);
+ this._rQ.set(new Uint8Array(old_rQbuffer, this._rQi));
+ } else {
+ if (ENABLE_COPYWITHIN) {
+ this._rQ.copyWithin(0, this._rQi);
} else {
- if (ENABLE_COPYWITHIN) {
- this._rQ.copyWithin(0, this._rQi);
- } else {
- this._rQ.set(new Uint8Array(this._rQ.buffer, this._rQi));
- }
+ this._rQ.set(new Uint8Array(this._rQ.buffer, this._rQi));
}
+ }
- this._rQlen = this._rQlen - this._rQi;
- this._rQi = 0;
- },
+ this._rQlen = this._rQlen - this._rQi;
+ this._rQi = 0;
+ },
- _decode_message: function (data) {
- // push arraybuffer values onto the end
- var u8 = new Uint8Array(data);
- if (u8.length > this._rQbufferSize - this._rQlen) {
- this._expand_compact_rQ(u8.length);
- }
- this._rQ.set(u8, this._rQlen);
- this._rQlen += u8.length;
- },
-
- _recv_message: function (e) {
- try {
- this._decode_message(e.data);
- if (this.rQlen() > 0) {
- this._eventHandlers.message();
- // Compact the receive queue
- if (this._rQlen == this._rQi) {
- this._rQlen = 0;
- this._rQi = 0;
- } else if (this._rQlen > this._rQmax) {
- this._expand_compact_rQ();
- }
- } else {
- Util.Debug("Ignoring empty message");
- }
- } catch (exc) {
- var exception_str = "";
- if (exc.name) {
- exception_str += "\n name: " + exc.name + "\n";
- exception_str += " message: " + exc.message + "\n";
- }
+ _decode_message: function (data) {
+ // push arraybuffer values onto the end
+ var u8 = new Uint8Array(data);
+ if (u8.length > this._rQbufferSize - this._rQlen) {
+ this._expand_compact_rQ(u8.length);
+ }
+ this._rQ.set(u8, this._rQlen);
+ this._rQlen += u8.length;
+ },
- if (typeof exc.description !== 'undefined') {
- exception_str += " description: " + exc.description + "\n";
+ _recv_message: function (e) {
+ try {
+ this._decode_message(e.data);
+ if (this.rQlen() > 0) {
+ this._eventHandlers.message();
+ // Compact the receive queue
+ if (this._rQlen == this._rQi) {
+ this._rQlen = 0;
+ this._rQi = 0;
+ } else if (this._rQlen > this._rQmax) {
+ this._expand_compact_rQ();
}
+ } else {
+ Log.Debug("Ignoring empty message");
+ }
+ } catch (exc) {
+ var exception_str = "";
+ if (exc.name) {
+ exception_str += "\n name: " + exc.name + "\n";
+ exception_str += " message: " + exc.message + "\n";
+ }
- if (typeof exc.stack !== 'undefined') {
- exception_str += exc.stack;
- }
+ if (typeof exc.description !== 'undefined') {
+ exception_str += " description: " + exc.description + "\n";
+ }
- if (exception_str.length > 0) {
- Util.Error("recv_message, caught exception: " + exception_str);
- } else {
- Util.Error("recv_message, caught exception: " + exc);
- }
+ if (typeof exc.stack !== 'undefined') {
+ exception_str += exc.stack;
+ }
- if (typeof exc.name !== 'undefined') {
- this._eventHandlers.error(exc.name + ": " + exc.message);
- } else {
- this._eventHandlers.error(exc);
- }
+ if (exception_str.length > 0) {
+ Log.Error("recv_message, caught exception: " + exception_str);
+ } else {
+ Log.Error("recv_message, caught exception: " + exc);
+ }
+
+ if (typeof exc.name !== 'undefined') {
+ this._eventHandlers.error(exc.name + ": " + exc.message);
+ } else {
+ this._eventHandlers.error(exc);
}
}
- };
-})();
+ }
+};