henrike@webrtc.org | f048872 | 2014-05-13 18:00:26 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2004 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 | |
Steve Anton | 10542f2 | 2019-01-11 17:11:00 | [diff] [blame] | 11 | #ifndef RTC_BASE_ASYNC_PACKET_SOCKET_H_ |
| 12 | #define RTC_BASE_ASYNC_PACKET_SOCKET_H_ |
henrike@webrtc.org | f048872 | 2014-05-13 18:00:26 | [diff] [blame] | 13 | |
Steve Anton | f417238 | 2020-01-27 23:45:02 | [diff] [blame] | 14 | #include <vector> |
| 15 | |
Tomas Gunnarsson | f15189d | 2022-04-13 09:03:52 | [diff] [blame] | 16 | #include "api/sequence_checker.h" |
| 17 | #include "rtc_base/callback_list.h" |
Mirko Bonadei | 92ea95e | 2017-09-15 04:47:31 | [diff] [blame] | 18 | #include "rtc_base/dscp.h" |
Yves Gerey | 3e70781 | 2018-11-28 15:47:49 | [diff] [blame] | 19 | #include "rtc_base/network/sent_packet.h" |
Mirko Bonadei | 92ea95e | 2017-09-15 04:47:31 | [diff] [blame] | 20 | #include "rtc_base/socket.h" |
Tomas Gunnarsson | f15189d | 2022-04-13 09:03:52 | [diff] [blame] | 21 | #include "rtc_base/system/no_unique_address.h" |
Mirko Bonadei | 35214fc | 2019-09-23 12:54:28 | [diff] [blame] | 22 | #include "rtc_base/system/rtc_export.h" |
Artem Titov | e41c433 | 2018-07-25 13:04:28 | [diff] [blame] | 23 | #include "rtc_base/third_party/sigslot/sigslot.h" |
Steve Anton | 10542f2 | 2019-01-11 17:11:00 | [diff] [blame] | 24 | #include "rtc_base/time_utils.h" |
henrike@webrtc.org | f048872 | 2014-05-13 18:00:26 | [diff] [blame] | 25 | |
Henrik Kjellander | ec78f1c | 2017-06-29 05:52:50 | [diff] [blame] | 26 | namespace rtc { |
| 27 | |
| 28 | // This structure holds the info needed to update the packet send time header |
| 29 | // extension, including the information needed to update the authentication tag |
| 30 | // after changing the value. |
| 31 | struct PacketTimeUpdateParams { |
| 32 | PacketTimeUpdateParams(); |
Qingsi Wang | 6e641e6 | 2018-04-12 03:14:17 | [diff] [blame] | 33 | PacketTimeUpdateParams(const PacketTimeUpdateParams& other); |
Henrik Kjellander | ec78f1c | 2017-06-29 05:52:50 | [diff] [blame] | 34 | ~PacketTimeUpdateParams(); |
| 35 | |
Qingsi Wang | 6e641e6 | 2018-04-12 03:14:17 | [diff] [blame] | 36 | int rtp_sendtime_extension_id = -1; // extension header id present in packet. |
Yves Gerey | 665174f | 2018-06-19 13:03:05 | [diff] [blame] | 37 | std::vector<char> srtp_auth_key; // Authentication key. |
| 38 | int srtp_auth_tag_len = -1; // Authentication tag length. |
| 39 | int64_t srtp_packet_index = -1; // Required for Rtp Packet authentication. |
Henrik Kjellander | ec78f1c | 2017-06-29 05:52:50 | [diff] [blame] | 40 | }; |
| 41 | |
| 42 | // This structure holds meta information for the packet which is about to send |
| 43 | // over network. |
Mirko Bonadei | 35214fc | 2019-09-23 12:54:28 | [diff] [blame] | 44 | struct RTC_EXPORT PacketOptions { |
Qingsi Wang | 6e641e6 | 2018-04-12 03:14:17 | [diff] [blame] | 45 | PacketOptions(); |
| 46 | explicit PacketOptions(DiffServCodePoint dscp); |
| 47 | PacketOptions(const PacketOptions& other); |
| 48 | ~PacketOptions(); |
Henrik Kjellander | ec78f1c | 2017-06-29 05:52:50 | [diff] [blame] | 49 | |
Qingsi Wang | 6e641e6 | 2018-04-12 03:14:17 | [diff] [blame] | 50 | DiffServCodePoint dscp = DSCP_NO_CHANGE; |
Bjorn Mellem | 3a9c46d | 2018-04-25 20:24:48 | [diff] [blame] | 51 | // When used with RTP packets (for example, webrtc::PacketOptions), the value |
| 52 | // should be 16 bits. A value of -1 represents "not set". |
| 53 | int64_t packet_id = -1; |
Henrik Kjellander | ec78f1c | 2017-06-29 05:52:50 | [diff] [blame] | 54 | PacketTimeUpdateParams packet_time_params; |
Qingsi Wang | 6e641e6 | 2018-04-12 03:14:17 | [diff] [blame] | 55 | // PacketInfo is passed to SentPacket when signaling this packet is sent. |
| 56 | PacketInfo info_signaled_after_sent; |
Henrik Kjellander | ec78f1c | 2017-06-29 05:52:50 | [diff] [blame] | 57 | }; |
| 58 | |
Henrik Kjellander | ec78f1c | 2017-06-29 05:52:50 | [diff] [blame] | 59 | // Provides the ability to receive packets asynchronously. Sends are not |
| 60 | // buffered since it is acceptable to drop packets under high load. |
Mirko Bonadei | 35214fc | 2019-09-23 12:54:28 | [diff] [blame] | 61 | class RTC_EXPORT AsyncPacketSocket : public sigslot::has_slots<> { |
Henrik Kjellander | ec78f1c | 2017-06-29 05:52:50 | [diff] [blame] | 62 | public: |
| 63 | enum State { |
| 64 | STATE_CLOSED, |
| 65 | STATE_BINDING, |
| 66 | STATE_BOUND, |
| 67 | STATE_CONNECTING, |
| 68 | STATE_CONNECTED |
| 69 | }; |
| 70 | |
| 71 | AsyncPacketSocket(); |
| 72 | ~AsyncPacketSocket() override; |
| 73 | |
Byoungchan Lee | 14af762 | 2022-01-11 20:24:58 | [diff] [blame] | 74 | AsyncPacketSocket(const AsyncPacketSocket&) = delete; |
| 75 | AsyncPacketSocket& operator=(const AsyncPacketSocket&) = delete; |
| 76 | |
Henrik Kjellander | ec78f1c | 2017-06-29 05:52:50 | [diff] [blame] | 77 | // Returns current local address. Address may be set to null if the |
| 78 | // socket is not bound yet (GetState() returns STATE_BINDING). |
| 79 | virtual SocketAddress GetLocalAddress() const = 0; |
| 80 | |
| 81 | // Returns remote address. Returns zeroes if this is not a client TCP socket. |
| 82 | virtual SocketAddress GetRemoteAddress() const = 0; |
| 83 | |
| 84 | // Send a packet. |
Yves Gerey | 665174f | 2018-06-19 13:03:05 | [diff] [blame] | 85 | virtual int Send(const void* pv, size_t cb, const PacketOptions& options) = 0; |
| 86 | virtual int SendTo(const void* pv, |
| 87 | size_t cb, |
| 88 | const SocketAddress& addr, |
Henrik Kjellander | ec78f1c | 2017-06-29 05:52:50 | [diff] [blame] | 89 | const PacketOptions& options) = 0; |
| 90 | |
| 91 | // Close the socket. |
| 92 | virtual int Close() = 0; |
| 93 | |
| 94 | // Returns current state of the socket. |
| 95 | virtual State GetState() const = 0; |
| 96 | |
| 97 | // Get/set options. |
| 98 | virtual int GetOption(Socket::Option opt, int* value) = 0; |
| 99 | virtual int SetOption(Socket::Option opt, int value) = 0; |
| 100 | |
| 101 | // Get/Set current error. |
| 102 | // TODO: Remove SetError(). |
| 103 | virtual int GetError() const = 0; |
| 104 | virtual void SetError(int error) = 0; |
| 105 | |
Tomas Gunnarsson | f15189d | 2022-04-13 09:03:52 | [diff] [blame] | 106 | // Register a callback to be called when the socket is closed. |
| 107 | void SubscribeClose(const void* removal_tag, |
| 108 | std::function<void(AsyncPacketSocket*, int)> callback); |
| 109 | void UnsubscribeClose(const void* removal_tag); |
| 110 | |
Henrik Kjellander | ec78f1c | 2017-06-29 05:52:50 | [diff] [blame] | 111 | // Emitted each time a packet is read. Used only for UDP and |
| 112 | // connected TCP sockets. |
Yves Gerey | 665174f | 2018-06-19 13:03:05 | [diff] [blame] | 113 | sigslot::signal5<AsyncPacketSocket*, |
| 114 | const char*, |
| 115 | size_t, |
Henrik Kjellander | ec78f1c | 2017-06-29 05:52:50 | [diff] [blame] | 116 | const SocketAddress&, |
Niels Möller | e693381 | 2018-11-05 12:01:41 | [diff] [blame] | 117 | // TODO(bugs.webrtc.org/9584): Change to passing the int64_t |
| 118 | // timestamp by value. |
| 119 | const int64_t&> |
Yves Gerey | 665174f | 2018-06-19 13:03:05 | [diff] [blame] | 120 | SignalReadPacket; |
Henrik Kjellander | ec78f1c | 2017-06-29 05:52:50 | [diff] [blame] | 121 | |
| 122 | // Emitted each time a packet is sent. |
| 123 | sigslot::signal2<AsyncPacketSocket*, const SentPacket&> SignalSentPacket; |
| 124 | |
| 125 | // Emitted when the socket is currently able to send. |
| 126 | sigslot::signal1<AsyncPacketSocket*> SignalReadyToSend; |
| 127 | |
| 128 | // Emitted after address for the socket is allocated, i.e. binding |
| 129 | // is finished. State of the socket is changed from BINDING to BOUND |
Niels Möller | 4a1c2c4 | 2021-09-28 08:17:07 | [diff] [blame] | 130 | // (for UDP sockets). |
Henrik Kjellander | ec78f1c | 2017-06-29 05:52:50 | [diff] [blame] | 131 | sigslot::signal2<AsyncPacketSocket*, const SocketAddress&> SignalAddressReady; |
| 132 | |
| 133 | // Emitted for client TCP sockets when state is changed from |
| 134 | // CONNECTING to CONNECTED. |
| 135 | sigslot::signal1<AsyncPacketSocket*> SignalConnect; |
| 136 | |
Tomas Gunnarsson | f15189d | 2022-04-13 09:03:52 | [diff] [blame] | 137 | void NotifyClosedForTest(int err) { NotifyClosed(err); } |
| 138 | |
| 139 | protected: |
| 140 | // TODO(bugs.webrtc.org/11943): Remove after updating downstream code. |
| 141 | void SignalClose(AsyncPacketSocket* s, int err) { |
| 142 | RTC_DCHECK_EQ(s, this); |
| 143 | NotifyClosed(err); |
| 144 | } |
| 145 | |
| 146 | void NotifyClosed(int err) { |
| 147 | RTC_DCHECK_RUN_ON(&network_checker_); |
| 148 | on_close_.Send(this, err); |
| 149 | } |
| 150 | |
| 151 | RTC_NO_UNIQUE_ADDRESS webrtc::SequenceChecker network_checker_; |
| 152 | |
| 153 | private: |
| 154 | webrtc::CallbackList<AsyncPacketSocket*, int> on_close_ |
| 155 | RTC_GUARDED_BY(&network_checker_); |
Henrik Kjellander | ec78f1c | 2017-06-29 05:52:50 | [diff] [blame] | 156 | }; |
| 157 | |
Niels Möller | d30ece1 | 2021-10-19 08:11:02 | [diff] [blame] | 158 | // Listen socket, producing an AsyncPacketSocket when a peer connects. |
| 159 | class RTC_EXPORT AsyncListenSocket : public sigslot::has_slots<> { |
| 160 | public: |
| 161 | enum class State { |
| 162 | kClosed, |
| 163 | kBound, |
| 164 | }; |
| 165 | |
| 166 | // Returns current state of the socket. |
| 167 | virtual State GetState() const = 0; |
| 168 | |
| 169 | // Returns current local address. Address may be set to null if the |
| 170 | // socket is not bound yet (GetState() returns kBinding). |
| 171 | virtual SocketAddress GetLocalAddress() const = 0; |
| 172 | |
Niels Möller | d30ece1 | 2021-10-19 08:11:02 | [diff] [blame] | 173 | sigslot::signal2<AsyncListenSocket*, AsyncPacketSocket*> SignalNewConnection; |
| 174 | }; |
Niels Möller | 6d19d14 | 2021-10-06 09:19:03 | [diff] [blame] | 175 | |
Qingsi Wang | 6e641e6 | 2018-04-12 03:14:17 | [diff] [blame] | 176 | void CopySocketInformationToPacketInfo(size_t packet_size_bytes, |
| 177 | const AsyncPacketSocket& socket_from, |
Qingsi Wang | 4ea53b3 | 2018-04-17 01:22:31 | [diff] [blame] | 178 | bool is_connectionless, |
Qingsi Wang | 6e641e6 | 2018-04-12 03:14:17 | [diff] [blame] | 179 | rtc::PacketInfo* info); |
| 180 | |
Henrik Kjellander | ec78f1c | 2017-06-29 05:52:50 | [diff] [blame] | 181 | } // namespace rtc |
henrike@webrtc.org | f048872 | 2014-05-13 18:00:26 | [diff] [blame] | 182 | |
Steve Anton | 10542f2 | 2019-01-11 17:11:00 | [diff] [blame] | 183 | #endif // RTC_BASE_ASYNC_PACKET_SOCKET_H_ |