WebSocketClient

A WebSocket client implementation.

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.poll it at regular intervals (e.g. inside Node._process). You will receive appropriate signals when connecting, disconnecting, or when new data is available.

@GodotBaseClass

struct WebSocketClient {

package

enum string _GODOT_internal_name;

union __anonymous;

alias BaseClasses = AliasSeq!(typeof(_GODOT_base), typeof(_GODOT_base).BaseClasses);

package @nogc nothrow __gshared

bool _classBindingInitialized;

struct GDNativeClassBinding;

bool opEquals(WebSocketClient other);

typeof(null) opAssign(typeof(null) n);

bool opEquals(typeof(null) n);

size_t toHash();

mixin baseCasts ;

static WebSocketClient _new();

GodotError connectToUrl(String url, PoolStringArray protocols, bool gd_mp_api, PoolStringArray custom_headers);

void disconnectFromHost(long code, String reason);

String getConnectedHost();

long getConnectedPort();

Ref!X509Certificate getTrustedSslCertificate();

bool isVerifySslEnabled();

void setTrustedSslCertificate(X509Certificate arg0);

void setVerifySslEnabled(bool enabled);

X509Certificate trustedSslCertificate [@property getter];

X509Certificate trustedSslCertificate [@property setter];

bool verifySsl [@property getter];

bool verifySsl [@property setter];

}

Members

Aliases

BaseClasses alias BaseClasses = AliasSeq!(typeof(_GODOT_base), typeof(_GODOT_base).BaseClasses): Undocumented in source.

Functions

connectToUrl GodotError connectToUrl(String url, PoolStringArray protocols, bool gd_mp_api, PoolStringArray custom_headers): 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).put_packet(data)). You can optionally pass a list of custom_headers to be added to the handshake HTTP request. Note: To avoid mixed content warnings or errors in HTML5, you may have to use a url that starts with wss:// (secure) instead of ws://. When doing so, make sure to use the fully qualified domain name that matches the one defined in the server's SSL certificate. Do not connect directly via the IP address for wss:// connections, as it won't match with the SSL certificate. Note: Specifying custom_headers is not supported in HTML5 exports due to browsers restrictions.
disconnectFromHost void disconnectFromHost(long code, String reason): Disconnects this client from the connected host. See WebSocketPeer.close for more information.
getConnectedHost String getConnectedHost(): Return the IP address of the currently connected host.
getConnectedPort long getConnectedPort(): Return the IP port of the currently connected host.
getTrustedSslCertificate Ref!X509Certificate getTrustedSslCertificate()
isVerifySslEnabled bool isVerifySslEnabled()
opAssign typeof(null) opAssign(typeof(null) n)
opEquals bool opEquals(WebSocketClient other)
opEquals bool opEquals(typeof(null) n)
setTrustedSslCertificate void setTrustedSslCertificate(X509Certificate arg0)
setVerifySslEnabled void setVerifySslEnabled(bool enabled)
toHash size_t toHash()

Mixins

__anonymous mixin baseCasts: Undocumented in source.

Properties

trustedSslCertificate X509Certificate trustedSslCertificate [@property getter]
X509Certificate trustedSslCertificate [@property setter]: 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 bool verifySsl [@property getter]
bool verifySsl [@property setter]: 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.

Static functions

_new WebSocketClient _new(): Construct a new instance of WebSocketClient. Note: use memnew!WebSocketClient instead.

Static variables

_classBindingInitialized bool _classBindingInitialized;: Undocumented in source.

Structs

GDNativeClassBinding struct GDNativeClassBinding: Undocumented in source.

Unions

__anonymous union __anonymous: Undocumented in source.

Variables

_GODOT_internal_name enum string _GODOT_internal_name;: Undocumented in source.

Mixed In Members

From `mixin baseCasts`

as inout(To) as(): Undocumented in source. Be warned that the author may not have intended to support it.
as inout(To) as(): Undocumented in source. Be warned that the author may not have intended to support it.
as inout(ToRef) as(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast template opCast(To): Undocumented in source.
opCast template opCast(To): Undocumented in source.
opCast template opCast(ToRef): Undocumented in source.
opCast void* opCast(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast godot_object opCast(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast bool opCast(): Undocumented in source. Be warned that the author may not have intended to support it.

WebSocketClient

Members

Aliases

Functions

Mixins

Properties

Static functions

Static variables

Structs

Unions

Variables

Mixed In Members

From `mixin baseCasts`

Meta

Source

WebSocketClient

From mixin baseCasts

From `mixin baseCasts`