Return-Path: X-Original-To: archive-asf-public-internal@cust-asf2.ponee.io Delivered-To: archive-asf-public-internal@cust-asf2.ponee.io Received: from cust-asf.ponee.io (cust-asf.ponee.io [163.172.22.183]) by cust-asf2.ponee.io (Postfix) with ESMTP id 8CD3E200C37 for ; Sun, 19 Mar 2017 23:49:11 +0100 (CET) Received: by cust-asf.ponee.io (Postfix) id 8B671160B6D; Sun, 19 Mar 2017 22:49:11 +0000 (UTC) Delivered-To: archive-asf-public@cust-asf.ponee.io Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by cust-asf.ponee.io (Postfix) with SMTP id 90196160B7D for ; Sun, 19 Mar 2017 23:49:09 +0100 (CET) Received: (qmail 9937 invoked by uid 500); 19 Mar 2017 22:49:08 -0000 Mailing-List: contact commits-help@guacamole.incubator.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@guacamole.incubator.apache.org Delivered-To: mailing list commits@guacamole.incubator.apache.org Received: (qmail 9928 invoked by uid 99); 19 Mar 2017 22:49:08 -0000 Received: from pnap-us-west-generic-nat.apache.org (HELO spamd3-us-west.apache.org) (209.188.14.142) by apache.org (qpsmtpd/0.29) with ESMTP; Sun, 19 Mar 2017 22:49:08 +0000 Received: from localhost (localhost [127.0.0.1]) by spamd3-us-west.apache.org (ASF Mail Server at spamd3-us-west.apache.org) with ESMTP id 3C3EA184962 for ; Sun, 19 Mar 2017 22:49:08 +0000 (UTC) X-Virus-Scanned: Debian amavisd-new at spamd3-us-west.apache.org X-Spam-Flag: NO X-Spam-Score: -2.369 X-Spam-Level: X-Spam-Status: No, score=-2.369 tagged_above=-999 required=6.31 tests=[KAM_ASCII_DIVIDERS=0.8, KAM_LINEPADDING=1.2, RCVD_IN_DNSWL_HI=-5, RCVD_IN_MSPIKE_H3=-0.01, RCVD_IN_MSPIKE_WL=-0.01, RP_MATCHES_RCVD=-0.001, SPF_NEUTRAL=0.652] autolearn=disabled Received: from mx1-lw-eu.apache.org ([10.40.0.8]) by localhost (spamd3-us-west.apache.org [10.40.0.10]) (amavisd-new, port 10024) with ESMTP id sdzjaWDGafeA for ; Sun, 19 Mar 2017 22:48:57 +0000 (UTC) Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by mx1-lw-eu.apache.org (ASF Mail Server at mx1-lw-eu.apache.org) with SMTP id 6BD6360D78 for ; Sun, 19 Mar 2017 22:48:48 +0000 (UTC) Received: (qmail 8873 invoked by uid 99); 19 Mar 2017 22:48:47 -0000 Received: from git1-us-west.apache.org (HELO git1-us-west.apache.org) (140.211.11.23) by apache.org (qpsmtpd/0.29) with ESMTP; Sun, 19 Mar 2017 22:48:47 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id 7992CDFF71; Sun, 19 Mar 2017 22:48:47 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: mjumper@apache.org To: commits@guacamole.incubator.apache.org Date: Sun, 19 Mar 2017 22:49:20 -0000 Message-Id: In-Reply-To: <93aebcc0251142d4a4e4e5b9789d3275@git.apache.org> References: <93aebcc0251142d4a4e4e5b9789d3275@git.apache.org> X-Mailer: ASF-Git Admin Mailer Subject: [35/51] [partial] incubator-guacamole-website git commit: Deploy draft documentation for 0.9.12-incubating. archived-at: Sun, 19 Mar 2017 22:49:11 -0000 http://git-wip-us.apache.org/repos/asf/incubator-guacamole-website/blob/31f2d19d/content/doc/0.9.12-incubating/guacamole-common-js/Guacamole.WebSocketTunnel.html ---------------------------------------------------------------------- diff --git a/content/doc/0.9.12-incubating/guacamole-common-js/Guacamole.WebSocketTunnel.html b/content/doc/0.9.12-incubating/guacamole-common-js/Guacamole.WebSocketTunnel.html new file mode 100644 index 0000000..c8e0936 --- /dev/null +++ b/content/doc/0.9.12-incubating/guacamole-common-js/Guacamole.WebSocketTunnel.html @@ -0,0 +1,1287 @@ + + + + + JSDoc: Class: WebSocketTunnel + + + + + + + + + + +
+ +

