WebRTCDataChannel

Hérite de : PacketPeer < RefCounted < Object

Hérité par : WebRTCDataChannelExtension

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

Propriétés

WriteMode

write_mode

1

Méthodes

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

Énumérations

enum WriteMode: 🔗

WriteMode WRITE_MODE_TEXT = 0

Demande au canal d'envoyer des données sur ce canal sous forme de texte. Un pair externe (non Godot) le reçoit sous forme de chaîne de caractères.

WriteMode WRITE_MODE_BINARY = 1

Demande au canal d'envoyer des données sur ce canal sous forme binaire. Un pair externe (non Godot) le reçoit sous forme de tableau tampon ou de blob.

enum ChannelState: 🔗

ChannelState STATE_CONNECTING = 0

Le canal a été créé, mais il essaie toujours de se connecter.

ChannelState STATE_OPEN = 1

Le canal est actuellement ouvert, et les données peuvent y circuler.

ChannelState STATE_CLOSING = 2

Le canal est en cours de fermeture, aucun nouveau message ne sera accepté, mais ceux déjà en file d'attente seront vidés.

ChannelState STATE_CLOSED = 3

Le canal a été fermé ou la connexion a échoué.

Descriptions des propriétés

WriteMode write_mode = 1 🔗

Le mode de transfert à utiliser lors de l'envoi de paquets sortants. Soit texte, soit binaire.

Descriptions des méthodes

void close() 🔗

Ferme ce canal de données, en notifiant l’autre homologue.

int get_buffered_amount() const 🔗

Renvoie le nombre d'octets actuellement en queue pour être envoyés sur ce canal.

int get_id() const 🔗

Renvoie l'identifiant assigné à ce canal pendant la création (ou auto-assigné pendant la négociation).

Si le canal n'est pas négocié hors bande, l'ID ne sera disponible qu'après la mise en place de la connexion (renverra 65535 jusqu'alors).

String get_label() const 🔗

Renvoie l'étiquette attribuée à cette chaîne lors de sa création.

int get_max_packet_life_time() const 🔗

Renvoie la valeur maxPacketLifeTime attribuée à ce canal durant la création.

Vaudra 65535 si non spécifié.

int get_max_retransmits() const 🔗

Renvoie la valeur maxRetransmits attribuée à ce canal durant la création.

Vaudra 65535 si non spécifié.

String get_protocol() const 🔗

Renvoie le sous-protocole assigné à ce canal lors de la création. Une chaîne de caractères vide si il n'est pas spécifié.

ChannelState get_ready_state() const 🔗

Renvoie l'état actuel de ce canal.

bool is_negotiated() const 🔗

Renvoie true si ce canal a été créé avec une configuration hors bande.

bool is_ordered() const 🔗

Renvoie true si ce canal a été créé avec le tri activé (par défaut).

Error poll() 🔗

Réservé, mais non utilisé pour l'instant.

bool was_string_packet() const 🔗

Renvoie true si le dernier paquet reçu a été transféré comme texte. Voir write_mode.