blob: aa31e25eab7b9acb07c799391e2c279f99fa38d6 [file] [log] [blame]
henrike@webrtc.orgf0488722014-05-13 18:00:261/*
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 Anton10542f22019-01-11 17:11:0011#ifndef RTC_BASE_ASYNC_PACKET_SOCKET_H_
12#define RTC_BASE_ASYNC_PACKET_SOCKET_H_
henrike@webrtc.orgf0488722014-05-13 18:00:2613
Steve Antonf4172382020-01-27 23:45:0214#include <vector>
15
Tomas Gunnarssonf15189d2022-04-13 09:03:5216#include "api/sequence_checker.h"
17#include "rtc_base/callback_list.h"
Mirko Bonadei92ea95e2017-09-15 04:47:3118#include "rtc_base/dscp.h"
Yves Gerey3e707812018-11-28 15:47:4919#include "rtc_base/network/sent_packet.h"
Mirko Bonadei92ea95e2017-09-15 04:47:3120#include "rtc_base/socket.h"
Tomas Gunnarssonf15189d2022-04-13 09:03:5221#include "rtc_base/system/no_unique_address.h"
Mirko Bonadei35214fc2019-09-23 12:54:2822#include "rtc_base/system/rtc_export.h"
Artem Titove41c4332018-07-25 13:04:2823#include "rtc_base/third_party/sigslot/sigslot.h"
Steve Anton10542f22019-01-11 17:11:0024#include "rtc_base/time_utils.h"
henrike@webrtc.orgf0488722014-05-13 18:00:2625
Henrik Kjellanderec78f1c2017-06-29 05:52:5026namespace 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.
31struct PacketTimeUpdateParams {
32 PacketTimeUpdateParams();
Qingsi Wang6e641e62018-04-12 03:14:1733 PacketTimeUpdateParams(const PacketTimeUpdateParams& other);
Henrik Kjellanderec78f1c2017-06-29 05:52:5034 ~PacketTimeUpdateParams();
35
Qingsi Wang6e641e62018-04-12 03:14:1736 int rtp_sendtime_extension_id = -1; // extension header id present in packet.
Yves Gerey665174f2018-06-19 13:03:0537 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 Kjellanderec78f1c2017-06-29 05:52:5040};
41
42// This structure holds meta information for the packet which is about to send
43// over network.
Mirko Bonadei35214fc2019-09-23 12:54:2844struct RTC_EXPORT PacketOptions {
Qingsi Wang6e641e62018-04-12 03:14:1745 PacketOptions();
46 explicit PacketOptions(DiffServCodePoint dscp);
47 PacketOptions(const PacketOptions& other);
48 ~PacketOptions();
Henrik Kjellanderec78f1c2017-06-29 05:52:5049
Qingsi Wang6e641e62018-04-12 03:14:1750 DiffServCodePoint dscp = DSCP_NO_CHANGE;
Bjorn Mellem3a9c46d2018-04-25 20:24:4851 // 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 Kjellanderec78f1c2017-06-29 05:52:5054 PacketTimeUpdateParams packet_time_params;
Qingsi Wang6e641e62018-04-12 03:14:1755 // PacketInfo is passed to SentPacket when signaling this packet is sent.
56 PacketInfo info_signaled_after_sent;
Henrik Kjellanderec78f1c2017-06-29 05:52:5057};
58
Henrik Kjellanderec78f1c2017-06-29 05:52:5059// Provides the ability to receive packets asynchronously. Sends are not
60// buffered since it is acceptable to drop packets under high load.
Mirko Bonadei35214fc2019-09-23 12:54:2861class RTC_EXPORT AsyncPacketSocket : public sigslot::has_slots<> {
Henrik Kjellanderec78f1c2017-06-29 05:52:5062 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 Lee14af7622022-01-11 20:24:5874 AsyncPacketSocket(const AsyncPacketSocket&) = delete;
75 AsyncPacketSocket& operator=(const AsyncPacketSocket&) = delete;
76
Henrik Kjellanderec78f1c2017-06-29 05:52:5077 // 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 Gerey665174f2018-06-19 13:03:0585 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 Kjellanderec78f1c2017-06-29 05:52:5089 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 Gunnarssonf15189d2022-04-13 09:03:52106 // 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 Kjellanderec78f1c2017-06-29 05:52:50111 // Emitted each time a packet is read. Used only for UDP and
112 // connected TCP sockets.
Yves Gerey665174f2018-06-19 13:03:05113 sigslot::signal5<AsyncPacketSocket*,
114 const char*,
115 size_t,
Henrik Kjellanderec78f1c2017-06-29 05:52:50116 const SocketAddress&,
Niels Möllere6933812018-11-05 12:01:41117 // TODO(bugs.webrtc.org/9584): Change to passing the int64_t
118 // timestamp by value.
119 const int64_t&>
Yves Gerey665174f2018-06-19 13:03:05120 SignalReadPacket;
Henrik Kjellanderec78f1c2017-06-29 05:52:50121
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öller4a1c2c42021-09-28 08:17:07130 // (for UDP sockets).
Henrik Kjellanderec78f1c2017-06-29 05:52:50131 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 Gunnarssonf15189d2022-04-13 09:03:52137 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 Kjellanderec78f1c2017-06-29 05:52:50156};
157
Niels Möllerd30ece12021-10-19 08:11:02158// Listen socket, producing an AsyncPacketSocket when a peer connects.
159class 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öllerd30ece12021-10-19 08:11:02173 sigslot::signal2<AsyncListenSocket*, AsyncPacketSocket*> SignalNewConnection;
174};
Niels Möller6d19d142021-10-06 09:19:03175
Qingsi Wang6e641e62018-04-12 03:14:17176void CopySocketInformationToPacketInfo(size_t packet_size_bytes,
177 const AsyncPacketSocket& socket_from,
Qingsi Wang4ea53b32018-04-17 01:22:31178 bool is_connectionless,
Qingsi Wang6e641e62018-04-12 03:14:17179 rtc::PacketInfo* info);
180
Henrik Kjellanderec78f1c2017-06-29 05:52:50181} // namespace rtc
henrike@webrtc.orgf0488722014-05-13 18:00:26182
Steve Anton10542f22019-01-11 17:11:00183#endif // RTC_BASE_ASYNC_PACKET_SOCKET_H_