Class: WebSocketTunnel

+ + + + + + +
+ +
+ +

+ Guacamole.WebSocketTunnel

+ + +
+ +
+
+ + + + + +

new WebSocketTunnel(tunnelURL)

+ + + + + +
+ Guacamole Tunnel implemented over WebSocket via XMLHttpRequest. +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
tunnelURL + + +String + + + + The URL of the WebSocket tunneling service.
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + + + +
+ + +

Extends

+ + + + + + + + + + + + + + + + + + +

Members

+ + + +

receiveTimeout :Number

+ + + + +
+ The maximum amount of time to wait for data to be received, in +milliseconds. If data is not received within this amount of time, +the tunnel is closed with an error. The default value is 15000. +
+ + + +
Type:
+
    +
  • + +Number + + +
    • +
+ + + + + +
+ + + + + + +
Inherited From:
+
+ + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

state :Number

+ + + + +
+ The current state of this tunnel. +
+ + + +
Type:
+
    +
  • + +Number + + +
    • +
+ + + + + +
+ + + + + + +
Inherited From:
+
+ + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

uuid :String

+ + + + +
+ The UUID uniquely identifying this tunnel. If not yet known, this will +be null. +
+ + + +
Type:
+
    +
  • + +String + + +
    • +
+ + + + + +
+ + + + + + +
Inherited From:
+
+ + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + +

Methods

+ + + + + + +

connect(data)

+ + + + + +
+ Connect to the tunnel with the given optional data. This data is +typically used for authentication. The format of data accepted is +up to the tunnel implementation. +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
data + + +String + + + + The data to send to the tunnel when connecting.
+ + + + + + +
+ + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + +

disconnect()

+ + + + + +
+ Disconnect from the tunnel. +
+ + + + + + + + + + + + + +
+ + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + +

sendMessage(…elements)

+ + + + + +
+ Send the given message through the tunnel to the service on the other +side. All messages are guaranteed to be received in the order sent. +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
elements + + +* + + + + + + + + + + <repeatable>
+ + 		The elements of the message to send to the service on the other side + of the tunnel.
+ + + + + + +
+ + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + +

Events

+ + + + + + +

onerror

+ + + + + +
+ Fired whenever an error is encountered by the tunnel. +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
status + + +Guacamole.Status + + + + A status object which describes the + error.
+ + + + + + +
+ + + + + + +
Inherited From:
+
+ + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + +

oninstruction

+ + + + + +
+ Fired once for every complete Guacamole instruction received, in order. +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
opcode + + +String + + + + The Guacamole instruction opcode.
parameters + + +Array + + + + The parameters provided for the instruction, + if any.
+ + + + + + +
+ + + + + + +
Inherited From:
+
+ + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + +

onstatechange

+ + + + + +
+ Fired whenever the state of the tunnel changes. +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
state + + +Number + + + + The new state of the client.
+ + + + + + +
+ + + + + + +
Inherited From:
+
+ + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + + +
+ +
+ Documentation generated by JSDoc 3.4.0 on Sat Mar 18 2017 19:26:50 GMT-0700 (PDT) +
+ + + + + + + \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-guacamole-website/blob/31f2d19d/content/doc/0.9.12-incubating/guacamole-common-js/Guacamole.html ---------------------------------------------------------------------- diff --git a/content/doc/0.9.12-incubating/guacamole-common-js/Guacamole.html b/content/doc/0.9.12-incubating/guacamole-common-js/Guacamole.html new file mode 100644 index 0000000..8d2bcc3 --- /dev/null +++ b/content/doc/0.9.12-incubating/guacamole-common-js/Guacamole.html @@ -0,0 +1,321 @@ + + + + + JSDoc: Namespace: Guacamole + + + + + + + + + + +
+ +

Namespace: Guacamole

+ + + + + + +
+ +
+ +

Guacamole

+ + +
+ +
+
+ + +
The namespace used by the Guacamole JavaScript API. Absolutely all classes +defined by the Guacamole JavaScript API will be within this namespace.
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + +
+ + + + + + +

Classes

