Source: main/webapp/modules/StringReader.js

  1. /*
  2.  * Licensed to the Apache Software Foundation (ASF) under one
  3.  * or more contributor license agreements.  See the NOTICE file
  4.  * distributed with this work for additional information
  5.  * regarding copyright ownership.  The ASF licenses this file
  6.  * to you under the Apache License, Version 2.0 (the
  7.  * "License"); you may not use this file except in compliance
  8.  * with the License.  You may obtain a copy of the License at
  9.  *
  10.  *   http://www.apache.org/licenses/LICENSE-2.0
  11.  *
  12.  * Unless required by applicable law or agreed to in writing,
  13.  * software distributed under the License is distributed on an
  14.  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  15.  * KIND, either express or implied.  See the License for the
  16.  * specific language governing permissions and limitations
  17.  * under the License.
  18.  */
  20. var Guacamole = Guacamole || {};
  22. /**
  23.  * A reader which automatically handles the given input stream, returning
  24.  * strictly text data. Note that this object will overwrite any installed event
  25.  * handlers on the given Guacamole.InputStream.
  26.  * 
  27.  * @constructor
  28.  * @param {!Guacamole.InputStream} stream
  29.  *     The stream that data will be read from.
  30.  */
  31. Guacamole.StringReader = function(stream) {
  33.     /**
  34.      * Reference to this Guacamole.InputStream.
  35.      *
  36.      * @private
  37.      * @type {!Guacamole.StringReader}
  38.      */
  39.     var guac_reader = this;
  41.     /**
  42.      * Parser for received UTF-8 data.
  43.      *
  44.      * @type {!Guacamole.UTF8Parser}
  45.      */
  46.     var utf8Parser = new Guacamole.UTF8Parser();
  48.     /**
  49.      * Wrapped Guacamole.ArrayBufferReader.
  50.      *
  51.      * @private
  52.      * @type {!Guacamole.ArrayBufferReader}
  53.      */
  54.     var array_reader = new Guacamole.ArrayBufferReader(stream);
  56.     // Receive blobs as strings
  57.     array_reader.ondata = function(buffer) {
  59.         // Decode UTF-8
  60.         var text = utf8Parser.decode(buffer);
  62.         // Call handler, if present
  63.         if (guac_reader.ontext)
  64.             guac_reader.ontext(text);
  66.     };
  68.     // Simply call onend when end received
  69.     array_reader.onend = function() {
  70.         if (guac_reader.onend)
  71.             guac_reader.onend();
  72.     };
  74.     /**
  75.      * Fired once for every blob of text data received.
  76.      * 
  77.      * @event
  78.      * @param {!string} text
  79.      *     The data packet received.
  80.      */
  81.     this.ontext = null;
  83.     /**
  84.      * Fired once this stream is finished and no further data will be written.
  85.      * @event
  86.      */
  87.     this.onend = null;
  89. };