Harald Alvestrand | 05e4d08 | 2019-12-03 13:04:21 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2019 The WebRTC project authors. All Rights Reserved. |
| 3 | * |
| 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. |
| 9 | */ |
| 10 | |
| 11 | #ifndef PC_DATA_CHANNEL_CONTROLLER_H_ |
| 12 | #define PC_DATA_CHANNEL_CONTROLLER_H_ |
| 13 | |
Harald Alvestrand | 5761e7b | 2021-01-29 14:45:08 | [diff] [blame] | 14 | #include <stdint.h> |
| 15 | |
Harald Alvestrand | 05e4d08 | 2019-12-03 13:04:21 | [diff] [blame] | 16 | #include <map> |
| 17 | #include <memory> |
| 18 | #include <string> |
| 19 | #include <vector> |
| 20 | |
Harald Alvestrand | 5761e7b | 2021-01-29 14:45:08 | [diff] [blame] | 21 | #include "api/data_channel_interface.h" |
| 22 | #include "api/scoped_refptr.h" |
Artem Titov | d15a575 | 2021-02-10 13:31:24 | [diff] [blame] | 23 | #include "api/sequence_checker.h" |
Harald Alvestrand | 5761e7b | 2021-01-29 14:45:08 | [diff] [blame] | 24 | #include "api/transport/data_channel_transport_interface.h" |
| 25 | #include "media/base/media_channel.h" |
| 26 | #include "media/base/media_engine.h" |
| 27 | #include "media/base/stream_params.h" |
Harald Alvestrand | 05e4d08 | 2019-12-03 13:04:21 | [diff] [blame] | 28 | #include "pc/channel.h" |
Harald Alvestrand | 5761e7b | 2021-01-29 14:45:08 | [diff] [blame] | 29 | #include "pc/data_channel_utils.h" |
Taylor Brandstetter | 3a034e1 | 2020-07-09 22:32:34 | [diff] [blame] | 30 | #include "pc/sctp_data_channel.h" |
Harald Alvestrand | 5761e7b | 2021-01-29 14:45:08 | [diff] [blame] | 31 | #include "rtc_base/checks.h" |
| 32 | #include "rtc_base/copy_on_write_buffer.h" |
| 33 | #include "rtc_base/ssl_stream_adapter.h" |
Harald Alvestrand | 5761e7b | 2021-01-29 14:45:08 | [diff] [blame] | 34 | #include "rtc_base/third_party/sigslot/sigslot.h" |
| 35 | #include "rtc_base/thread.h" |
| 36 | #include "rtc_base/thread_annotations.h" |
Harald Alvestrand | 246724b | 2019-12-03 21:31:42 | [diff] [blame] | 37 | #include "rtc_base/weak_ptr.h" |
Harald Alvestrand | 05e4d08 | 2019-12-03 13:04:21 | [diff] [blame] | 38 | |
| 39 | namespace webrtc { |
| 40 | |
| 41 | class PeerConnection; |
| 42 | |
Harald Alvestrand | 7af57c6 | 2021-04-16 11:12:14 | [diff] [blame] | 43 | class DataChannelController : public SctpDataChannelProviderInterface, |
Harald Alvestrand | 05e4d08 | 2019-12-03 13:04:21 | [diff] [blame] | 44 | public DataChannelSink { |
| 45 | public: |
| 46 | explicit DataChannelController(PeerConnection* pc) : pc_(pc) {} |
| 47 | |
Harald Alvestrand | ab81316 | 2020-01-09 12:29:56 | [diff] [blame] | 48 | // Not copyable or movable. |
| 49 | DataChannelController(DataChannelController&) = delete; |
| 50 | DataChannelController& operator=(const DataChannelController& other) = delete; |
| 51 | DataChannelController(DataChannelController&&) = delete; |
| 52 | DataChannelController& operator=(DataChannelController&& other) = delete; |
| 53 | |
Harald Alvestrand | 7af57c6 | 2021-04-16 11:12:14 | [diff] [blame] | 54 | // Implements |
Taylor Brandstetter | 3a034e1 | 2020-07-09 22:32:34 | [diff] [blame] | 55 | // SctpDataChannelProviderInterface. |
Florent Castelli | d95b149 | 2021-05-10 09:29:56 | [diff] [blame] | 56 | bool SendData(int sid, |
| 57 | const SendDataParams& params, |
Harald Alvestrand | 05e4d08 | 2019-12-03 13:04:21 | [diff] [blame] | 58 | const rtc::CopyOnWriteBuffer& payload, |
| 59 | cricket::SendDataResult* result) override; |
Taylor Brandstetter | 3a034e1 | 2020-07-09 22:32:34 | [diff] [blame] | 60 | bool ConnectDataChannel(SctpDataChannel* webrtc_data_channel) override; |
| 61 | void DisconnectDataChannel(SctpDataChannel* webrtc_data_channel) override; |
Harald Alvestrand | 05e4d08 | 2019-12-03 13:04:21 | [diff] [blame] | 62 | void AddSctpDataStream(int sid) override; |
| 63 | void RemoveSctpDataStream(int sid) override; |
| 64 | bool ReadyToSendData() const override; |
| 65 | |
| 66 | // Implements DataChannelSink. |
| 67 | void OnDataReceived(int channel_id, |
| 68 | DataMessageType type, |
| 69 | const rtc::CopyOnWriteBuffer& buffer) override; |
| 70 | void OnChannelClosing(int channel_id) override; |
| 71 | void OnChannelClosed(int channel_id) override; |
| 72 | void OnReadyToSend() override; |
Harald Alvestrand | 2697ac1 | 2019-12-16 09:37:04 | [diff] [blame] | 73 | void OnTransportClosed() override; |
Harald Alvestrand | 05e4d08 | 2019-12-03 13:04:21 | [diff] [blame] | 74 | |
| 75 | // Called from PeerConnection::SetupDataChannelTransport_n |
| 76 | void SetupDataChannelTransport_n(); |
| 77 | // Called from PeerConnection::TeardownDataChannelTransport_n |
| 78 | void TeardownDataChannelTransport_n(); |
| 79 | |
| 80 | // Called from PeerConnection::OnTransportChanged |
| 81 | // to make required changes to datachannels' transports. |
| 82 | void OnTransportChanged( |
| 83 | DataChannelTransportInterface* data_channel_transport); |
| 84 | |
Tomas Gunnarsson | 2e94de5 | 2020-06-16 14:54:10 | [diff] [blame] | 85 | // Called from PeerConnection::GetDataChannelStats on the signaling thread. |
Taylor Brandstetter | 3a034e1 | 2020-07-09 22:32:34 | [diff] [blame] | 86 | std::vector<DataChannelStats> GetDataChannelStats() const; |
Tomas Gunnarsson | 2e94de5 | 2020-06-16 14:54:10 | [diff] [blame] | 87 | |
Harald Alvestrand | 05e4d08 | 2019-12-03 13:04:21 | [diff] [blame] | 88 | // Creates channel and adds it to the collection of DataChannels that will |
Taylor Brandstetter | 3a034e1 | 2020-07-09 22:32:34 | [diff] [blame] | 89 | // be offered in a SessionDescription, and wraps it in a proxy object. |
| 90 | rtc::scoped_refptr<DataChannelInterface> InternalCreateDataChannelWithProxy( |
Harald Alvestrand | 05e4d08 | 2019-12-03 13:04:21 | [diff] [blame] | 91 | const std::string& label, |
| 92 | const InternalDataChannelInit* |
| 93 | config) /* RTC_RUN_ON(signaling_thread()) */; |
| 94 | void AllocateSctpSids(rtc::SSLRole role); |
| 95 | |
Taylor Brandstetter | 3a034e1 | 2020-07-09 22:32:34 | [diff] [blame] | 96 | SctpDataChannel* FindDataChannelBySid(int sid) const; |
Harald Alvestrand | 05e4d08 | 2019-12-03 13:04:21 | [diff] [blame] | 97 | |
| 98 | // Checks if any data channel has been added. |
| 99 | bool HasDataChannels() const; |
| 100 | bool HasSctpDataChannels() const { |
| 101 | RTC_DCHECK_RUN_ON(signaling_thread()); |
| 102 | return !sctp_data_channels_.empty(); |
| 103 | } |
Harald Alvestrand | 05e4d08 | 2019-12-03 13:04:21 | [diff] [blame] | 104 | |
| 105 | // Accessors |
Tomas Gunnarsson | 7d3cfbf | 2020-06-15 11:47:42 | [diff] [blame] | 106 | DataChannelTransportInterface* data_channel_transport() const; |
| 107 | void set_data_channel_transport(DataChannelTransportInterface* transport); |
Harald Alvestrand | 05e4d08 | 2019-12-03 13:04:21 | [diff] [blame] | 108 | |
Taylor Brandstetter | 3a034e1 | 2020-07-09 22:32:34 | [diff] [blame] | 109 | sigslot::signal1<SctpDataChannel*>& SignalSctpDataChannelCreated() { |
| 110 | RTC_DCHECK_RUN_ON(signaling_thread()); |
| 111 | return SignalSctpDataChannelCreated_; |
Harald Alvestrand | 05e4d08 | 2019-12-03 13:04:21 | [diff] [blame] | 112 | } |
| 113 | // Called when the transport for the data channels is closed or destroyed. |
| 114 | void OnTransportChannelClosed(); |
| 115 | |
Taylor Brandstetter | 3a034e1 | 2020-07-09 22:32:34 | [diff] [blame] | 116 | void OnSctpDataChannelClosed(SctpDataChannel* channel); |
Harald Alvestrand | 05e4d08 | 2019-12-03 13:04:21 | [diff] [blame] | 117 | |
| 118 | private: |
Taylor Brandstetter | 3a034e1 | 2020-07-09 22:32:34 | [diff] [blame] | 119 | rtc::scoped_refptr<SctpDataChannel> InternalCreateSctpDataChannel( |
| 120 | const std::string& label, |
| 121 | const InternalDataChannelInit* |
| 122 | config) /* RTC_RUN_ON(signaling_thread()) */; |
| 123 | |
Harald Alvestrand | 05e4d08 | 2019-12-03 13:04:21 | [diff] [blame] | 124 | // Parses and handles open messages. Returns true if the message is an open |
| 125 | // message, false otherwise. |
| 126 | bool HandleOpenMessage_s(const cricket::ReceiveDataParams& params, |
| 127 | const rtc::CopyOnWriteBuffer& buffer) |
| 128 | RTC_RUN_ON(signaling_thread()); |
| 129 | // Called when a valid data channel OPEN message is received. |
| 130 | void OnDataChannelOpenMessage(const std::string& label, |
| 131 | const InternalDataChannelInit& config) |
| 132 | RTC_RUN_ON(signaling_thread()); |
| 133 | |
Tomas Gunnarsson | 7d3cfbf | 2020-06-15 11:47:42 | [diff] [blame] | 134 | // Called from SendData when data_channel_transport() is true. |
Florent Castelli | d95b149 | 2021-05-10 09:29:56 | [diff] [blame] | 135 | bool DataChannelSendData(int sid, |
| 136 | const SendDataParams& params, |
Tomas Gunnarsson | 7d3cfbf | 2020-06-15 11:47:42 | [diff] [blame] | 137 | const rtc::CopyOnWriteBuffer& payload, |
| 138 | cricket::SendDataResult* result); |
| 139 | |
Tomas Gunnarsson | 2e94de5 | 2020-06-16 14:54:10 | [diff] [blame] | 140 | // Called when all data channels need to be notified of a transport channel |
| 141 | // (calls OnTransportChannelCreated on the signaling thread). |
| 142 | void NotifyDataChannelsOfTransportCreated(); |
| 143 | |
Harald Alvestrand | 05e4d08 | 2019-12-03 13:04:21 | [diff] [blame] | 144 | rtc::Thread* network_thread() const; |
| 145 | rtc::Thread* signaling_thread() const; |
| 146 | |
Harald Alvestrand | 05e4d08 | 2019-12-03 13:04:21 | [diff] [blame] | 147 | // Plugin transport used for data channels. Pointer may be accessed and |
| 148 | // checked from any thread, but the object may only be touched on the |
| 149 | // network thread. |
| 150 | // TODO(bugs.webrtc.org/9987): Accessed on both signaling and network |
| 151 | // thread. |
| 152 | DataChannelTransportInterface* data_channel_transport_ = nullptr; |
| 153 | |
| 154 | // Cached value of whether the data channel transport is ready to send. |
| 155 | bool data_channel_transport_ready_to_send_ |
| 156 | RTC_GUARDED_BY(signaling_thread()) = false; |
| 157 | |
Harald Alvestrand | 05e4d08 | 2019-12-03 13:04:21 | [diff] [blame] | 158 | SctpSidAllocator sid_allocator_ /* RTC_GUARDED_BY(signaling_thread()) */; |
Taylor Brandstetter | 3a034e1 | 2020-07-09 22:32:34 | [diff] [blame] | 159 | std::vector<rtc::scoped_refptr<SctpDataChannel>> sctp_data_channels_ |
Harald Alvestrand | 05e4d08 | 2019-12-03 13:04:21 | [diff] [blame] | 160 | RTC_GUARDED_BY(signaling_thread()); |
Taylor Brandstetter | 3a034e1 | 2020-07-09 22:32:34 | [diff] [blame] | 161 | std::vector<rtc::scoped_refptr<SctpDataChannel>> sctp_data_channels_to_free_ |
Harald Alvestrand | 05e4d08 | 2019-12-03 13:04:21 | [diff] [blame] | 162 | RTC_GUARDED_BY(signaling_thread()); |
| 163 | |
Harald Alvestrand | 05e4d08 | 2019-12-03 13:04:21 | [diff] [blame] | 164 | // Signals from |data_channel_transport_|. These are invoked on the |
| 165 | // signaling thread. |
Tomas Gunnarsson | 7d3cfbf | 2020-06-15 11:47:42 | [diff] [blame] | 166 | // TODO(bugs.webrtc.org/11547): These '_s' signals likely all belong on the |
| 167 | // network thread. |
Harald Alvestrand | 05e4d08 | 2019-12-03 13:04:21 | [diff] [blame] | 168 | sigslot::signal1<bool> SignalDataChannelTransportWritable_s |
| 169 | RTC_GUARDED_BY(signaling_thread()); |
| 170 | sigslot::signal2<const cricket::ReceiveDataParams&, |
| 171 | const rtc::CopyOnWriteBuffer&> |
| 172 | SignalDataChannelTransportReceivedData_s |
| 173 | RTC_GUARDED_BY(signaling_thread()); |
| 174 | sigslot::signal1<int> SignalDataChannelTransportChannelClosing_s |
| 175 | RTC_GUARDED_BY(signaling_thread()); |
| 176 | sigslot::signal1<int> SignalDataChannelTransportChannelClosed_s |
| 177 | RTC_GUARDED_BY(signaling_thread()); |
| 178 | |
Taylor Brandstetter | 3a034e1 | 2020-07-09 22:32:34 | [diff] [blame] | 179 | sigslot::signal1<SctpDataChannel*> SignalSctpDataChannelCreated_ |
Harald Alvestrand | 05e4d08 | 2019-12-03 13:04:21 | [diff] [blame] | 180 | RTC_GUARDED_BY(signaling_thread()); |
| 181 | |
Harald Alvestrand | 05e4d08 | 2019-12-03 13:04:21 | [diff] [blame] | 182 | // Owning PeerConnection. |
| 183 | PeerConnection* const pc_; |
Niels Möller | 236e36c | 2021-03-23 08:23:10 | [diff] [blame] | 184 | // The weak pointers must be dereferenced and invalidated on the signalling |
| 185 | // thread only. |
Harald Alvestrand | 246724b | 2019-12-03 21:31:42 | [diff] [blame] | 186 | rtc::WeakPtrFactory<DataChannelController> weak_factory_{this}; |
Harald Alvestrand | 05e4d08 | 2019-12-03 13:04:21 | [diff] [blame] | 187 | }; |
| 188 | |
| 189 | } // namespace webrtc |
| 190 | |
| 191 | #endif // PC_DATA_CHANNEL_CONTROLLER_H_ |