+ +
+
ArrayBufferReader
+
+ +
ArrayBufferWriter
+
+ +
AudioPlayer
+
+ +
AudioRecorder
+
+ +
BlobReader
+
+ +
BlobWriter
+
+ +
ChainedTunnel
+
+ +
Client
+
+ +
DataURIReader
+
+ +
Display
+
+ +
HTTPTunnel
+
+ +
InputStream
+
+ +
IntegerPool
+
+ +
JSONReader
+
+ +
Keyboard
+
+ +
Layer
+
+ +
Mouse
+
+ +
Object
+
+ +
OnScreenKeyboard
+
+ +
OutputStream
+
+ +
Parser
+
+ +
RawAudioFormat
+
+ +
RawAudioPlayer
+
+ +
RawAudioRecorder
+
+ +
Status
+
+ +
StringReader
+
+ +
StringWriter
+
+ +
Tunnel
+
+ +
VideoPlayer
+
+ +
WebSocketTunnel
+
+
+ + + + + +

Namespaces

+ +
+
AudioContextFactory
+
+
+ + + +

Members

+ + + +

(static) API_VERSION :String

+ + + + +
+ The unique ID of this version of the Guacamole JavaScript API. This ID will +be the version string of the guacamole-common-js Maven project, and can be +used in downstream applications as a sanity check that the proper version +of the APIs is being used (in case an older version is cached, for example). +
+ + + +
Type:
+
    +
  • + +String + + +
    • +
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + +
+ +
+ + + + +
+ + + +
+ +
+ Documentation generated by JSDoc 3.4.0 on Sat Mar 18 2017 19:26:49 GMT-0700 (PDT) +
+ + + + + + + \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-guacamole-website/blob/31f2d19d/content/doc/0.9.12-incubating/guacamole-common-js/InputStream.js.html ---------------------------------------------------------------------- diff --git a/content/doc/0.9.12-incubating/guacamole-common-js/InputStream.js.html b/content/doc/0.9.12-incubating/guacamole-common-js/InputStream.js.html new file mode 100644 index 0000000..faf2a31 --- /dev/null +++ b/content/doc/0.9.12-incubating/guacamole-common-js/InputStream.js.html @@ -0,0 +1,131 @@ + + + + + JSDoc: Source: InputStream.js + + + + + + + + + + +
+ +

Source: InputStream.js

+ + + + + + +
+
+ 
/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+var Guacamole = Guacamole || {};
+
+/**
+ * An input stream abstraction used by the Guacamole client to facilitate
+ * transfer of files or other binary data.
+ * 
+ * @constructor
+ * @param {Guacamole.Client} client The client owning this stream.
+ * @param {Number} index The index of this stream.
+ */
+Guacamole.InputStream = function(client, index) {
+
+    /**
+     * Reference to this stream.
+     * @private
+     */
+    var guac_stream = this;
+
+    /**
+     * The index of this stream.
+     * @type {Number}
+     */
+    this.index = index;
+
+    /**
+     * Called when a blob of data is received.
+     * 
+     * @event
+     * @param {String} data The received base64 data.
+     */
+    this.onblob = null;
+
+    /**
+     * Called when this stream is closed.
+     * 
+     * @event
+     */
+    this.onend = null;
+
+    /**
+     * Acknowledges the receipt of a blob.
+     * 
+     * @param {String} message A human-readable message describing the error
+     *                         or status.
+     * @param {Number} code The error code, if any, or 0 for success.
+     */
+    this.sendAck = function(message, code) {
+        client.sendAck(guac_stream.index, message, code);
+    };
+
+};
+
+
+
+ + + + +
+ + + +
+ +
+ Documentation generated by JSDoc 3.4.0 on Sat Mar 18 2017 19:26:49 GMT-0700 (PDT) +
+ + + + + + + http://git-wip-us.apache.org/repos/asf/incubator-guacamole-website/blob/31f2d19d/content/doc/0.9.12-incubating/guacamole-common-js/IntegerPool.js.html ---------------------------------------------------------------------- diff --git a/content/doc/0.9.12-incubating/guacamole-common-js/IntegerPool.js.html b/content/doc/0.9.12-incubating/guacamole-common-js/IntegerPool.js.html new file mode 100644 index 0000000..9a77be4 --- /dev/null +++ b/content/doc/0.9.12-incubating/guacamole-common-js/IntegerPool.js.html @@ -0,0 +1,137 @@ + + + + + JSDoc: Source: IntegerPool.js + + + + + + + + + + +
+ +

Source: IntegerPool.js

