Skip to content

Commit

Permalink
docs(webrtc): improve negotiated documentation (#567)
Browse files Browse the repository at this point in the history
  • Loading branch information
DougAnderson444 authored Aug 14, 2023
1 parent d2106f4 commit 50db89f
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions webrtc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,8 +132,10 @@ real-world experiments.

`RTCDataChannel`s are negotiated in-band by the WebRTC user agent (e.g. Firefox,
Pion, ...). In other words libp2p WebRTC implementations MUST NOT change the
default value `negotiated: false` when creating a `RTCDataChannel` via
`RTCPeerConnection.createDataChannel`.
default value `negotiated: false` when creating a standard libp2p stream
of type `RTCDataChannel` via `RTCPeerConnection.createDataChannel`.
Setting `negotiated: true` is reserved only for creating Noise handshake channels
under certain protocol conditions.

The WebRTC user agent (i.e. not the application) decides on the `RTCDataChannel`
ID based on the local node's connection role. For the interested reader see
Expand Down

0 comments on commit 50db89f

Please sign in to comment.