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