File tree Expand file tree Collapse file tree 1 file changed +13
-2
lines changed Expand file tree Collapse file tree 1 file changed +13
-2
lines changed Original file line number Diff line number Diff line change @@ -3,13 +3,24 @@ defmodule ExWebRTC.DataChannel do
3
3
Implementation of the [RTCDataChannel](https://developer.mozilla.org/en-US/docs/Web/API/RTCDataChannel).
4
4
"""
5
5
6
+ @ typedoc """
7
+ Possible data channel order configurations.
8
+
9
+ For the exact meaning, refer to the [RTCDataChannel: order property](https://developer.mozilla.org/en-US/docs/Web/API/RTCDataChannel/readyState).
10
+ """
6
11
@ type order ( ) :: :ordered | :unordered
7
12
8
13
@ type ref ( ) :: reference ( )
9
14
10
- @ type id ( ) :: non_neg_integer ( )
15
+ @ typedoc """
16
+ Possible data channel states.
17
+
18
+ Right now, Elixir WebRTC does not support `:closing` state.
19
+ When you close the data channel, it goes from `:open` directly to `:closed`.
11
20
12
- @ type ready_state ( ) :: :connecting | :open | :closing | :closed
21
+ For the exact meaning, refer to the [RTCDataChannel: readyState property](https://developer.mozilla.org/en-US/docs/Web/API/RTCDataChannel/readyState).
22
+ """
23
+ @ type ready_state ( ) :: :connecting | :open | :closed
13
24
14
25
@ typedoc """
15
26
Options used when creating a new DataChannel.
You can’t perform that action at this time.
0 commit comments