Back to Content

RTCDataChannel: ordered property

files/en-us/web/api/rtcdatachannel/ordered/index.md

latest921 B
Original Source

{{APIRef("WebRTC")}}

The read-only RTCDataChannel property ordered indicates whether or not the data channel guarantees in-order delivery of messages; the default is true, which indicates that the data channel is indeed ordered. This is set when the {{domxref("RTCDataChannel")}} is created, by setting the ordered property on the object passed as {{domxref("RTCPeerConnection.createDataChannel()")}}'s options parameter.

Value

A boolean value which is true if in-order delivery is guaranteed and is otherwise false.

Example

js
const pc = new RTCPeerConnection();
const dc = pc.createDataChannel("my channel");

if (!dc.ordered) {
  // Handle unordered messaging
}

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}

See also

  • WebRTC
  • {{domxref("RTCDataChannel")}}
  • {{domxref("RTCPeerConnection.createDataChannel()")}}