Source: main/webapp/modules/InputStream.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.  * An input stream abstraction used by the Guacamole client to facilitate
  24.  * transfer of files or other binary data.
  25.  * 
  26.  * @constructor
  27.  * @param {!Guacamole.Client} client
  28.  *     The client owning this stream.
  29.  *
  30.  * @param {!number} index
  31.  *     The index of this stream.
  32.  */
  33. Guacamole.InputStream = function(client, index) {
  35.     /**
  36.      * Reference to this stream.
  37.      *
  38.      * @private
  39.      * @type {!Guacamole.InputStream}
  40.      */
  41.     var guac_stream = this;
  43.     /**
  44.      * The index of this stream.
  45.      *
  46.      * @type {!number}
  47.      */
  48.     this.index = index;
  50.     /**
  51.      * Called when a blob of data is received.
  52.      * 
  53.      * @event
  54.      * @param {!string} data
  55.      *     The received base64 data.
  56.      */
  57.     this.onblob = null;
  59.     /**
  60.      * Called when this stream is closed.
  61.      * 
  62.      * @event
  63.      */
  64.     this.onend = null;
  66.     /**
  67.      * Acknowledges the receipt of a blob.
  68.      * 
  69.      * @param {!string} message
  70.      *     A human-readable message describing the error or status.
  71.      *
  72.      * @param {!number} code
  73.      *     The error code, if any, or 0 for success.
  74.      */
  75.     this.sendAck = function(message, code) {
  76.         client.sendAck(guac_stream.index, message, code);
  77.     };
  79. };