| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| <meta charset="utf-8"> |
| <title>JSDoc: Source: Object.js</title> |
| |
| <script src="scripts/prettify/prettify.js"> </script> |
| <script src="scripts/prettify/lang-css.js"> </script> |
| <!--[if lt IE 9]> |
| <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script> |
| <![endif]--> |
| <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css"> |
| <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css"> |
| </head> |
| |
| <body> |
| |
| <div id="main"> |
| |
| <h1 class="page-title">Source: Object.js</h1> |
| |
| |
| |
| |
| |
| |
| <section> |
| <article> |
| <pre class="prettyprint source linenums"><code>/* |
| * 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 object used by the Guacamole client to house arbitrarily-many named |
| * input and output streams. |
| * |
| * @constructor |
| * @param {Guacamole.Client} client |
| * The client owning this object. |
| * |
| * @param {Number} index |
| * The index of this object. |
| */ |
| Guacamole.Object = function guacamoleObject(client, index) { |
| |
| /** |
| * Reference to this Guacamole.Object. |
| * |
| * @private |
| * @type {Guacamole.Object} |
| */ |
| var guacObject = this; |
| |
| /** |
| * Map of stream name to corresponding queue of callbacks. The queue of |
| * callbacks is guaranteed to be in order of request. |
| * |
| * @private |
| * @type {Object.<String, Function[]>} |
| */ |
| var bodyCallbacks = {}; |
| |
| /** |
| * Removes and returns the callback at the head of the callback queue for |
| * the stream having the given name. If no such callbacks exist, null is |
| * returned. |
| * |
| * @private |
| * @param {String} name |
| * The name of the stream to retrieve a callback for. |
| * |
| * @returns {Function} |
| * The next callback associated with the stream having the given name, |
| * or null if no such callback exists. |
| */ |
| var dequeueBodyCallback = function dequeueBodyCallback(name) { |
| |
| // If no callbacks defined, simply return null |
| var callbacks = bodyCallbacks[name]; |
| if (!callbacks) |
| return null; |
| |
| // Otherwise, pull off first callback, deleting the queue if empty |
| var callback = callbacks.shift(); |
| if (callbacks.length === 0) |
| delete bodyCallbacks[name]; |
| |
| // Return found callback |
| return callback; |
| |
| }; |
| |
| /** |
| * Adds the given callback to the tail of the callback queue for the stream |
| * having the given name. |
| * |
| * @private |
| * @param {String} name |
| * The name of the stream to associate with the given callback. |
| * |
| * @param {Function} callback |
| * The callback to add to the queue of the stream with the given name. |
| */ |
| var enqueueBodyCallback = function enqueueBodyCallback(name, callback) { |
| |
| // Get callback queue by name, creating first if necessary |
| var callbacks = bodyCallbacks[name]; |
| if (!callbacks) { |
| callbacks = []; |
| bodyCallbacks[name] = callbacks; |
| } |
| |
| // Add callback to end of queue |
| callbacks.push(callback); |
| |
| }; |
| |
| /** |
| * The index of this object. |
| * |
| * @type {Number} |
| */ |
| this.index = index; |
| |
| /** |
| * Called when this object receives the body of a requested input stream. |
| * By default, all objects will invoke the callbacks provided to their |
| * requestInputStream() functions based on the name of the stream |
| * requested. This behavior can be overridden by specifying a different |
| * handler here. |
| * |
| * @event |
| * @param {Guacamole.InputStream} inputStream |
| * The input stream of the received body. |
| * |
| * @param {String} mimetype |
| * The mimetype of the data being received. |
| * |
| * @param {String} name |
| * The name of the stream whose body has been received. |
| */ |
| this.onbody = function defaultBodyHandler(inputStream, mimetype, name) { |
| |
| // Call queued callback for the received body, if any |
| var callback = dequeueBodyCallback(name); |
| if (callback) |
| callback(inputStream, mimetype); |
| |
| }; |
| |
| /** |
| * Called when this object is being undefined. Once undefined, no further |
| * communication involving this object may occur. |
| * |
| * @event |
| */ |
| this.onundefine = null; |
| |
| /** |
| * Requests read access to the input stream having the given name. If |
| * successful, a new input stream will be created. |
| * |
| * @param {String} name |
| * The name of the input stream to request. |
| * |
| * @param {Function} [bodyCallback] |
| * The callback to invoke when the body of the requested input stream |
| * is received. This callback will be provided a Guacamole.InputStream |
| * and its mimetype as its two only arguments. If the onbody handler of |
| * this object is overridden, this callback will not be invoked. |
| */ |
| this.requestInputStream = function requestInputStream(name, bodyCallback) { |
| |
| // Queue body callback if provided |
| if (bodyCallback) |
| enqueueBodyCallback(name, bodyCallback); |
| |
| // Send request for input stream |
| client.requestObjectInputStream(guacObject.index, name); |
| |
| }; |
| |
| /** |
| * Creates a new output stream associated with this object and having the |
| * given mimetype and name. The legality of a mimetype and name is dictated |
| * by the object itself. |
| * |
| * @param {String} mimetype |
| * The mimetype of the data which will be sent to the output stream. |
| * |
| * @param {String} name |
| * The defined name of an output stream within this object. |
| * |
| * @returns {Guacamole.OutputStream} |
| * An output stream which will write blobs to the named output stream |
| * of this object. |
| */ |
| this.createOutputStream = function createOutputStream(mimetype, name) { |
| return client.createObjectOutputStream(guacObject.index, mimetype, name); |
| }; |
| |
| }; |
| |
| /** |
| * The reserved name denoting the root stream of any object. The contents of |
| * the root stream MUST be a JSON map of stream name to mimetype. |
| * |
| * @constant |
| * @type {String} |
| */ |
| Guacamole.Object.ROOT_STREAM = '/'; |
| |
| /** |
| * The mimetype of a stream containing JSON which maps available stream names |
| * to their corresponding mimetype. The root stream of a Guacamole.Object MUST |
| * have this mimetype. |
| * |
| * @constant |
| * @type {String} |
| */ |
| Guacamole.Object.STREAM_INDEX_MIMETYPE = 'application/vnd.glyptodon.guacamole.stream-index+json'; |
| </code></pre> |
| </article> |
| </section> |
| |
| |
| |
| |
| </div> |
| |
| <nav> |
| <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Guacamole.ArrayBufferReader.html">ArrayBufferReader</a></li><li><a href="Guacamole.ArrayBufferWriter.html">ArrayBufferWriter</a></li><li><a href="Guacamole.AudioPlayer.html">AudioPlayer</a></li><li><a href="Guacamole.AudioRecorder.html">AudioRecorder</a></li><li><a href="Guacamole.BlobReader.html">BlobReader</a></li><li><a href="Guacamole.BlobWriter.html">BlobWriter</a></li><li><a href="Guacamole.ChainedTunnel.html">ChainedTunnel</a></li><li><a href="Guacamole.Client.html">Client</a></li><li><a href="Guacamole.DataURIReader.html">DataURIReader</a></li><li><a href="Guacamole.Display.html">Display</a></li><li><a href="Guacamole.Display.VisibleLayer.html">VisibleLayer</a></li><li><a href="Guacamole.HTTPTunnel.html">HTTPTunnel</a></li><li><a href="Guacamole.InputSink.html">InputSink</a></li><li><a href="Guacamole.InputStream.html">InputStream</a></li><li><a href="Guacamole.IntegerPool.html">IntegerPool</a></li><li><a href="Guacamole.JSONReader.html">JSONReader</a></li><li><a href="Guacamole.Keyboard.html">Keyboard</a></li><li><a href="Guacamole.Keyboard.ModifierState.html">ModifierState</a></li><li><a href="Guacamole.Layer.html">Layer</a></li><li><a href="Guacamole.Layer.Pixel.html">Pixel</a></li><li><a href="Guacamole.Mouse.html">Mouse</a></li><li><a href="Guacamole.Mouse.State.html">State</a></li><li><a href="Guacamole.Mouse.Touchpad.html">Touchpad</a></li><li><a href="Guacamole.Mouse.Touchscreen.html">Touchscreen</a></li><li><a href="Guacamole.Object.html">Object</a></li><li><a href="Guacamole.OnScreenKeyboard.html">OnScreenKeyboard</a></li><li><a href="Guacamole.OnScreenKeyboard.Key.html">Key</a></li><li><a href="Guacamole.OnScreenKeyboard.Layout.html">Layout</a></li><li><a href="Guacamole.OutputStream.html">OutputStream</a></li><li><a href="Guacamole.Parser.html">Parser</a></li><li><a href="Guacamole.RawAudioFormat.html">RawAudioFormat</a></li><li><a href="Guacamole.RawAudioPlayer.html">RawAudioPlayer</a></li><li><a href="Guacamole.RawAudioRecorder.html">RawAudioRecorder</a></li><li><a href="Guacamole.SessionRecording.html">SessionRecording</a></li><li><a href="Guacamole.StaticHTTPTunnel.html">StaticHTTPTunnel</a></li><li><a href="Guacamole.Status.html">Status</a></li><li><a href="Guacamole.StringReader.html">StringReader</a></li><li><a href="Guacamole.StringWriter.html">StringWriter</a></li><li><a href="Guacamole.Tunnel.html">Tunnel</a></li><li><a href="Guacamole.VideoPlayer.html">VideoPlayer</a></li><li><a href="Guacamole.WebSocketTunnel.html">WebSocketTunnel</a></li></ul><h3>Events</h3><ul><li><a href="Guacamole.ArrayBufferReader.html#event:ondata">ondata</a></li><li><a href="Guacamole.ArrayBufferReader.html#event:onend">onend</a></li><li><a href="Guacamole.ArrayBufferWriter.html#event:onack">onack</a></li><li><a href="Guacamole.AudioRecorder.html#event:onclose">onclose</a></li><li><a href="Guacamole.AudioRecorder.html#event:onerror">onerror</a></li><li><a href="Guacamole.BlobReader.html#event:onend">onend</a></li><li><a href="Guacamole.BlobReader.html#event:onprogress">onprogress</a></li><li><a href="Guacamole.BlobWriter.html#event:onack">onack</a></li><li><a href="Guacamole.BlobWriter.html#event:oncomplete">oncomplete</a></li><li><a href="Guacamole.BlobWriter.html#event:onerror">onerror</a></li><li><a href="Guacamole.BlobWriter.html#event:onprogress">onprogress</a></li><li><a href="Guacamole.ChainedTunnel.html#event:onerror">onerror</a></li><li><a href="Guacamole.ChainedTunnel.html#event:oninstruction">oninstruction</a></li><li><a href="Guacamole.ChainedTunnel.html#event:onstatechange">onstatechange</a></li><li><a href="Guacamole.Client.html#event:onargv">onargv</a></li><li><a href="Guacamole.Client.html#event:onaudio">onaudio</a></li><li><a href="Guacamole.Client.html#event:onclipboard">onclipboard</a></li><li><a href="Guacamole.Client.html#event:onerror">onerror</a></li><li><a href="Guacamole.Client.html#event:onfile">onfile</a></li><li><a href="Guacamole.Client.html#event:onfilesystem">onfilesystem</a></li><li><a href="Guacamole.Client.html#event:onname">onname</a></li><li><a href="Guacamole.Client.html#event:onpipe">onpipe</a></li><li><a href="Guacamole.Client.html#event:onstatechange">onstatechange</a></li><li><a href="Guacamole.Client.html#event:onsync">onsync</a></li><li><a href="Guacamole.Client.html#event:onvideo">onvideo</a></li><li><a href="Guacamole.DataURIReader.html#event:onend">onend</a></li><li><a href="Guacamole.Display.html#event:oncursor">oncursor</a></li><li><a href="Guacamole.Display.html#event:onresize">onresize</a></li><li><a href="Guacamole.HTTPTunnel.html#event:onerror">onerror</a></li><li><a href="Guacamole.HTTPTunnel.html#event:oninstruction">oninstruction</a></li><li><a href="Guacamole.HTTPTunnel.html#event:onstatechange">onstatechange</a></li><li><a href="Guacamole.InputStream.html#event:onblob">onblob</a></li><li><a href="Guacamole.InputStream.html#event:onend">onend</a></li><li><a href="Guacamole.JSONReader.html#event:onend">onend</a></li><li><a href="Guacamole.JSONReader.html#event:onprogress">onprogress</a></li><li><a href="Guacamole.Keyboard.html#event:onkeydown">onkeydown</a></li><li><a href="Guacamole.Keyboard.html#event:onkeyup">onkeyup</a></li><li><a href="Guacamole.Mouse.Touchpad.html#event:onmousedown">onmousedown</a></li><li><a href="Guacamole.Mouse.Touchpad.html#event:onmousemove">onmousemove</a></li><li><a href="Guacamole.Mouse.Touchpad.html#event:onmouseup">onmouseup</a></li><li><a href="Guacamole.Mouse.Touchscreen.html#event:onmousedown">onmousedown</a></li><li><a href="Guacamole.Mouse.Touchscreen.html#event:onmousemove">onmousemove</a></li><li><a href="Guacamole.Mouse.Touchscreen.html#event:onmouseup">onmouseup</a></li><li><a href="Guacamole.Mouse.html#event:onmousedown">onmousedown</a></li><li><a href="Guacamole.Mouse.html#event:onmousemove">onmousemove</a></li><li><a href="Guacamole.Mouse.html#event:onmouseout">onmouseout</a></li><li><a href="Guacamole.Mouse.html#event:onmouseup">onmouseup</a></li><li><a href="Guacamole.Object.html#event:onbody">onbody</a></li><li><a href="Guacamole.Object.html#event:onundefine">onundefine</a></li><li><a href="Guacamole.OnScreenKeyboard.html#event:onkeydown">onkeydown</a></li><li><a href="Guacamole.OnScreenKeyboard.html#event:onkeyup">onkeyup</a></li><li><a href="Guacamole.OutputStream.html#event:onack">onack</a></li><li><a href="Guacamole.Parser.html#event:oninstruction">oninstruction</a></li><li><a href="Guacamole.RawAudioRecorder.html#event:onclose">onclose</a></li><li><a href="Guacamole.RawAudioRecorder.html#event:onerror">onerror</a></li><li><a href="Guacamole.SessionRecording._PlaybackTunnel.html#event:onerror">onerror</a></li><li><a href="Guacamole.SessionRecording._PlaybackTunnel.html#event:oninstruction">oninstruction</a></li><li><a href="Guacamole.SessionRecording._PlaybackTunnel.html#event:onstatechange">onstatechange</a></li><li><a href="Guacamole.SessionRecording.html#event:onpause">onpause</a></li><li><a href="Guacamole.SessionRecording.html#event:onplay">onplay</a></li><li><a href="Guacamole.SessionRecording.html#event:onprogress">onprogress</a></li><li><a href="Guacamole.SessionRecording.html#event:onseek">onseek</a></li><li><a href="Guacamole.StaticHTTPTunnel.html#event:onerror">onerror</a></li><li><a href="Guacamole.StaticHTTPTunnel.html#event:oninstruction">oninstruction</a></li><li><a href="Guacamole.StaticHTTPTunnel.html#event:onstatechange">onstatechange</a></li><li><a href="Guacamole.StringReader.html#event:onend">onend</a></li><li><a href="Guacamole.StringReader.html#event:ontext">ontext</a></li><li><a href="Guacamole.StringWriter.html#event:onack">onack</a></li><li><a href="Guacamole.Tunnel.html#event:onerror">onerror</a></li><li><a href="Guacamole.Tunnel.html#event:oninstruction">oninstruction</a></li><li><a href="Guacamole.Tunnel.html#event:onstatechange">onstatechange</a></li><li><a href="Guacamole.WebSocketTunnel.html#event:onerror">onerror</a></li><li><a href="Guacamole.WebSocketTunnel.html#event:oninstruction">oninstruction</a></li><li><a href="Guacamole.WebSocketTunnel.html#event:onstatechange">onstatechange</a></li></ul><h3>Namespaces</h3><ul><li><a href="Guacamole.html">Guacamole</a></li><li><a href="Guacamole.AudioContextFactory.html">AudioContextFactory</a></li></ul> |
| </nav> |
| |
| <br class="clear"> |
| |
| <footer> |
| Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sun Jan 26 2020 10:17:42 GMT-0800 (PST) |
| </footer> |
| |
| <script> prettyPrint(); </script> |
| <script src="scripts/linenumber.js"> </script> |
| </body> |
| </html> |
