WebRTCDataChannel

int write_mode = 1

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

void close()

Closes this data channel, notifying the other peer.

int get_buffered_amount() const

Returns the number of bytes currently queued to be sent over this channel.

int get_id() const

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).

String get_label() const

Returns the label assigned to this channel during creation.

int get_max_packet_life_time() const

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

int get_max_retransmits() const

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

String get_protocol() const

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

int get_ready_state() const

Returns the current state of this channel.

bool is_negotiated() const

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

bool is_ordered() const

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

int poll()

Reserved, but not used for now.

bool was_string_packet() const

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

WRITE_MODE_TEXT = 0

Enum: WriteMode

Tells the channel to send data over this channel as text. An external peer (non-Godot) would receive this as a string.

WRITE_MODE_BINARY = 1

Enum: WriteMode

Tells the channel to send data over this channel as binary. An external peer (non-Godot) would receive this as array buffer or blob.

STATE_CONNECTING = 0

Enum: ChannelState

The channel was created, but it's still trying to connect.

STATE_OPEN = 1

Enum: ChannelState

The channel is currently open, and data can flow over it.

STATE_CLOSING = 2

Enum: ChannelState

The channel is being closed, no new messages will be accepted, but those already in queue will be flushed.

STATE_CLOSED = 3

Enum: ChannelState

The channel was closed, or connection failed.