WebRTCDataChannel

Наследует: PacketPeer < RefCounted < Object

Наследуется от: WebRTCDataChannelExtension

There is currently no description for this class. Please help us by contributing one!

Свойства

WriteMode

write_mode

1

Методы

void

close()

int

get_buffered_amount() const

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

Перечисления

enum WriteMode: 🔗

WriteMode WRITE_MODE_TEXT = 0

Сообщает каналу отправлять данные по этому каналу как текст. Внешний пир (не Godot) получит это как строку.

WriteMode WRITE_MODE_BINARY = 1

Сообщает каналу отправлять данные по этому каналу в двоичном виде. Внешний пир (не Godot) получит это как массив буфера или blob.

enum ChannelState: 🔗

ChannelState STATE_CONNECTING = 0

Канал создан, но он все еще пытается подключиться.

ChannelState STATE_OPEN = 1

В настоящее время канал открыт, и по нему могут передаваться данные.

ChannelState STATE_CLOSING = 2

Канал закрывается, новые сообщения приниматься не будут, но те, которые уже находятся в очереди, будут очищены.

ChannelState STATE_CLOSED = 3

Канал был закрыт или соединение не удалось.

Описания свойств

WriteMode write_mode = 1 🔗

Режим передачи, используемый при отправке исходящего пакета. Текстовый или двоичный.

Описания метода

void close() 🔗

Закрывает этот канал данных, уведомляя другого однорангового узла.

int get_buffered_amount() const 🔗

Возвращает количество байтов, находящихся в очереди на отправку по этому каналу.

int get_id() const 🔗

Возвращает ID, назначенный этому каналу во время создания (или автоматически назначенный во время согласования).

Если канал не согласован вне диапазона, ID будет доступен только после установления соединения (до этого момента будет возвращать 65535).

String get_label() const 🔗

Возвращает метку (label), назначенную данному каналу при создании.

int get_max_packet_life_time() const 🔗

Возвращает значение maxPacketLifeTime, назначенное этому каналу при создании.

Будет 65535, если не указано.

int get_max_retransmits() const 🔗

Возвращает значение maxRetransmits, назначенное этому каналу при создании.

Будет 65535, если не указано.

String get_protocol() const 🔗

Возвращает подпротокол, назначенный этому каналу во время создания. Пустая строка, если не указано.

ChannelState get_ready_state() const 🔗

Возвращает текущее состояние этого канала.

bool is_negotiated() const 🔗

Возвращает true, если этот канал был создан с использованием внеполосной конфигурации.

bool is_ordered() const 🔗

Возвращает true, если этот канал был создан с включенным упорядочиванием (по умолчанию).

Error poll() 🔗

Зарезервировано, в данный момент не используется.

bool was_string_packet() const 🔗

Возвращает true, если последний полученный пакет был передан как текст. См. write_mode.