new ChainedTunnel(…tunnelChain)
Guacamole Tunnel which cycles between all specified tunnels until
no tunnels are left. Another tunnel is used if an error occurs but
no instructions have been received. If an instruction has been
received, or no tunnels remain, the error is passed directly out
through the onerror handler (if defined).
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
tunnelChain |
* |
<repeatable> |
The tunnels to use, in order of priority. |
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:
| Name | Type | Description |
|---|---|---|
data |
String | The data to send to the tunnel when connecting. |
- Overrides:
- Source:
disconnect()
Disconnect from the tunnel.
- Inherited From:
- 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:
| Name | Type | Attributes | Description |
|---|---|---|---|
elements |
* |
<repeatable> |
The elements of the message to send to the service on the other side of the tunnel. |
- Inherited From:
- Source:
Events
onerror
Fired whenever an error is encountered by the tunnel.
Parameters:
| Name | Type | Description |
|---|---|---|
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:
| Name | Type | Description |
|---|---|---|
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:
| Name | Type | Description |
|---|---|---|
state |
Number | The new state of the client. |
- Inherited From:
- Source: