WebRTCDataChannel

Members

Aliases

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

Enums

ChannelState
enum ChannelState
Constants
enum Constants
WriteMode
enum WriteMode

Functions

close
void close()

Closes this data channel, notifying the other peer.

getId
long getId()

Returns the id assigned to this channel during creation (or auto-assigned during negotiation). If the channel is not negotiated out-of-band the id will only be available after the connection is established (will return 65535 until then).

getLabel
String getLabel()

Returns the label assigned to this channel during creation.

getMaxPacketLifeTime
long getMaxPacketLifeTime()

Returns the maxPacketLifeTime value assigned to this channel during creation. Will be 65535 if not specified.

getMaxRetransmits
long getMaxRetransmits()

Returns the maxRetransmits value assigned to this channel during creation. Will be 65535 if not specified.

getProtocol
String getProtocol()

Returns the sub-protocol assigned to this channel during creation. An empty string if not specified.

getReadyState
WebRTCDataChannel.ChannelState getReadyState()

Returns the current state of this channel, see channelstate.

getWriteMode
WebRTCDataChannel.WriteMode getWriteMode()
isNegotiated
bool isNegotiated()

Returns true if this channel was created with out-of-band configuration.

isOrdered
bool isOrdered()

Returns true if this channel was created with ordering enabled (default).

opAssign
typeof(null) opAssign(typeof(null) n)
opEquals
bool opEquals(WebRTCDataChannel other)
opEquals
bool opEquals(typeof(null) n)
poll
GodotError poll()

Reserved, but not used for now.

setWriteMode
void setWriteMode(long write_mode)
toHash
size_t toHash()
wasStringPacket
bool wasStringPacket()

Returns true if the last received packet was transferred as text. See writeMode.

Mixins

__anonymous
mixin baseCasts
Undocumented in source.

Properties

writeMode
WebRTCDataChannel.WriteMode writeMode [@property getter]
long writeMode [@property setter]

The transfer mode to use when sending outgoing packet. Either text or binary.

Static functions

_new
WebRTCDataChannel _new()

Construct a new instance of WebRTCDataChannel. Note: use memnew!WebRTCDataChannel 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