Core object providing abstract communication for Guacamole. This object is a null implementation whose functions do nothing. Guacamole applications should use Guacamole.HTTPTunnel instead, or implement their own tunnel based on this one.
(static, constant) INTERNAL_DATA_OPCODE :String
The Guacamole protocol instruction opcode reserved for arbitrary internal use by tunnel implementations. The value of this opcode is guaranteed to be the empty string (""). Tunnel implementations may use this opcode for any purpose. It is currently used by the HTTP tunnel to mark the end of the HTTP response, and by the WebSocket tunnel to transmit the tunnel UUID.
All possible tunnel states.
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.
The current state of this tunnel.
The UUID uniquely identifying this tunnel. If not yet known, this will be null.
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.
||String||The data to send to the tunnel when connecting.|
Disconnect from the tunnel.
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.
||The elements of the message to send to the service on the other side of the tunnel.|
Fired whenever an error is encountered by the tunnel.
||Guacamole.Status||A status object which describes the error.|
Fired once for every complete Guacamole instruction received, in order.
||String||The Guacamole instruction opcode.|
||Array||The parameters provided for the instruction, if any.|
Fired whenever the state of the tunnel changes.
||Number||The new state of the client.|