RTCDataChannel.onopen

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.

Syntax

RTCDataChannel.onopen = function;

Value

A function which the browser will call to handle the open event. The function receives as its only input parameter the event itself, of type Event.

Example

This example adds a new data channel to an existing RTCPeerConnection, myPeerConnection. It then establishes an open event handler which updates some user interface elements to prepare them for being used to send messages over the data channel.

let dc = myPeerConnection.createDataChannel("Message Channel");

dc.onopen = function(event) {
  let messageBox = document.getElementById("messageBox");
  let sendButton = document.getElementById("sendButton");

  messageBox.disabled = false;
  messageBox.focus();
  sendButton.disabled = false;
}

Specifications

Specification	Status	Comment
WebRTC 1.0: Real-time Communication Between Browsers The definition of 'RTCDataChannel.onopen' in that specification.	Working Draft	Initial specification.

Browser compatibility

[1] The interface is called DataChannel and not RTCDataChannel in Firefox. However, a binding has been in place since Firefox 24 so that either name will work.

See also

• WebRTC
• The open event and its type, Event.
• RTCDataChannel.onclose
• The close event and its type, Event.