Class WebRTCDataChannel

Inheritance

PacketPeer

RefCounted

Object

WebRTCDataChannel

Derived

WebRTCDataChannelExtension

Properties

write_mode

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

var write_mode : int = 1

Property Value

int

Remarks

• void set_write_mode(int value)
• int get_write_mode

Methods

close

Closes this data channel, notifying the other peer.

void close

get_buffered_amount

Qualifiers: const

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

int get_buffered_amount

get_id

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

int get_id

get_label

Qualifiers: const

Returns the label assigned to this channel during creation.

String get_label

get_max_packet_life_time

Qualifiers: const

Returns the maxPacketLifeTime value assigned to this channel during creation.

Will be 65535 if not specified.

int get_max_packet_life_time

get_max_retransmits

Qualifiers: const

Returns the maxRetransmits value assigned to this channel during creation.

Will be 65535 if not specified.

int get_max_retransmits

get_protocol

Qualifiers: const

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

String get_protocol

get_ready_state

Qualifiers: const

Returns the current state of this channel, see ChannelState.

int get_ready_state

is_negotiated

Qualifiers: const

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

bool is_negotiated

is_ordered

Qualifiers: const

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

bool is_ordered

poll

Reserved, but not used for now.

int poll

was_string_packet

Qualifiers: const

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

bool was_string_packet