diff --git a/guacamole-common-js/src/main/webapp/modules/StringWriter.js b/guacamole-common-js/src/main/webapp/modules/StringWriter.js new file mode 100644 index 000000000..b246d8ad6 --- /dev/null +++ b/guacamole-common-js/src/main/webapp/modules/StringWriter.js @@ -0,0 +1,73 @@ +/* + * Copyright (C) 2013 Glyptodon LLC + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in + * all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN + * THE SOFTWARE. + */ + +var Guacamole = Guacamole || {}; + +/** + * A writer which automatically writes to the given output stream with text + * data. + * + * @constructor + * @param {Guacamole.OutputStream} stream The stream that data will be written + * to. + */ +Guacamole.StringWriter = function(stream) { + + /** + * Reference to this Guacamole.StringWriter. + * @private + */ + var guac_writer = this; + + // Simply call onack for acknowledgements + stream.onack = function(message, code) { + if (guac_writer.onack) + guac_writer.onack(message, code); + }; + + /** + * Sends the given text. + * + * @param {String} text The text to send. + */ + this.sendText = function(text) { + stream.sendBlob(window.btoa(text)); + }; + + /** + * Signals that no further text will be sent, effectively closing the + * stream. + */ + this.sendEnd = function() { + stream.sendEnd(); + }; + + /** + * Fired for received data, if acknowledged by the server. + * @event + * @param {String} message A human-readable status message related to the + * operation performed. + * @param {Number} code The error code associated with the operation. + */ + this.onack = null; + +}; \ No newline at end of file