RTCDataChannel

Experimental

Esta é uma tecnologia experimental
Verifique a tabela de compatibilidade entre Navegadores cuidadosamente antes de usar essa funcionalidade em produção.

A interface RTCDataChannel representa um canal de rede que pode ser usado para transferências bidirecionais de dados arbitrários de ponto a ponto. Todo canal de dados está associado a RTCPeerConnection, e cada conexão de pares pode ter até um máximo teórico de 65,534 canais de dados (o limite real pode variar de navegador para navegador).

Para criar um canal de dados e pedir a um ponto remoto para se juntar a você, chame os metodos RTCPeerConnection's createDataChannel().  O interlocutor que está sendo convidado a trocar dados recebe um evento datachannel (que possui o tipo RTCDataChannelEvent) para informá-lo de que o canal de dados foi adicionado à conexão.

Propriedades

Also inherits propriedades from: EventTarget

binaryType This is an experimental API that should not be used in production code.
The property binaryType on the RTCDataChannel interface is a DOMString which specifies the type of JavaScript object which should be used to represent binary data received on the RTCDataChannel. Values allowed by the WebSocket.binaryType property are also permitted here: "blob" if Blob objects are being used or "arraybuffer" if ArrayBuffer objects are being used. The default is "blob".
bufferedAmount This is an experimental API that should not be used in production code. undefined
The read-only RTCDataChannel property bufferedAmount returns the number of bytes of data currently queued to be sent over the data channel.
bufferedAmountLowThreshold This is an experimental API that should not be used in production code.
The RTCDataChannel property bufferedAmountLowThreshold is used to specify the number of bytes of buffered outgoing data that is considered "low." The default value is 0.
id This is an experimental API that should not be used in production code. undefined
The read-only RTCDataChannel property id returns an ID number (between 0 and 65,534) which uniquely identifies the RTCDataChannel.
label This is an experimental API that should not be used in production code. undefined
The read-only RTCDataChannel property label returns a DOMString containing a name describing the data channel. These labels are not required to be unique.
maxPacketLifeTime This is an experimental API that should not be used in production code. undefined
The read-only RTCDataChannel property maxPacketLifeTime returns the amount of time, in milliseconds, the browser is allowed to take to attempt to transmit a message, as set when the data channel was created, or null.
maxRetransmits This is an experimental API that should not be used in production code. undefined
The read-only RTCDataChannel property maxRetransmits returns the maximum number of times the browser should try to retransmit a message before giving up, as set when the data channel was created, or null, which indicates that there is no maximum.
negotiated undefined
The read-only RTCDataChannel property negotiated indicates whether the RTCDataChannel's connection was negotiated by the Web app (true) or by the WebRTC layer (false).
ordered This is an experimental API that should not be used in production code. undefined
The read-only RTCDataChannel property ordered indicates whether or not the data channel guarantees in-order delivery of messages; the default is true, which indicates that the data channel is indeed ordered.
protocol This is an experimental API that should not be used in production code. undefined
The read-only RTCDataChannel property protocol returns a DOMString containing the name of the subprotocol in use. If no protocol was specified when the data channel was created, then this property's value is "" (the empty string).
readyState This is an experimental API that should not be used in production code. undefined
The read-only RTCDataChannel property readyState returns an enum of type RTCDataChannelState which indicates the state of the data channel's underlying data connection.
reliable This is an experimental API that should not be used in production code. This is an obsolete API and is no longer guaranteed to work. undefined
The read-only RTCDataChannel property reliable indicates whether or not the data channel is reliable.
stream This API has not been standardized. This is an obsolete API and is no longer guaranteed to work. undefined
The deprecated (and never part of the official specification) read-only RTCDataChannel property stream returns an ID number (between 0 and 65,535) which uniquely identifies the RTCDataChannel.

Handlers de Eventos

Also inherits handlers de eventos from: EventTarget

onbufferedamountlow This is an experimental API that should not be used in production code.
The RTCDataChannel.onbufferedamountlow property is an EventHandler which specifies a function the browser calls when the bufferedamountlow event is sent to the RTCDataChannel. This event, which is represented by a simple Event object, is sent when the amount of data buffered to be sent falls to or below the threshold specified by the channel's RTCDataChannel.bufferedAmountLowThreshold.
onclose This is an experimental API that should not be used in production code.
The RTCDataChannel.onclose property is an EventHandler which specifies a function to be called by the browser when the close event is received by the RTCDataChannel. This is a simple Event which indicates that the data channel has closed down.
onclosing This is an experimental API that should not be used in production code.
The RTCDataChannel.onclosing property is an EventHandler which specifies a function to be called by the browser when the closing event is received by the RTCDataChannel. This is a simple Event which indicates that the data channel is being closed, that is, RTCDataChannel transitions to "closing" state. For example, after RTCDataChannel.close was called but the underlying data transport might not have been closed yet.
onerror This is an experimental API that should not be used in production code.
The RTCDataChannel.onerror property is an EventHandler which specifies a function to be called when the error event is received. When an error occurs on the data channel, the function receives as input an ErrorEvent object describing the error which occurred.
onmessage This is an experimental API that should not be used in production code.
The RTCDataChannel.onmessage property stores an EventHandler which specifies a function to be called when the message event is fired on the channel. This event is represented by the MessageEvent interface. This event is sent to the channel when a message is received from the other peer.
onopen This is an experimental API that should not be used in production code.
The RTCDataChannel.onopen property is an EventHandler which specifies a function to be called when the open event is fired; this is a simple Event which is sent when the data channel's underlying data transport—the link over which the RTCDataChannel's messages flow—is established or re-established.

Métodos

Also inherits métodos from: EventTarget

close()
The RTCDataChannel.close() method closes the RTCDataChannel. Either peer is permitted to call this method to initiate closure of the channel.
send()
The send() method of the RTCDataChannel interface sends data across the data channel to the remote peer.

Exemplo

var pc = new RTCPeerConnection();
var dc = pc.createDataChannel("my channel");

dc.onmessage = function (event) {
  console.log("received: " + event.data);
};

dc.onopen = function () {
  console.log("datachannel open");
};

dc.onclose = function () {
  console.log("datachannel close");
};

Especificações

Especificação Status Comentário
WebRTC 1.0: Real-time Communication Between Browsers
The definition of 'RTCDataChannel' in that specification.		 Candidata a Recomendação Especificação inicial

Compatibilidade do navegador

Estamos convertendo nossos dados de compatibilidade para o formato JSON. Esta tabela de compatibilidade ainda usa o formato antigo, pois ainda não convertemos os dados que ela contém. Descubra como você pode ajudar!

Característica Chrome Firefox (Gecko) Internet Explorer Opera Safari
Suporte básico (Yes) 22 (22) [1] Não suportado (Yes) ?
onbufferedamountlow 56 Não suportado Não suportado 43 Não suportado
Característica Android Webview Chrome for Android Firefox Mobile (Gecko) IE Mobile Opera Mobile Safari Mobile
Basic support 29 29 22.0 (22) [1] Não suportado (Yes) Não suportado
onbufferedamountlow 56 56 Não suportado ? 43 ?

[1] A interface é chamada DataChannel e não RTCDataChannel no Firefox. No entanto, uma ligação foi implementada desde o Firefox 24 para que qualquer um dos nomes funcione.

Veja também