StreamPeerSSL

SSL stream peer.

This object can be used to connect to an SSL server or accept a single SSL client connection.

@GodotBaseClass

struct StreamPeerSSL {

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(StreamPeerSSL other);

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

bool opEquals(typeof(null) n);

size_t toHash();

mixin baseCasts ;

static StreamPeerSSL _new();

enum Constants;

GodotError acceptStream(StreamPeer stream, CryptoKey private_key, X509Certificate certificate, X509Certificate chain);

GodotError connectToStream(StreamPeer stream, bool validate_certs, String for_hostname, X509Certificate valid_certificate);

void disconnectFromStream();

StreamPeerSSL.Status getStatus();

bool isBlockingHandshakeEnabled();

void setBlockingHandshakeEnabled(bool enabled);

bool blockingHandshake [@property getter];

bool blockingHandshake [@property setter];

}

Members

Aliases

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

Enums

Constants enum Constants
Status enum Status

Functions

acceptStream GodotError acceptStream(StreamPeer stream, CryptoKey private_key, X509Certificate certificate, X509Certificate chain): Accepts a peer connection as a server using the given private_key and providing the given certificate to the client. You can pass the optional chain parameter to provide additional CA chain information along with the certificate.
connectToStream GodotError connectToStream(StreamPeer stream, bool validate_certs, String for_hostname, X509Certificate valid_certificate): Connects to a peer using an underlying StreamPeer stream. If validate_certs is true, StreamPeerSSL will validate that the certificate presented by the peer matches the for_hostname. Note: Specifying a custom valid_certificate is not supported in HTML5 exports due to browsers restrictions.
disconnectFromStream void disconnectFromStream(): Disconnects from host.
getStatus StreamPeerSSL.Status getStatus(): Returns the status of the connection. See status for values.
isBlockingHandshakeEnabled bool isBlockingHandshakeEnabled()
opAssign typeof(null) opAssign(typeof(null) n)
opEquals bool opEquals(StreamPeerSSL other)
opEquals bool opEquals(typeof(null) n)
poll void poll(): Poll the connection to check for incoming bytes. Call this right before StreamPeer.getAvailableBytes for it to work properly.
setBlockingHandshakeEnabled void setBlockingHandshakeEnabled(bool enabled)
toHash size_t toHash()

Mixins

__anonymous mixin baseCasts: Undocumented in source.

Properties

blockingHandshake bool blockingHandshake [@property getter]
bool blockingHandshake [@property setter]

Static functions

_new StreamPeerSSL _new(): Construct a new instance of StreamPeerSSL. Note: use memnew!StreamPeerSSL 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.

Meta

Source

See Implementation

godot streampeerssl structs

StreamPeerSSL