RTCDataChannel: close event
The close event is sent to the onclose event handler on an RTCDataChannel instance when the data transport being used for the data channel has closed. Before any further data can be transferred using RTCDataChannel, a new data channel instance must be created.
| Bubbles | No |
|---|---|
| Cancelable | No |
| Interface | Event |
| Event handler property | RTCDataChannel.onclose |
Examples
This example sets up a handler for the close event for the RTCDataChannel named dc; its responsibility in this example is to update user interface elements to reflect that there is no longer an ongoing call, and to allow a new call to be started.
dc.addEventListener("close", ev => { messageInputBox.disabled = true; sendButton.disabled = true; connectButton.disabled = false; disconnectButton.disabled = true; }, false);
All this code does in response to receiving the close event is to disable an input box and its "Send" button, and to enable the button used to start a call (while disabling the one that ends a call).
You can also use the onclose event handler property to set a handler for close events:
dc.onclose = ev => { messageInputBox.disabled = true; sendButton.disabled = true; connectButton.disabled = false; disconnectButton.disabled = true; }
Specifications
| Specification |
|---|
| WebRTC 1.0: Real-Time Communication Between Browsers (WebRTC 1.0) # event-datachannel-close |
Browser compatibility
| Desktop | Mobile | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Chrome | Edge | Firefox | Internet Explorer | Opera | Safari | WebView Android | Chrome Android | Firefox for Android | Opera Android | Safari on IOS | Samsung Internet | |
close_event |
24 |
≤79 |
Yes |
No |
15 |
11 |
≤37 |
25 |
Yes |
14 |
11 |
1.5 |
See also
- WebRTC API
- A simple RTCDataChannel example
- Related events:
open,message, anderror
© 2005–2021 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/RTCDataChannel/close_event