Merge pull request #22 from sourcelair/issue/21

Introduce bufferred attaching to websocket

addons/attach/attach.js

@@ -1,7 +1,7 @@
 /*
  * Implements the attach method, that
  * attaches the terminal to a WebSocket stream.
- * 
+ *
  * The bidirectional argument indicates, whether the terminal should
  * send data to the socket as well and is true, by default.
  */
@@ -15,45 +15,81 @@
     } else {
         /*
          * Plain browser environment
-         */ 
+         */
         attach(this.Xterm);
     }
 })(function (Xterm) {
-    Xterm.prototype.attach = function (socket, bidirectional) {
-      var term = this;
+    /**
+     * Attaches the current terminal to the given socket
+     *
+     * @param {WebSocket} socket - The socket to attach the current terminal
+     * @param {boolean} bidirectional - Whether the terminal should send data
+     *                                  to the socket as well
+     * @param {boolean} buffered - Whether the rendering of incoming data
+     *                             should happen instantly or at a maximum
+     *                             frequency of 1 rendering per 10ms
+     */
+    Xterm.prototype.attach = function (socket, bidirectional, buffered) {
+        var term = this;
 
-      bidirectional = (typeof bidirectional == 'undefined') ? true : bidirectional;
-      this.socket = socket;
+        bidirectional = (typeof bidirectional == 'undefined') ? true : bidirectional;
+        this.socket = socket;
 
-      term._getMessage = function (ev) {
-        term.write(ev.data);
-      };
-        
-      term._sendData = function (data) {
-        socket.send(data);
-      };
+        term._flushBuffer = function () {
+            term.write(term._attachSocketBuffer);
+            term._attachSocketBuffer = null;
+            clearTimeout(term._attachSocketBufferTimer);
+            term._attachSocketBufferTimer = null;
+        };
 
-      socket.addEventListener('message', term._getMessage);
+        term._pushToBuffer = function (data) {
+            if (term._attachSocketBuffer) {
+                term._attachSocketBuffer += data;
+            } else {
+                term._attachSocketBuffer = data;
+                setTimeout(term._flushBuffer, 10);
+            }
+        };
 
-      if (bidirectional) {
-        this.on('data', term._sendData);
-      }
-      
-      socket.addEventListener('close', term.detach.bind(term, socket));
-      socket.addEventListener('error', term.detach.bind(term, socket));
+        term._getMessage = function (ev) {
+            if (buffered) {
+                term._pushToBuffer(ev.data);
+            } else {
+                term.write(ev.data);
+            }
+        };
+
+        term._sendData = function (data) {
+            socket.send(data);
+        };
+
+        socket.addEventListener('message', term._getMessage);
+
+        if (bidirectional) {
+            this.on('data', term._sendData);
+        }
+
+        socket.addEventListener('close', term.detach.bind(term, socket));
+        socket.addEventListener('error', term.detach.bind(term, socket));
     };
-    
+
+    /**
+     * Detaches the current terminal from the given socket
+     *
+     * @param {WebSocket} socket - The socket from which to detach the current
+     *                             terminal
+     */
     Xterm.prototype.detach = function (socket) {
-      var term = this;
+        var term = this;
 
-      term.off('data', term._sendData);
+        term.off('data', term._sendData);
 
-      socket = (typeof socket == 'undefined') ? term.socket : socket;
+        socket = (typeof socket == 'undefined') ? term.socket : socket;
 
-      if (socket) {
-        socket.removeEventListener('message', term._getMessage);
-      }
+        if (socket) {
+            socket.removeEventListener('message', term._getMessage);
+        }
 
-      delete term.socket;
+        delete term.socket;
     };
 });