RTCDataChannel.onerror

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.

Syntax

RTCDataChannel.onerror = function;

Value

A function which the browser will call to handle the error event when it occurs on the data channel. This function receives as its only input an ErrorEvent object describing the event which was received. That event object, in turn, describes the error that took place.

Example

In the example below, a data channel is established, and an onerror handler is added to it. The error handler passes information about the error to a UI library's alert box function to present an error message to the user.

let pc = new RTCPeerConnection();
let dc = pc.createDataChannel("PlayerControl");

dc.onerror = function(event) {
  myUILibrary.doAlertBox({
    'Network Error',        // Alert title
    'The error "' + event.message +
           '" occurred while handling player control network messages.',
    event.filename,
    event.lineno,
    event.colno
  });
}

/* ... */

Specifications

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.

[2] WebRTC, including RTCDataChannel, was introduced in Chrome 28 for Android behind a flag, and enabled by default starting in Chrome 29 for Android.

See also

• WebRTC
• The error event and its type, ErrorEvent.