Attention: Here be dragons
This is the latest
(unstable) version of this documentation, which may document features
not available in or compatible with released stable versions of Godot.
Checking the stable version of the documentation...
WebRTCDataChannel
Eredita: PacketPeer < RefCounted < Object
Ereditato da: WebRTCDataChannelExtension
There is currently no description for this class. Please help us by contributing one!
Proprietà
|
Metodi
void |
close() |
get_buffered_amount() const |
|
get_id() const |
|
get_label() const |
|
get_max_packet_life_time() const |
|
get_max_retransmits() const |
|
get_protocol() const |
|
get_ready_state() const |
|
is_negotiated() const |
|
is_ordered() const |
|
poll() |
|
was_string_packet() const |
Enumerazioni
enum WriteMode: 🔗
WriteMode WRITE_MODE_TEXT = 0
Indica al canale di inviare dati su questo canale sotto forma di testo. Un peer esterno (non Godot) riceverebbe questo come una stringa.
WriteMode WRITE_MODE_BINARY = 1
Indica al canale di inviare dati su questo canale sotto forma binaria. Un peer esterno (non-Godot) riceverebbe questo come un buffer di array o blob.
enum ChannelState: 🔗
ChannelState STATE_CONNECTING = 0
Il canale è stato creato, ma sta ancora cercando di connettersi.
ChannelState STATE_OPEN = 1
Il canale è attualmente aperto, e i dati possono circolare su di esso.
ChannelState STATE_CLOSING = 2
Il canale è in fase di chiusura, non saranno accettati nuovi messaggi, ma quelli già in coda saranno svuotati.
ChannelState STATE_CLOSED = 3
Il canale è stato chiuso, o la connessione non è riuscita.
Descrizioni delle proprietà
La modalità di trasferimento da utilizzare quando si invia il pacchetto in uscita. Può essere testo o binario.
Descrizioni dei metodi
void close() 🔗
Chiude questo canale di dati, notificando l'altro peer.
int get_buffered_amount() const 🔗
Restituisce il numero di byte attualmente in coda per essere inviati su questo canale.
Restituisce l'ID assegnato a questo canale durante la creazione (o assegnato automaticamente durante la negoziazione).
Se il canale non è negoziato fuori banda l'ID sarà disponibile solo dopo che la connessione è stabilita (restituirà 65535 fino ad allora).
Restituisce l'etichetta assegnata a questo canale durante la creazione.
int get_max_packet_life_time() const 🔗
Restituisce il valore maxPacketLifeTime assegnato a questo canale durante la creazione.
Sarà 65535 se non specificato.
int get_max_retransmits() const 🔗
Restituisce il valore maxRetransmits assegnato a questo canale durante la creazione.
Sarà 65535 se non specificato.
Restituisce il sottoprotocollo assegnato a questo canale durante la creazione. Una stringa vuota se non specificata.
ChannelState get_ready_state() const 🔗
Restituisce lo stato attuale di questo canale.
Restituisce true se questo canale è stato creato con configurazione fuori banda.
Restituisce true se questo canale è stato creato con l'ordinazione abilitata (predefinito).
Riservato, ma non usato per il momento.
bool was_string_packet() const 🔗
Restituisce true se l'ultimo pacchetto ricevuto è stato trasferito come testo. Vedi write_mode.