+ + + + + + +
+
+ 
/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+var Guacamole = Guacamole || {};
+
+/**
+ * Integer pool which returns consistently increasing integers while integers
+ * are in use, and previously-used integers when possible.
+ * @constructor 
+ */
+Guacamole.IntegerPool = function() {
+
+    /**
+     * Reference to this integer pool.
+     *
+     * @private
+     */
+    var guac_pool = this;
+
+    /**
+     * Array of available integers.
+     *
+     * @private
+     * @type {Number[]}
+     */
+    var pool = [];
+
+    /**
+     * The next integer to return if no more integers remain.
+     * @type {Number}
+     */
+    this.next_int = 0;
+
+    /**
+     * Returns the next available integer in the pool. If possible, a previously
+     * used integer will be returned.
+     * 
+     * @return {Number} The next available integer.
+     */
+    this.next = function() {
+
+        // If free'd integers exist, return one of those
+        if (pool.length > 0)
+            return pool.shift();
+
+        // Otherwise, return a new integer
+        return guac_pool.next_int++;
+
+    };
+
+    /**
+     * Frees the given integer, allowing it to be reused.
+     * 
+     * @param {Number} integer The integer to free.
+     */
+    this.free = function(integer) {
+        pool.push(integer);
+    };
+
+};
+
+
+
+ + + + +
+ + + +
+ +
+ Documentation generated by JSDoc 3.4.0 on Sat Mar 18 2017 19:26:49 GMT-0700 (PDT) +
+ + + + + + + http://git-wip-us.apache.org/repos/asf/incubator-guacamole-website/blob/31f2d19d/content/doc/0.9.12-incubating/guacamole-common-js/JSONReader.js.html ---------------------------------------------------------------------- diff --git a/content/doc/0.9.12-incubating/guacamole-common-js/JSONReader.js.html b/content/doc/0.9.12-incubating/guacamole-common-js/JSONReader.js.html new file mode 100644 index 0000000..5cdbbc0 --- /dev/null +++ b/content/doc/0.9.12-incubating/guacamole-common-js/JSONReader.js.html @@ -0,0 +1,175 @@ + + + + + JSDoc: Source: JSONReader.js + + + + + + + + + + +
+ +

Source: JSONReader.js

+ + + + + + +
+
+ 
/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+var Guacamole = Guacamole || {};
+
+/**
+ * A reader which automatically handles the given input stream, assembling all
+ * received blobs into a JavaScript object by appending them to each other, in
+ * order, and decoding the result as JSON. Note that this object will overwrite
+ * any installed event handlers on the given Guacamole.InputStream.
+ * 
+ * @constructor
+ * @param {Guacamole.InputStream} stream
+ *     The stream that JSON will be read from.
+ */
+Guacamole.JSONReader = function guacamoleJSONReader(stream) {
+
+    /**
+     * Reference to this Guacamole.JSONReader.
+     *
+     * @private
+     * @type {Guacamole.JSONReader}
+     */
+    var guacReader = this;
+
+    /**
+     * Wrapped Guacamole.StringReader.
+     *
+     * @private
+     * @type {Guacamole.StringReader}
+     */
+    var stringReader = new Guacamole.StringReader(stream);
+
+    /**
+     * All JSON read thus far.
+     *
+     * @private
+     * @type {String}
+     */
+    var json = '';
+
+    /**
+     * Returns the current length of this Guacamole.JSONReader, in characters.
+     *
+     * @return {Number}
+     *     The current length of this Guacamole.JSONReader.
+     */
+    this.getLength = function getLength() {
+        return json.length;
+    };
+
+    /**
+     * Returns the contents of this Guacamole.JSONReader as a JavaScript
+     * object.
+     *
+     * @return {Object}
+     *     The contents of this Guacamole.JSONReader, as parsed from the JSON
+     *     contents of the input stream.
+     */
+    this.getJSON = function getJSON() {
+        return JSON.parse(json);
+    };
+
+    // Append all received text
+    stringReader.ontext = function ontext(text) {
+
+        // Append received text
+        json += text;
+
+        // Call handler, if present
+        if (guacReader.onprogress)
+            guacReader.onprogress(text.length);
+
+    };
+
+    // Simply call onend when end received
+    stringReader.onend = function onend() {
+        if (guacReader.onend)
+            guacReader.onend();
+    };
+
+    /**
+     * Fired once for every blob of data received.
+     * 
+     * @event
+     * @param {Number} length
+     *     The number of characters received.
+     */
+    this.onprogress = null;
+
+    /**
+     * Fired once this stream is finished and no further data will be written.
+     *
+     * @event
+     */
+    this.onend = null;
+
+};
+
+
+
+ + + + +
+ + + +
+ +
+ Documentation generated by JSDoc 3.4.0 on Sat Mar 18 2017 19:26:49 GMT-0700 (PDT) +
+ + + + + + +