Source: 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 The client owning this stream.
  28.  * @param {Number} index The index of this stream.
  29.  */
  30. Guacamole.InputStream = function(client, index) {
  32.     /**
  33.      * Reference to this stream.
  34.      * @private
  35.      */
  36.     var guac_stream = this;
  38.     /**
  39.      * The index of this stream.
  40.      * @type {Number}
  41.      */
  42.     this.index = index;
  44.     /**
  45.      * Called when a blob of data is received.
  46.      * 
  47.      * @event
  48.      * @param {String} data The received base64 data.
  49.      */
  50.     this.onblob = null;
  52.     /**
  53.      * Called when this stream is closed.
  54.      * 
  55.      * @event
  56.      */
  57.     this.onend = null;
  59.     /**
  60.      * Acknowledges the receipt of a blob.
  61.      * 
  62.      * @param {String} message A human-readable message describing the error
  63.      *                         or status.
  64.      * @param {Number} code The error code, if any, or 0 for success.
  65.      */
  66.     this.sendAck = function(message, code) {
  67.         client.sendAck(guac_stream.index, message, code);
  68.     };
  70. };