henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 1 | /* |
kjellander | b24317b | 2016-02-10 07:54:43 -0800 | [diff] [blame] | 2 | * Copyright 2012 The WebRTC project authors. All Rights Reserved. |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 3 | * |
kjellander | b24317b | 2016-02-10 07:54:43 -0800 | [diff] [blame] | 4 | * Use of this source code is governed by a BSD-style license |
| 5 | * that can be found in the LICENSE file in the root of the source |
| 6 | * tree. An additional intellectual property rights grant can be found |
| 7 | * in the file PATENTS. All contributing project authors may |
| 8 | * be found in the AUTHORS file in the root of the source tree. |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 9 | */ |
| 10 | |
| 11 | // This file contains interfaces for DataChannels |
| 12 | // http://dev.w3.org/2011/webrtc/editor/webrtc.html#rtcdatachannel |
| 13 | |
Steve Anton | 10542f2 | 2019-01-11 09:11:00 -0800 | [diff] [blame] | 14 | #ifndef API_DATA_CHANNEL_INTERFACE_H_ |
| 15 | #define API_DATA_CHANNEL_INTERFACE_H_ |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 16 | |
Yves Gerey | 988cc08 | 2018-10-23 12:03:01 +0200 | [diff] [blame] | 17 | #include <stddef.h> |
| 18 | #include <stdint.h> |
Jonas Olsson | a4d8737 | 2019-07-05 19:08:33 +0200 | [diff] [blame] | 19 | |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 20 | #include <string> |
| 21 | |
Harald Alvestrand | f3736ed | 2019-04-08 13:09:30 +0200 | [diff] [blame] | 22 | #include "absl/types/optional.h" |
Mirko Bonadei | 92ea95e | 2017-09-15 06:47:31 +0200 | [diff] [blame] | 23 | #include "rtc_base/checks.h" |
Steve Anton | 10542f2 | 2019-01-11 09:11:00 -0800 | [diff] [blame] | 24 | #include "rtc_base/copy_on_write_buffer.h" |
| 25 | #include "rtc_base/ref_count.h" |
Mirko Bonadei | 35214fc | 2019-09-23 14:54:28 +0200 | [diff] [blame] | 26 | #include "rtc_base/system/rtc_export.h" |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 27 | |
| 28 | namespace webrtc { |
| 29 | |
deadbeef | b10f32f | 2017-02-08 01:38:21 -0800 | [diff] [blame] | 30 | // C++ version of: https://www.w3.org/TR/webrtc/#idl-def-rtcdatachannelinit |
Danil Chapovalov | 0bc58cf | 2018-06-21 13:32:56 +0200 | [diff] [blame] | 31 | // TODO(deadbeef): Use absl::optional for the "-1 if unset" things. |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 32 | struct DataChannelInit { |
deadbeef | b10f32f | 2017-02-08 01:38:21 -0800 | [diff] [blame] | 33 | // Deprecated. Reliability is assumed, and channel will be unreliable if |
| 34 | // maxRetransmitTime or MaxRetransmits is set. |
| 35 | bool reliable = false; |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 36 | |
deadbeef | b10f32f | 2017-02-08 01:38:21 -0800 | [diff] [blame] | 37 | // True if ordered delivery is required. |
| 38 | bool ordered = true; |
| 39 | |
| 40 | // The max period of time in milliseconds in which retransmissions will be |
Harald Alvestrand | f3736ed | 2019-04-08 13:09:30 +0200 | [diff] [blame] | 41 | // sent. After this time, no more retransmissions will be sent. |
deadbeef | b10f32f | 2017-02-08 01:38:21 -0800 | [diff] [blame] | 42 | // |
| 43 | // Cannot be set along with |maxRetransmits|. |
Harald Alvestrand | f3736ed | 2019-04-08 13:09:30 +0200 | [diff] [blame] | 44 | // This is called |maxPacketLifeTime| in the WebRTC JS API. |
| 45 | absl::optional<int> maxRetransmitTime; |
deadbeef | b10f32f | 2017-02-08 01:38:21 -0800 | [diff] [blame] | 46 | |
Harald Alvestrand | f3736ed | 2019-04-08 13:09:30 +0200 | [diff] [blame] | 47 | // The max number of retransmissions. |
deadbeef | b10f32f | 2017-02-08 01:38:21 -0800 | [diff] [blame] | 48 | // |
| 49 | // Cannot be set along with |maxRetransmitTime|. |
Harald Alvestrand | f3736ed | 2019-04-08 13:09:30 +0200 | [diff] [blame] | 50 | absl::optional<int> maxRetransmits; |
deadbeef | b10f32f | 2017-02-08 01:38:21 -0800 | [diff] [blame] | 51 | |
| 52 | // This is set by the application and opaque to the WebRTC implementation. |
| 53 | std::string protocol; |
| 54 | |
| 55 | // True if the channel has been externally negotiated and we do not send an |
| 56 | // in-band signalling in the form of an "open" message. If this is true, |id| |
| 57 | // below must be set; otherwise it should be unset and will be negotiated |
| 58 | // in-band. |
| 59 | bool negotiated = false; |
| 60 | |
| 61 | // The stream id, or SID, for SCTP data channels. -1 if unset (see above). |
| 62 | int id = -1; |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 63 | }; |
| 64 | |
deadbeef | b10f32f | 2017-02-08 01:38:21 -0800 | [diff] [blame] | 65 | // At the JavaScript level, data can be passed in as a string or a blob, so |
| 66 | // this structure's |binary| flag tells whether the data should be interpreted |
| 67 | // as binary or text. |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 68 | struct DataBuffer { |
jbauch | eec21bd | 2016-03-20 06:15:43 -0700 | [diff] [blame] | 69 | DataBuffer(const rtc::CopyOnWriteBuffer& data, bool binary) |
Yves Gerey | 665174f | 2018-06-19 15:03:05 +0200 | [diff] [blame] | 70 | : data(data), binary(binary) {} |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 71 | // For convenience for unit tests. |
| 72 | explicit DataBuffer(const std::string& text) |
Yves Gerey | 665174f | 2018-06-19 15:03:05 +0200 | [diff] [blame] | 73 | : data(text.data(), text.length()), binary(false) {} |
kwiberg@webrtc.org | eebcab5 | 2015-03-24 09:19:06 +0000 | [diff] [blame] | 74 | size_t size() const { return data.size(); } |
wu@webrtc.org | d64719d | 2013-08-01 00:00:07 +0000 | [diff] [blame] | 75 | |
jbauch | eec21bd | 2016-03-20 06:15:43 -0700 | [diff] [blame] | 76 | rtc::CopyOnWriteBuffer data; |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 77 | // Indicates if the received data contains UTF-8 or binary data. |
| 78 | // Note that the upper layers are left to verify the UTF-8 encoding. |
| 79 | // TODO(jiayl): prefer to use an enum instead of a bool. |
| 80 | bool binary; |
| 81 | }; |
| 82 | |
deadbeef | b10f32f | 2017-02-08 01:38:21 -0800 | [diff] [blame] | 83 | // Used to implement RTCDataChannel events. |
| 84 | // |
| 85 | // The code responding to these callbacks should unwind the stack before |
| 86 | // using any other webrtc APIs; re-entrancy is not supported. |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 87 | class DataChannelObserver { |
| 88 | public: |
| 89 | // The data channel state have changed. |
| 90 | virtual void OnStateChange() = 0; |
| 91 | // A data buffer was successfully received. |
| 92 | virtual void OnMessage(const DataBuffer& buffer) = 0; |
bemasc | 0edd50c | 2015-07-01 13:34:33 -0700 | [diff] [blame] | 93 | // The data channel's buffered_amount has changed. |
Marina Ciocea | e448a3f | 2019-03-04 15:52:21 +0100 | [diff] [blame] | 94 | virtual void OnBufferedAmountChange(uint64_t sent_data_size) {} |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 95 | |
| 96 | protected: |
Mirko Bonadei | 79eb4dd | 2018-07-19 10:39:30 +0200 | [diff] [blame] | 97 | virtual ~DataChannelObserver() = default; |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 98 | }; |
| 99 | |
Mirko Bonadei | 35214fc | 2019-09-23 14:54:28 +0200 | [diff] [blame] | 100 | class RTC_EXPORT DataChannelInterface : public rtc::RefCountInterface { |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 101 | public: |
deadbeef | b10f32f | 2017-02-08 01:38:21 -0800 | [diff] [blame] | 102 | // C++ version of: https://www.w3.org/TR/webrtc/#idl-def-rtcdatachannelstate |
| 103 | // Unlikely to change, but keep in sync with DataChannel.java:State and |
tkchin@webrtc.org | ff27332 | 2014-04-30 18:32:33 +0000 | [diff] [blame] | 104 | // RTCDataChannel.h:RTCDataChannelState. |
| 105 | enum DataState { |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 106 | kConnecting, |
| 107 | kOpen, // The DataChannel is ready to send data. |
| 108 | kClosing, |
| 109 | kClosed |
| 110 | }; |
| 111 | |
decurtis@webrtc.org | 487a444 | 2015-01-15 22:55:07 +0000 | [diff] [blame] | 112 | static const char* DataStateString(DataState state) { |
| 113 | switch (state) { |
| 114 | case kConnecting: |
| 115 | return "connecting"; |
| 116 | case kOpen: |
| 117 | return "open"; |
| 118 | case kClosing: |
| 119 | return "closing"; |
| 120 | case kClosed: |
| 121 | return "closed"; |
| 122 | } |
henrikg | 91d6ede | 2015-09-17 00:24:34 -0700 | [diff] [blame] | 123 | RTC_CHECK(false) << "Unknown DataChannel state: " << state; |
decurtis@webrtc.org | 487a444 | 2015-01-15 22:55:07 +0000 | [diff] [blame] | 124 | return ""; |
| 125 | } |
| 126 | |
deadbeef | b10f32f | 2017-02-08 01:38:21 -0800 | [diff] [blame] | 127 | // Used to receive events from the data channel. Only one observer can be |
| 128 | // registered at a time. UnregisterObserver should be called before the |
| 129 | // observer object is destroyed. |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 130 | virtual void RegisterObserver(DataChannelObserver* observer) = 0; |
| 131 | virtual void UnregisterObserver() = 0; |
deadbeef | b10f32f | 2017-02-08 01:38:21 -0800 | [diff] [blame] | 132 | |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 133 | // The label attribute represents a label that can be used to distinguish this |
| 134 | // DataChannel object from other DataChannel objects. |
| 135 | virtual std::string label() const = 0; |
wu@webrtc.org | 822fbd8 | 2013-08-15 23:38:54 +0000 | [diff] [blame] | 136 | |
deadbeef | b10f32f | 2017-02-08 01:38:21 -0800 | [diff] [blame] | 137 | // The accessors below simply return the properties from the DataChannelInit |
| 138 | // the data channel was constructed with. |
| 139 | virtual bool reliable() const = 0; |
| 140 | // TODO(deadbeef): Remove these dummy implementations when all classes have |
wu@webrtc.org | 822fbd8 | 2013-08-15 23:38:54 +0000 | [diff] [blame] | 141 | // implemented these APIs. They should all just return the values the |
| 142 | // DataChannel was created with. |
Mirko Bonadei | 79eb4dd | 2018-07-19 10:39:30 +0200 | [diff] [blame] | 143 | virtual bool ordered() const; |
Harald Alvestrand | f3736ed | 2019-04-08 13:09:30 +0200 | [diff] [blame] | 144 | // TODO(hta): Deprecate and remove the following two functions. |
Mirko Bonadei | 79eb4dd | 2018-07-19 10:39:30 +0200 | [diff] [blame] | 145 | virtual uint16_t maxRetransmitTime() const; |
| 146 | virtual uint16_t maxRetransmits() const; |
Harald Alvestrand | f3736ed | 2019-04-08 13:09:30 +0200 | [diff] [blame] | 147 | virtual absl::optional<int> maxRetransmitsOpt() const; |
| 148 | virtual absl::optional<int> maxPacketLifeTime() const; |
Mirko Bonadei | 79eb4dd | 2018-07-19 10:39:30 +0200 | [diff] [blame] | 149 | virtual std::string protocol() const; |
| 150 | virtual bool negotiated() const; |
wu@webrtc.org | 822fbd8 | 2013-08-15 23:38:54 +0000 | [diff] [blame] | 151 | |
deadbeef | b10f32f | 2017-02-08 01:38:21 -0800 | [diff] [blame] | 152 | // Returns the ID from the DataChannelInit, if it was negotiated out-of-band. |
| 153 | // If negotiated in-band, this ID will be populated once the DTLS role is |
| 154 | // determined, and until then this will return -1. |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 155 | virtual int id() const = 0; |
| 156 | virtual DataState state() const = 0; |
hbos | c42d376 | 2016-11-24 01:17:52 -0800 | [diff] [blame] | 157 | virtual uint32_t messages_sent() const = 0; |
| 158 | virtual uint64_t bytes_sent() const = 0; |
| 159 | virtual uint32_t messages_received() const = 0; |
| 160 | virtual uint64_t bytes_received() const = 0; |
deadbeef | b10f32f | 2017-02-08 01:38:21 -0800 | [diff] [blame] | 161 | |
| 162 | // Returns the number of bytes of application data (UTF-8 text and binary |
| 163 | // data) that have been queued using Send but have not yet been processed at |
| 164 | // the SCTP level. See comment above Send below. |
Peter Boström | 0c4e06b | 2015-10-07 12:23:21 +0200 | [diff] [blame] | 165 | virtual uint64_t buffered_amount() const = 0; |
deadbeef | b10f32f | 2017-02-08 01:38:21 -0800 | [diff] [blame] | 166 | |
| 167 | // Begins the graceful data channel closing procedure. See: |
| 168 | // https://tools.ietf.org/html/draft-ietf-rtcweb-data-channel-13#section-6.7 |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 169 | virtual void Close() = 0; |
deadbeef | b10f32f | 2017-02-08 01:38:21 -0800 | [diff] [blame] | 170 | |
| 171 | // Sends |data| to the remote peer. If the data can't be sent at the SCTP |
| 172 | // level (due to congestion control), it's buffered at the data channel level, |
| 173 | // up to a maximum of 16MB. If Send is called while this buffer is full, the |
| 174 | // data channel will be closed abruptly. |
| 175 | // |
| 176 | // So, it's important to use buffered_amount() and OnBufferedAmountChange to |
| 177 | // ensure the data channel is used efficiently but without filling this |
| 178 | // buffer. |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 179 | virtual bool Send(const DataBuffer& buffer) = 0; |
| 180 | |
| 181 | protected: |
Mirko Bonadei | 79eb4dd | 2018-07-19 10:39:30 +0200 | [diff] [blame] | 182 | ~DataChannelInterface() override = default; |
henrike@webrtc.org | 28e2075 | 2013-07-10 00:45:36 +0000 | [diff] [blame] | 183 | }; |
| 184 | |
| 185 | } // namespace webrtc |
| 186 | |
Steve Anton | 10542f2 | 2019-01-11 09:11:00 -0800 | [diff] [blame] | 187 | #endif // API_DATA_CHANNEL_INTERFACE_H_ |