WebRTCDataChannel

Hereda: PacketPeer < RefCounted < Object

Heredado por: WebRTCDataChannelExtension

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

Propiedades

WriteMode

write_mode

1

Métodos

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


Enumeraciones

enum WriteMode: 🔗

WriteMode WRITE_MODE_TEXT = 0

Indica al canal que mande los datos como texto. Un compañero externo (non-Godot) lo recibiría como una string.

WriteMode WRITE_MODE_BINARY = 1

Le dice al canal que envíe datos por este canal en binario. Un par externo (no Godot) recibiría esto como un búfer o blob del array.


enum ChannelState: 🔗

ChannelState STATE_CONNECTING = 0

El canal fue creado, pero todavía está tratando de conectarse.

ChannelState STATE_OPEN = 1

El canal está actualmente abierto, y los datos pueden fluir sobre él.

ChannelState STATE_CLOSING = 2

El canal se está cerrando, no se aceptarán nuevos mensajes, pero los que ya están en cola serán eliminados.

ChannelState STATE_CLOSED = 3

El canal se cerró, o la conexión falló.


Descripciones de Propiedades

WriteMode write_mode = 1 🔗

Modo de transferencia a usar cuando se mande el paquete de salido. Puede ser texto o binario.


Descripciones de Métodos

void close() 🔗

Cierra este canal de datos, notificando al otro par.


int get_buffered_amount() const 🔗

Devuelve la cantidad de bytes actualmente en cola para ser enviados a través de este canal.


int get_id() const 🔗

Devuelve el ID asignado a este canal durante la creación (o asignado automáticamente durante la negociación).

Si el canal no se negocia fuera de banda, el ID solo estará disponible después de establecer la conexión (hasta entonces, devolverá 65535).


String get_label() const 🔗

Devuelve la etiqueta asignada al canal durante su creación.


int get_max_packet_life_time() const 🔗

Devuelve el valor maxPacketLifeTime asignado a este canal durante la creación.

Será 65535 si no se especifica.


int get_max_retransmits() const 🔗

Devuelve el valor maxRetransmits asignado a este canal durante la creación.

Será 65535 si no se especifica.


String get_protocol() const 🔗

Devuelve el sub-protocolo asignado a este canal durante la creación. Una string vacía si no se especifica.


ChannelState get_ready_state() const 🔗

Devuelve el estado actual de este canal.


bool is_negotiated() const 🔗

Devuelve true si este canal fue creado con una configuración fuera de banda.


bool is_ordered() const 🔗

Devuelve true si este canal fue creado con el pedido activado (por defecto).


Error poll() 🔗

Reservado, pero sin uso de momento.


bool was_string_packet() const 🔗

Devuelve true si el último paquete recibido se transfirió como texto. Véase write_mode.