new 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.
- Source:
- See:
Members
(static, constant, non-null) 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 and send
connection stability test pings/responses.
Type:
- string
- Source:
(static, non-null) State :Object.<string, number>
All possible tunnel states.
Type:
- Object.<string, number>
- Source:
(non-null) 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
- Source:
(non-null) state :number
The current state of this tunnel.
Type:
- number
- Source:
(non-null) unstableThreshold :number
The amount of time to wait for data to be received before considering
the connection to be unstable, in milliseconds. If data is not received
within this amount of time, the tunnel status is updated to warn that
the connection appears unresponsive and may close. The default value is
1500.
Type:
- number
- Source:
uuid :string
The UUID uniquely identifying this tunnel. If not yet known, this will
be null.
Type:
- string
- Source:
Methods
connect(dataopt)
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 | Attributes | Description |
|---|---|---|---|
data |
string |
<optional> |
The data to send to the tunnel when connecting. |
- Source:
disconnect()
Disconnect from the tunnel.
- Source:
isConnected() → (non-null) {boolean}
Returns whether this tunnel is currently connected.
- Source:
Returns:
true if this tunnel is currently connected, false otherwise.
- Type
- boolean
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. |
- 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. |
- Source:
oninstruction
Fired once for every complete Guacamole instruction received, in order.
Parameters:
| Name | Type | Description |
|---|---|---|
opcode |
string | The Guacamole instruction opcode. |
parameters |
Array.<string> | The parameters provided for the instruction, if any. |
- Source:
onstatechange
Fired whenever the state of the tunnel changes.
Parameters:
| Name | Type | Description |
|---|---|---|
state |
number | The new state of the client. |
- Source:
onuuid
Fired when the UUID that uniquely identifies this tunnel is known.
Parameters:
| Name | Type | Description |
|---|---|---|
The |
string | UUID uniquely identifying this tunnel. |
- Source: