Struct WebSocketClient
A WebSocket client implementation.
struct WebSocketClient
;
This class implements a WebSocket client compatible with any RFC 6455-compliant WebSocket server.
This client can be optionally used as a network peer for the MultiplayerAPI.
After starting the client (connectToUrl), you will need to NetworkedMultiplayerPeer it at regular intervals (e.g. inside Node).
You will receive appropriate signals when connecting, disconnecting, or when new data is available.
Properties
| Name | Type | Description |
|---|---|---|
trustedSslCertificate[get, set]
|
X509Certificate | If specified, this X509Certificate will be the only one accepted when connecting to an SSL host. Any other certificate provided by the server will be regarded as invalid.
Note: Specifying a custom trusted_ssl_certificate is not supported in HTML5 exports due to browsers restrictions.
|
verifySsl[get, set]
|
bool | If true, SSL certificate verification is enabled.
Note: You must specify the certificates to be used in the Project Settings for it to work when exported.
|
Methods
| Name | Description |
|---|---|
connectToUrl
|
Connects to the given URL requesting one of the given protocols as sub-protocol. If the list empty (default), no sub-protocol will be requested.
If true is passed as gd_mp_api, the client will behave like a network peer for the MultiplayerAPI, connections to non-Godot servers will not work, and dataReceived will not be emitted.
If false is passed instead (default), you must call PacketPeer functions (put_packet, get_packet, etc.) on the WebSocketPeer returned via get_peer(1) and not on this object directly (e.g. get_peer(1)).
You can optionally pass a list of custom_headers to be added to the handshake HTTP request.
Note: Specifying custom_headers is not supported in HTML5 exports due to browsers restrictions.
|
disconnectFromHost
|
Disconnects this client from the connected host. See WebSocketPeer for more information.
|
getConnectedHost
|
Return the IP address of the currently connected host. |
getConnectedPort
|
Return the IP port of the currently connected host. |
getTrustedSslCertificate
|
|
isVerifySslEnabled
|
|
setTrustedSslCertificate
|
|
setVerifySslEnabled
|