Learn how to evaluate and integrate the VNC SDK
CloudConnector¶
-
class
vncsdk.
CloudConnector
¶ Connector used to join VNC Cloud and establish an outgoing connection.
Constructor Summary¶
Modifier and Type | Method and Description |
---|---|
__init__(local_cloud_address, local_cloud_password) Creates a connector, which is used used to create connections to Cloud addresses. |
Method Summary¶
Modifier and Type | Method and Description |
---|---|
Begins an outgoing connection to the given Cloud address. |
|
Destroys the Cloud connector. |
|
Set the bandwidth limit applied to relayed Cloud connections. |
|
Sets whether new connections created by the connector wait for the peer to start listening. |
Constructor¶
-
vncsdk.CloudConnector.
__init__
(local_cloud_address, local_cloud_password)¶ Creates a connector, which is used used to create connections to Cloud addresses.
For more information, see
vnc_CloudConnector_create()
.Parameters: - local_cloud_address (str) –
- local_cloud_password (str) –
Methods¶
-
CloudConnector.
connect
(peer_cloud_address, connection_handler)¶ Begins an outgoing connection to the given Cloud address.
For more information, see
vnc_CloudConnector_connect()
.Parameters: - peer_cloud_address (str) –
- connection_handler (
vncsdk.ConnectionHandler
) –
-
CloudConnector.
destroy
()¶ Destroys the Cloud connector.
For more information, see
vnc_CloudConnector_destroy()
.
-
CloudConnector.
set_relay_bandwidth_limit
(relay_bandwidth_limit)¶ Set the bandwidth limit applied to relayed Cloud connections.
For more information, see
vnc_CloudConnector_setRelayBandwidthLimit()
.Parameters: relay_bandwidth_limit (int) –
-
CloudConnector.
set_wait_for_peer
(wait_for_peer)¶ Sets whether new connections created by the connector wait for the peer to start listening.
For more information, see
vnc_CloudConnector_setWaitForPeer()
.Parameters: wait_for_peer (bool) –