Class Guacamole.Tunnel
Defined in: tunnel.js.
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
Core object providing abstract communication for Guacamole.
|
| Method Attributes | Method Name and Description |
|---|---|
|
connect(data)
Connect to the tunnel with the given optional data.
|
|
|
Disconnect from the tunnel.
|
|
|
sendMessage(elements)
Send the given message through the tunnel to the service on the other
side.
|
| Event Attributes | Event Name and Description |
|---|---|
|
onerror(message)
Fired whenever an error is encountered by the tunnel.
|
|
|
oninstruction(opcode, parameters)
Fired once for every complete Guacamole instruction received, in order.
|
Class Detail
Guacamole.Tunnel()
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.
- See:
- Guacamole.HTTPTunnel
Method Detail
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:
- {String} data
- The data to send to the tunnel when connecting.
disconnect()
Disconnect from the tunnel.
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:
- {...} elements
- The elements of the message to send to the service on the other side of the tunnel.
Event Detail
onerror(message)
Fired whenever an error is encountered by the tunnel.
- Parameters:
- {String} message
- A human-readable description of the error that occurred.
oninstruction(opcode, parameters)
Fired once for every complete Guacamole instruction received, in order.
- Parameters:
- {String} opcode
- The Guacamole instruction opcode.
- {Array} parameters
- The parameters provided for the instruction, if any.