This is an experimental technology
Check the Browser compatibility table carefully before using this in production.
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.
Syntax
RTCDataChannel.onclose = function;
Value
A function which the browser will call to handle the close
event. The function receives as its sole input parameter the event itself, as an object of type Event
.
Example
In this sample from a hypothetical instant messaging client, a data channel is created, then handlers for the open
and close
events are set up to enable and disable user interface objects based on the state of the channel. This way, the message entry field and the send button are only enabled for use when the connection is actually open.
let pc = new RTCPeerConnection(); let dc = pc.createDataChannel("MessageChannel")}}; dc.onopen = function(event) { document.getElementById("messageBox").disabled = false; document.getElementById("sendButton").disabled = false; }; dc.onclose = function(event) { document.getElementById("messageBox").disabled = true; document.getElementById("sendButton").disabled = true; } /* Now negotiate the connection, etc... */
Specifications
Specification | Status | Comment |
---|---|---|
WebRTC 1.0: Real-time Communication Between Browsers The definition of 'RTCDataChannel.onclose' in that specification. |
Candidate Recommendation | Initial specification. |
Browser compatibility
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
onclose | Chrome Full support 56 | Edge Full support ≤79 | Firefox Full support Yes | IE No support No | Opera Full support 43 | Safari No support No | WebView Android Full support 56 | Chrome Android Full support 56 | Firefox Android Full support Yes | Opera Android Full support 43 | Safari iOS No support No | Samsung Internet Android Full support 6.0 |
Legend
- Full support
- Full support
- No support
- No support
- Experimental. Expect behavior to change in the future.
- Experimental. Expect behavior to change in the future.