WebRTCDataChannel

Inherits: PacketPeer < Reference < Object

继承人： WebRTCDataChannelGDNative

类别： 核心

简要说明

方法

无效

close ( )

int

get_id ( ) const

String

get_label ( ) const

int

get_max_packet_life_time ( ) const

int

get_max_retransmits ( ) const

String

get_protocol ( ) const

ChannelState

get_ready_state ( ) const

bool

is_negotiated ( ) const

bool

is_ordered ( ) const

Error

poll ( )

bool

was_string_packet ( ) const

枚举

枚举 WriteMode ：

  • WRITE_MODE_TEXT = 0 ---告诉频道以文本形式通过此频道发送数据。外部对等（非godot）将以字符串形式接收此消息。

  • WRITE_MODE_BINARY = 1 ---告诉通道以二进制形式通过此通道发送数据。外部对等（非godot）将接收此作为数组缓冲区或blob。

枚举 ChannelState ：

  • STATE_CONNECTING = 0 ---频道已创建，但仍在尝试连接。

  • STATE_OPEN = 1 ---该通道当前处于打开状态，数据可以在其上流动。

  • STATE_CLOSING = 2 ---正在关闭频道，不接受新的消息，但队列中已存在的消息将被刷新。

  • STATE_CLOSED = 3 ---通道关闭或连接失败。

属性描述

违约

1

设定器

设置写入模式（值）

吸气剂

获取写入模式（）

发送传出数据包时使用的传输模式。文本或二进制。

方法说明

  • void close ( )

关闭此数据通道，通知另一个对等方。

  • int get_id ( ) const

返回在创建过程中分配给此通道的ID（或在协商过程中自动分配）。

如果通道没有在带外协商，则只有在建立连接后ID才可用（将返回 65535 直到那时）。

返回创建期间分配给此频道的标签。

  • int get_max_packet_life_time ( ) const

返回 maxPacketLifeTime 创建期间分配给此频道的值。

将 65535 如果未指定。

  • int get_max_retransmits ( ) const

返回 maxRetransmits 创建期间分配给此频道的值。

将 65535 如果未指定。

  • String get_protocol ( ) const

返回创建期间分配给此通道的子协议。如果未指定，则为空字符串。

返回此通道的当前状态，请参见 ChannelState .

  • bool is_negotiated ( ) const

返回 true 如果此通道是用带外配置创建的。

  • bool is_ordered ( ) const

返回 true 如果创建此通道时启用了排序（默认）。

保留，但暂时不使用。

  • bool was_string_packet ( ) const

返回 true 如果最后一个接收到的数据包作为文本传输。见 write_mode .