RTCDataChannel.readyState

The read-only RTCDataChannel property readyState returns an enum of type RTCDataChannelState which indicates the state of the data channel's underlying data connection.

Syntax

var state = aDataChannel.readyState;

Values

A string which is one of the values in the RTCDataChannelState enum, indicating the current state of the underlying data transport.

RTCDataChannelState enum

The RTCDataChannelState enum defines string constants which reflect the current status of the RTCDataChannel's underlying data connection.

Example

var dataChannel = peerConnection.createDataChannel("File Transfer");
var sendQueue = [];

function sendMessage(msg) {
  switch(dataChannel.readyState) {
    case "connecting":
      console.log("Connection not open; queueing: " + msg);
      sendQueue.push(msg);
      break;
    case "open":
      sendQueue.forEach((msg) => dataChannel.send(msg));
      break;
    case "closing":
      console.log("Attempted to send message while closing: " + msg);
      break;
    case "closed":
      console.log("Error! Attempt to send while connection closed.");
      break;
  }
}

Specifications

Browser compatibility

[1] The interface is called DataChannel and not RTCDataChannel in Firefox; however, a binding was added in Firefox 24 which allows either name to be used.

See also

• WebRTC
• Using WebRTC data channels
• RTCDataChannel
• RTCPeerConnection.createDataChannel()