Source: main/webapp/modules/OutputStream.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.  * Abstract stream which can receive data.
  24.  * 
  25.  * @constructor
  26.  * @param {!Guacamole.Client} client
  27.  *     The client owning this stream.
  28.  *
  29.  * @param {!number} index
  30.  *     The index of this stream.
  31.  */
  32. Guacamole.OutputStream = function(client, index) {
  34.     /**
  35.      * Reference to this stream.
  36.      *
  37.      * @private
  38.      * @type {!Guacamole.OutputStream}
  39.      */
  40.     var guac_stream = this;
  42.     /**
  43.      * The index of this stream.
  44.      * @type {!number}
  45.      */
  46.     this.index = index;
  48.     /**
  49.      * Fired whenever an acknowledgement is received from the server, indicating
  50.      * that a stream operation has completed, or an error has occurred.
  51.      * 
  52.      * @event
  53.      * @param {!Guacamole.Status} status
  54.      *     The status of the operation.
  55.      */
  56.     this.onack = null;
  58.     /**
  59.      * Writes the given base64-encoded data to this stream as a blob.
  60.      * 
  61.      * @param {!string} data
  62.      *     The base64-encoded data to send.
  63.      */
  64.     this.sendBlob = function(data) {
  65.         client.sendBlob(guac_stream.index, data);
  66.     };
  68.     /**
  69.      * Closes this stream.
  70.      */
  71.     this.sendEnd = function() {
  72.         client.endStream(guac_stream.index);
  73.     };
  75. };