RTCDataChannel.protocol
The read-only RTCDataChannel
property protocol
returns a string containing the name of the subprotocol in use. If no protocol was specified when the data channel was created, then this property's value is the empty string (""
).
Note: The permitted values of this property are defined by the Web site or app using the data channel.
The ability for each channel to have a defined subprotocol lets your app, for example, use JSON objects as messages on one channel while another channel is plaintext and another is raw binary or even some other format.
Syntax
var subProtocol = aDataChannel.protocol;
Value
A string identifying the app-defined subprotocol being used for exchanging data on the channel. If none has been established, this is an empty string ("").
Example
var pc = new RTCPeerConnection(); var dc = pc.createDataChannel("my channel", { protocol: "json" }); function handleChannelMessage(dataChannel, msg) { switch(dataChannel.protocol) { case "json": /* process JSON data */ break; case "raw": /* process raw binary data */ break; } }
Specifications
Specification |
---|
WebRTC 1.0: Real-Time Communication Between Browsers (WebRTC 1.0) # dom-datachannel-protocol |
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 | |
protocol |
30 |
79 |
22 |
No |
17 |
11 |
4.4 |
30 |
22 |
18 |
11 |
2.0 |
See also
© 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/protocol