blob: e1a702039df1d36a1cf5aad77ca9b2f49eb37171 [file] [log] [blame]
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +00001/*
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
11#ifndef WEBRTC_P2P_BASE_PORT_H_
12#define WEBRTC_P2P_BASE_PORT_H_
13
14#include <map>
kwiberg3ec46792016-04-27 07:22:53 -070015#include <memory>
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +000016#include <set>
17#include <string>
18#include <vector>
19
20#include "webrtc/p2p/base/candidate.h"
Honghai Zhangcc411c02016-03-29 17:27:21 -070021#include "webrtc/p2p/base/candidatepairinterface.h"
deadbeef49f34fd2016-12-06 16:22:06 -080022#include "webrtc/p2p/base/jseptransport.h"
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +000023#include "webrtc/p2p/base/packetsocketfactory.h"
24#include "webrtc/p2p/base/portinterface.h"
25#include "webrtc/p2p/base/stun.h"
26#include "webrtc/p2p/base/stunrequest.h"
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +000027#include "webrtc/base/asyncpacketsocket.h"
28#include "webrtc/base/network.h"
29#include "webrtc/base/proxyinfo.h"
30#include "webrtc/base/ratetracker.h"
31#include "webrtc/base/sigslot.h"
32#include "webrtc/base/socketaddress.h"
33#include "webrtc/base/thread.h"
34
35namespace cricket {
36
37class Connection;
38class ConnectionRequest;
39
40extern const char LOCAL_PORT_TYPE[];
41extern const char STUN_PORT_TYPE[];
42extern const char PRFLX_PORT_TYPE[];
43extern const char RELAY_PORT_TYPE[];
44
45extern const char UDP_PROTOCOL_NAME[];
46extern const char TCP_PROTOCOL_NAME[];
47extern const char SSLTCP_PROTOCOL_NAME[];
48
49// RFC 6544, TCP candidate encoding rules.
50extern const int DISCARD_PORT;
51extern const char TCPTYPE_ACTIVE_STR[];
52extern const char TCPTYPE_PASSIVE_STR[];
53extern const char TCPTYPE_SIMOPEN_STR[];
54
Honghai Zhang2b342bf2015-09-30 09:51:58 -070055// The minimum time we will wait before destroying a connection after creating
56// it.
honghaiz34b11eb2016-03-16 08:55:44 -070057static const int MIN_CONNECTION_LIFETIME = 10 * 1000; // 10 seconds.
Peter Thatcher04ac81f2015-09-21 11:48:28 -070058
Honghai Zhang2cd7afe2015-11-12 11:14:33 -080059// A connection will be declared dead if it has not received anything for this
60// long.
honghaiz34b11eb2016-03-16 08:55:44 -070061static const int DEAD_CONNECTION_RECEIVE_TIMEOUT = 30 * 1000; // 30 seconds.
Honghai Zhang2cd7afe2015-11-12 11:14:33 -080062
Peter Thatcher04ac81f2015-09-21 11:48:28 -070063// The timeout duration when a connection does not receive anything.
honghaiz34b11eb2016-03-16 08:55:44 -070064static const int WEAK_CONNECTION_RECEIVE_TIMEOUT = 2500; // 2.5 seconds
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +000065
66// The length of time we wait before timing out writability on a connection.
honghaiz34b11eb2016-03-16 08:55:44 -070067static const int CONNECTION_WRITE_TIMEOUT = 15 * 1000; // 15 seconds
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +000068
69// The length of time we wait before we become unwritable.
honghaiz34b11eb2016-03-16 08:55:44 -070070static const int CONNECTION_WRITE_CONNECT_TIMEOUT = 5 * 1000; // 5 seconds
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +000071
72// This is the length of time that we wait for a ping response to come back.
honghaiz34b11eb2016-03-16 08:55:44 -070073static const int CONNECTION_RESPONSE_TIMEOUT = 5 * 1000; // 5 seconds
74
75// The number of pings that must fail to respond before we become unwritable.
76static const uint32_t CONNECTION_WRITE_CONNECT_FAILURES = 5;
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +000077
78enum RelayType {
79 RELAY_GTURN, // Legacy google relay service.
80 RELAY_TURN // Standard (TURN) relay service.
81};
82
83enum IcePriorityValue {
hnsl277b2502016-12-13 05:17:23 -080084 ICE_TYPE_PREFERENCE_RELAY_TLS = 0,
85 ICE_TYPE_PREFERENCE_RELAY_TCP = 1,
86 ICE_TYPE_PREFERENCE_RELAY_UDP = 2,
Taylor Brandstetter62351c92016-08-11 16:05:07 -070087 ICE_TYPE_PREFERENCE_PRFLX_TCP = 80,
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +000088 ICE_TYPE_PREFERENCE_HOST_TCP = 90,
89 ICE_TYPE_PREFERENCE_SRFLX = 100,
90 ICE_TYPE_PREFERENCE_PRFLX = 110,
91 ICE_TYPE_PREFERENCE_HOST = 126
92};
93
94const char* ProtoToString(ProtocolType proto);
95bool StringToProto(const char* value, ProtocolType* proto);
96
97struct ProtocolAddress {
98 rtc::SocketAddress address;
99 ProtocolType proto;
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000100
101 ProtocolAddress(const rtc::SocketAddress& a, ProtocolType p)
hnsl277b2502016-12-13 05:17:23 -0800102 : address(a), proto(p) {}
Taylor Brandstettera1c30352016-05-13 08:15:11 -0700103
104 bool operator==(const ProtocolAddress& o) const {
hnsl277b2502016-12-13 05:17:23 -0800105 return address == o.address && proto == o.proto;
Taylor Brandstettera1c30352016-05-13 08:15:11 -0700106 }
107 bool operator!=(const ProtocolAddress& o) const { return !(*this == o); }
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000108};
109
110typedef std::set<rtc::SocketAddress> ServerAddresses;
111
112// Represents a local communication mechanism that can be used to create
113// connections to similar mechanisms of the other client. Subclasses of this
114// one add support for specific mechanisms like local UDP ports.
115class Port : public PortInterface, public rtc::MessageHandler,
116 public sigslot::has_slots<> {
117 public:
Honghai Zhanga74363c2016-07-28 18:06:15 -0700118 // INIT: The state when a port is just created.
119 // KEEP_ALIVE_UNTIL_PRUNED: A port should not be destroyed even if no
120 // connection is using it.
121 // PRUNED: It will be destroyed if no connection is using it for a period of
122 // 30 seconds.
123 enum class State { INIT, KEEP_ALIVE_UNTIL_PRUNED, PRUNED };
pkasting@chromium.org332331f2014-11-06 20:19:22 +0000124 Port(rtc::Thread* thread,
Honghai Zhangd00c0572016-06-28 09:44:47 -0700125 const std::string& type,
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000126 rtc::PacketSocketFactory* factory,
pkasting@chromium.org332331f2014-11-06 20:19:22 +0000127 rtc::Network* network,
128 const rtc::IPAddress& ip,
129 const std::string& username_fragment,
130 const std::string& password);
131 Port(rtc::Thread* thread,
132 const std::string& type,
133 rtc::PacketSocketFactory* factory,
134 rtc::Network* network,
135 const rtc::IPAddress& ip,
Peter Boström0c4e06b2015-10-07 12:23:21 +0200136 uint16_t min_port,
137 uint16_t max_port,
pkasting@chromium.org332331f2014-11-06 20:19:22 +0000138 const std::string& username_fragment,
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000139 const std::string& password);
140 virtual ~Port();
141
142 virtual const std::string& Type() const { return type_; }
143 virtual rtc::Network* Network() const { return network_; }
144
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000145 // Methods to set/get ICE role and tiebreaker values.
146 IceRole GetIceRole() const { return ice_role_; }
147 void SetIceRole(IceRole role) { ice_role_ = role; }
148
Peter Boström0c4e06b2015-10-07 12:23:21 +0200149 void SetIceTiebreaker(uint64_t tiebreaker) { tiebreaker_ = tiebreaker; }
150 uint64_t IceTiebreaker() const { return tiebreaker_; }
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000151
152 virtual bool SharedSocket() const { return shared_socket_; }
153 void ResetSharedSocket() { shared_socket_ = false; }
154
Honghai Zhanga74363c2016-07-28 18:06:15 -0700155 // Should not destroy the port even if no connection is using it. Called when
156 // a port is ready to use.
157 void KeepAliveUntilPruned();
158 // Allows a port to be destroyed if no connection is using it.
159 void Prune();
160
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000161 // The thread on which this port performs its I/O.
162 rtc::Thread* thread() { return thread_; }
163
164 // The factory used to create the sockets of this port.
165 rtc::PacketSocketFactory* socket_factory() const { return factory_; }
166 void set_socket_factory(rtc::PacketSocketFactory* factory) {
167 factory_ = factory;
168 }
169
170 // For debugging purposes.
171 const std::string& content_name() const { return content_name_; }
172 void set_content_name(const std::string& content_name) {
173 content_name_ = content_name;
174 }
175
176 int component() const { return component_; }
177 void set_component(int component) { component_ = component; }
178
179 bool send_retransmit_count_attribute() const {
180 return send_retransmit_count_attribute_;
181 }
182 void set_send_retransmit_count_attribute(bool enable) {
183 send_retransmit_count_attribute_ = enable;
184 }
185
186 // Identifies the generation that this port was created in.
deadbeef14f97f52016-06-22 17:14:15 -0700187 uint32_t generation() const { return generation_; }
Peter Boström0c4e06b2015-10-07 12:23:21 +0200188 void set_generation(uint32_t generation) { generation_ = generation; }
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000189
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000190 const std::string username_fragment() const;
191 const std::string& password() const { return password_; }
192
Taylor Brandstettera1c30352016-05-13 08:15:11 -0700193 // May be called when this port was initially created by a pooled
194 // PortAllocatorSession, and is now being assigned to an ICE transport.
195 // Updates the information for candidates as well.
196 void SetIceParameters(int component,
197 const std::string& username_fragment,
198 const std::string& password);
199
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000200 // Fired when candidates are discovered by the port. When all candidates
201 // are discovered that belong to port SignalAddressReady is fired.
202 sigslot::signal2<Port*, const Candidate&> SignalCandidateReady;
203
204 // Provides all of the above information in one handy object.
205 virtual const std::vector<Candidate>& Candidates() const {
206 return candidates_;
207 }
208
209 // SignalPortComplete is sent when port completes the task of candidates
210 // allocation.
211 sigslot::signal1<Port*> SignalPortComplete;
212 // This signal sent when port fails to allocate candidates and this port
213 // can't be used in establishing the connections. When port is in shared mode
214 // and port fails to allocate one of the candidates, port shouldn't send
215 // this signal as other candidates might be usefull in establishing the
216 // connection.
217 sigslot::signal1<Port*> SignalPortError;
218
219 // Returns a map containing all of the connections of this port, keyed by the
220 // remote address.
221 typedef std::map<rtc::SocketAddress, Connection*> AddressMap;
222 const AddressMap& connections() { return connections_; }
223
224 // Returns the connection to the given address or NULL if none exists.
225 virtual Connection* GetConnection(
226 const rtc::SocketAddress& remote_addr);
227
228 // Called each time a connection is created.
229 sigslot::signal2<Port*, Connection*> SignalConnectionCreated;
230
231 // In a shared socket mode each port which shares the socket will decide
232 // to accept the packet based on the |remote_addr|. Currently only UDP
233 // port implemented this method.
234 // TODO(mallinath) - Make it pure virtual.
235 virtual bool HandleIncomingPacket(
236 rtc::AsyncPacketSocket* socket, const char* data, size_t size,
237 const rtc::SocketAddress& remote_addr,
238 const rtc::PacketTime& packet_time) {
239 ASSERT(false);
240 return false;
241 }
242
243 // Sends a response message (normal or error) to the given request. One of
244 // these methods should be called as a response to SignalUnknownAddress.
245 // NOTE: You MUST call CreateConnection BEFORE SendBindingResponse.
246 virtual void SendBindingResponse(StunMessage* request,
247 const rtc::SocketAddress& addr);
248 virtual void SendBindingErrorResponse(
249 StunMessage* request, const rtc::SocketAddress& addr,
250 int error_code, const std::string& reason);
251
252 void set_proxy(const std::string& user_agent,
253 const rtc::ProxyInfo& proxy) {
254 user_agent_ = user_agent;
255 proxy_ = proxy;
256 }
257 const std::string& user_agent() { return user_agent_; }
258 const rtc::ProxyInfo& proxy() { return proxy_; }
259
260 virtual void EnablePortPackets();
261
262 // Called if the port has no connections and is no longer useful.
263 void Destroy();
264
265 virtual void OnMessage(rtc::Message *pmsg);
266
267 // Debugging description of this port
268 virtual std::string ToString() const;
pthatcher@webrtc.org0ba15332015-01-10 00:47:02 +0000269 const rtc::IPAddress& ip() const { return ip_; }
Peter Boström0c4e06b2015-10-07 12:23:21 +0200270 uint16_t min_port() { return min_port_; }
271 uint16_t max_port() { return max_port_; }
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000272
273 // Timeout shortening function to speed up unit tests.
274 void set_timeout_delay(int delay) { timeout_delay_ = delay; }
275
276 // This method will return local and remote username fragements from the
277 // stun username attribute if present.
278 bool ParseStunUsername(const StunMessage* stun_msg,
279 std::string* local_username,
Peter Thatcher7cbd1882015-09-17 18:54:52 -0700280 std::string* remote_username) const;
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000281 void CreateStunUsername(const std::string& remote_username,
282 std::string* stun_username_attr_str) const;
283
284 bool MaybeIceRoleConflict(const rtc::SocketAddress& addr,
285 IceMessage* stun_msg,
286 const std::string& remote_ufrag);
287
stefanc1aeaf02015-10-15 07:26:07 -0700288 // Called when a packet has been sent to the socket.
Stefan Holmer55674ff2016-01-14 15:49:16 +0100289 // This is made pure virtual to notify subclasses of Port that they MUST
290 // listen to AsyncPacketSocket::SignalSentPacket and then call
291 // PortInterface::OnSentPacket.
292 virtual void OnSentPacket(rtc::AsyncPacketSocket* socket,
293 const rtc::SentPacket& sent_packet) = 0;
stefanc1aeaf02015-10-15 07:26:07 -0700294
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000295 // Called when the socket is currently able to send.
296 void OnReadyToSend();
297
298 // Called when the Connection discovers a local peer reflexive candidate.
299 // Returns the index of the new local candidate.
300 size_t AddPrflxCandidate(const Candidate& local);
301
honghaiza0c44ea2016-03-23 16:07:48 -0700302 int16_t network_cost() const { return network_cost_; }
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000303
304 protected:
Honghai Zhanga74363c2016-07-28 18:06:15 -0700305 enum { MSG_DESTROY_IF_DEAD = 0, MSG_FIRST_AVAILABLE };
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000306
Honghai Zhang351d77b2016-05-20 15:08:29 -0700307 virtual void UpdateNetworkCost();
308
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000309 void set_type(const std::string& type) { type_ = type; }
310
311 void AddAddress(const rtc::SocketAddress& address,
312 const rtc::SocketAddress& base_address,
313 const rtc::SocketAddress& related_address,
Guo-wei Shieh3d564c12015-08-19 16:51:15 -0700314 const std::string& protocol,
315 const std::string& relay_protocol,
316 const std::string& tcptype,
317 const std::string& type,
Peter Boström0c4e06b2015-10-07 12:23:21 +0200318 uint32_t type_preference,
319 uint32_t relay_preference,
Guo-wei Shieh3d564c12015-08-19 16:51:15 -0700320 bool final);
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000321
honghaiz36f50e82016-06-01 15:57:03 -0700322 // Adds the given connection to the map keyed by the remote candidate address.
323 // If an existing connection has the same address, the existing one will be
324 // replaced and destroyed.
325 void AddOrReplaceConnection(Connection* conn);
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000326
327 // Called when a packet is received from an unknown address that is not
328 // currently a connection. If this is an authenticated STUN binding request,
329 // then we will signal the client.
330 void OnReadPacket(const char* data, size_t size,
331 const rtc::SocketAddress& addr,
332 ProtocolType proto);
333
334 // If the given data comprises a complete and correct STUN message then the
335 // return value is true, otherwise false. If the message username corresponds
336 // with this port's username fragment, msg will contain the parsed STUN
337 // message. Otherwise, the function may send a STUN response internally.
338 // remote_username contains the remote fragment of the STUN username.
kwiberg6baec032016-03-15 11:09:39 -0700339 bool GetStunMessage(const char* data,
340 size_t size,
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000341 const rtc::SocketAddress& addr,
kwiberg3ec46792016-04-27 07:22:53 -0700342 std::unique_ptr<IceMessage>* out_msg,
kwiberg6baec032016-03-15 11:09:39 -0700343 std::string* out_username);
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000344
345 // Checks if the address in addr is compatible with the port's ip.
346 bool IsCompatibleAddress(const rtc::SocketAddress& addr);
347
348 // Returns default DSCP value.
349 rtc::DiffServCodePoint DefaultDscpValue() const {
350 // No change from what MediaChannel set.
351 return rtc::DSCP_NO_CHANGE;
352 }
353
honghaiz36f50e82016-06-01 15:57:03 -0700354 // Extra work to be done in subclasses when a connection is destroyed.
355 virtual void HandleConnectionDestroyed(Connection* conn) {}
356
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000357 private:
358 void Construct();
359 // Called when one of our connections deletes itself.
360 void OnConnectionDestroyed(Connection* conn);
361
Honghai Zhang351d77b2016-05-20 15:08:29 -0700362 void OnNetworkTypeChanged(const rtc::Network* network);
363
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000364 rtc::Thread* thread_;
365 rtc::PacketSocketFactory* factory_;
366 std::string type_;
367 bool send_retransmit_count_attribute_;
368 rtc::Network* network_;
369 rtc::IPAddress ip_;
Peter Boström0c4e06b2015-10-07 12:23:21 +0200370 uint16_t min_port_;
371 uint16_t max_port_;
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000372 std::string content_name_;
373 int component_;
Peter Boström0c4e06b2015-10-07 12:23:21 +0200374 uint32_t generation_;
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000375 // In order to establish a connection to this Port (so that real data can be
376 // sent through), the other side must send us a STUN binding request that is
377 // authenticated with this username_fragment and password.
378 // PortAllocatorSession will provide these username_fragment and password.
379 //
380 // Note: we should always use username_fragment() instead of using
381 // |ice_username_fragment_| directly. For the details see the comment on
382 // username_fragment().
383 std::string ice_username_fragment_;
384 std::string password_;
385 std::vector<Candidate> candidates_;
386 AddressMap connections_;
387 int timeout_delay_;
388 bool enable_port_packets_;
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000389 IceRole ice_role_;
Peter Boström0c4e06b2015-10-07 12:23:21 +0200390 uint64_t tiebreaker_;
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000391 bool shared_socket_;
392 // Information to use when going through a proxy.
393 std::string user_agent_;
394 rtc::ProxyInfo proxy_;
395
honghaize1a0c942016-02-16 14:54:56 -0800396 // A virtual cost perceived by the user, usually based on the network type
397 // (WiFi. vs. Cellular). It takes precedence over the priority when
398 // comparing two connections.
honghaiza0c44ea2016-03-23 16:07:48 -0700399 uint16_t network_cost_;
Honghai Zhanga74363c2016-07-28 18:06:15 -0700400 State state_ = State::INIT;
Honghai Zhangb5db1ec2016-07-28 13:23:05 -0700401 int64_t last_time_all_connections_removed_ = 0;
honghaize1a0c942016-02-16 14:54:56 -0800402
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000403 friend class Connection;
404};
405
406// Represents a communication link between a port on the local client and a
407// port on the remote client.
Honghai Zhangcc411c02016-03-29 17:27:21 -0700408class Connection : public CandidatePairInterface,
409 public rtc::MessageHandler,
410 public sigslot::has_slots<> {
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000411 public:
Peter Thatcher1cf6f812015-05-15 10:40:45 -0700412 struct SentPing {
Honghai Zhang8cd8f812016-08-03 19:50:41 -0700413 SentPing(const std::string id, int64_t sent_time, uint32_t nomination)
414 : id(id), sent_time(sent_time), nomination(nomination) {}
Peter Thatcher1cf6f812015-05-15 10:40:45 -0700415
416 std::string id;
honghaiz34b11eb2016-03-16 08:55:44 -0700417 int64_t sent_time;
Honghai Zhang8cd8f812016-08-03 19:50:41 -0700418 uint32_t nomination;
Peter Thatcher1cf6f812015-05-15 10:40:45 -0700419 };
420
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000421 // States are from RFC 5245. http://tools.ietf.org/html/rfc5245#section-5.7.4
422 enum State {
423 STATE_WAITING = 0, // Check has not been performed, Waiting pair on CL.
424 STATE_INPROGRESS, // Check has been sent, transaction is in progress.
425 STATE_SUCCEEDED, // Check already done, produced a successful result.
426 STATE_FAILED // Check for this connection failed.
427 };
428
429 virtual ~Connection();
430
431 // The local port where this connection sends and receives packets.
432 Port* port() { return port_; }
433 const Port* port() const { return port_; }
434
Honghai Zhangcc411c02016-03-29 17:27:21 -0700435 // Implementation of virtual methods in CandidatePairInterface.
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000436 // Returns the description of the local port
437 virtual const Candidate& local_candidate() const;
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000438 // Returns the description of the remote port to which we communicate.
Honghai Zhangcc411c02016-03-29 17:27:21 -0700439 virtual const Candidate& remote_candidate() const;
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000440
441 // Returns the pair priority.
Peter Boström0c4e06b2015-10-07 12:23:21 +0200442 uint64_t priority() const;
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000443
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000444 enum WriteState {
445 STATE_WRITABLE = 0, // we have received ping responses recently
446 STATE_WRITE_UNRELIABLE = 1, // we have had a few ping failures
447 STATE_WRITE_INIT = 2, // we have yet to receive a ping response
448 STATE_WRITE_TIMEOUT = 3, // we have had a large number of ping failures
449 };
450
451 WriteState write_state() const { return write_state_; }
452 bool writable() const { return write_state_ == STATE_WRITABLE; }
Peter Thatcher04ac81f2015-09-21 11:48:28 -0700453 bool receiving() const { return receiving_; }
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000454
455 // Determines whether the connection has finished connecting. This can only
456 // be false for TCP connections.
457 bool connected() const { return connected_; }
Honghai Zhang2b342bf2015-09-30 09:51:58 -0700458 bool weak() const { return !(writable() && receiving() && connected()); }
459 bool active() const {
Honghai Zhang2b342bf2015-09-30 09:51:58 -0700460 return write_state_ != STATE_WRITE_TIMEOUT;
461 }
honghaiz059e1832016-06-24 11:03:55 -0700462
Honghai Zhang2b342bf2015-09-30 09:51:58 -0700463 // A connection is dead if it can be safely deleted.
honghaiz34b11eb2016-03-16 08:55:44 -0700464 bool dead(int64_t now) const;
honghaiz89374372015-09-24 13:14:47 -0700465
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000466 // Estimate of the round-trip time over this connection.
honghaiz34b11eb2016-03-16 08:55:44 -0700467 int rtt() const { return rtt_; }
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000468
zhihuang5ecf16c2016-06-01 17:09:15 -0700469 ConnectionInfo stats();
470
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000471 sigslot::signal1<Connection*> SignalStateChange;
472
473 // Sent when the connection has decided that it is no longer of value. It
474 // will delete itself immediately after this call.
475 sigslot::signal1<Connection*> SignalDestroyed;
476
477 // The connection can send and receive packets asynchronously. This matches
478 // the interface of AsyncPacketSocket, which may use UDP or TCP under the
479 // covers.
480 virtual int Send(const void* data, size_t size,
481 const rtc::PacketOptions& options) = 0;
482
483 // Error if Send() returns < 0
484 virtual int GetError() = 0;
485
Peter Thatcher04ac81f2015-09-21 11:48:28 -0700486 sigslot::signal4<Connection*, const char*, size_t, const rtc::PacketTime&>
487 SignalReadPacket;
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000488
489 sigslot::signal1<Connection*> SignalReadyToSend;
490
491 // Called when a packet is received on this connection.
492 void OnReadPacket(const char* data, size_t size,
493 const rtc::PacketTime& packet_time);
494
495 // Called when the socket is currently able to send.
496 void OnReadyToSend();
497
498 // Called when a connection is determined to be no longer useful to us. We
499 // still keep it around in case the other side wants to use it. But we can
500 // safely stop pinging on it and we can allow it to time out if the other
501 // side stops using it as well.
502 bool pruned() const { return pruned_; }
503 void Prune();
504
505 bool use_candidate_attr() const { return use_candidate_attr_; }
506 void set_use_candidate_attr(bool enable);
507
Honghai Zhang8cd8f812016-08-03 19:50:41 -0700508 void set_nomination(uint32_t value) { nomination_ = value; }
509
510 uint32_t remote_nomination() const { return remote_nomination_; }
511 bool nominated() const { return remote_nomination_ > 0; }
512 // Public for unit tests.
513 void set_remote_nomination(uint32_t remote_nomination) {
514 remote_nomination_ = remote_nomination;
515 }
516 // Public for unit tests.
517 uint32_t acked_nomination() const { return acked_nomination_; }
honghaiz5a3acd82015-08-20 15:53:17 -0700518
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000519 void set_remote_ice_mode(IceMode mode) {
520 remote_ice_mode_ = mode;
521 }
522
bertholdherrmann0812030662016-10-18 14:00:02 -0700523 void set_receiving_timeout(int receiving_timeout_ms) {
Peter Thatcher04ac81f2015-09-21 11:48:28 -0700524 receiving_timeout_ = receiving_timeout_ms;
525 }
526
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000527 // Makes the connection go away.
528 void Destroy();
529
deadbeef376e1232015-11-25 09:00:08 -0800530 // Makes the connection go away, in a failed state.
531 void FailAndDestroy();
532
honghaiz079a7a12016-06-22 16:26:29 -0700533 // Prunes the connection and sets its state to STATE_FAILED,
534 // It will not be used or send pings although it can still receive packets.
535 void FailAndPrune();
536
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000537 // Checks that the state of this connection is up-to-date. The argument is
538 // the current time, which is compared against various timeouts.
honghaiz34b11eb2016-03-16 08:55:44 -0700539 void UpdateState(int64_t now);
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000540
541 // Called when this connection should try checking writability again.
honghaiz34b11eb2016-03-16 08:55:44 -0700542 int64_t last_ping_sent() const { return last_ping_sent_; }
543 void Ping(int64_t now);
Honghai Zhang8cd8f812016-08-03 19:50:41 -0700544 void ReceivedPingResponse(int rtt, const std::string& request_id);
honghaiz34b11eb2016-03-16 08:55:44 -0700545 int64_t last_ping_response_received() const {
Honghai Zhang381b4212015-12-04 12:24:03 -0800546 return last_ping_response_received_;
547 }
Honghai Zhangfd16da22016-08-17 16:12:46 -0700548 // Used to check if any STUN ping response has been received.
549 int rtt_samples() const { return rtt_samples_; }
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000550
551 // Called whenever a valid ping is received on this connection. This is
552 // public because the connection intercepts the first ping for us.
honghaiz34b11eb2016-03-16 08:55:44 -0700553 int64_t last_ping_received() const { return last_ping_received_; }
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000554 void ReceivedPing();
honghaiz9b5ee9c2015-11-11 13:19:17 -0800555 // Handles the binding request; sends a response if this is a valid request.
556 void HandleBindingRequest(IceMessage* msg);
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000557
Honghai Zhang572b0942016-06-23 12:26:57 -0700558 int64_t last_data_received() const { return last_data_received_; }
559
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000560 // Debugging description of this connection
guoweis@webrtc.org8c9ff202014-12-04 07:56:02 +0000561 std::string ToDebugId() const;
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000562 std::string ToString() const;
563 std::string ToSensitiveString() const;
Peter Thatcher1cf6f812015-05-15 10:40:45 -0700564 // Prints pings_since_last_response_ into a string.
565 void PrintPingsSinceLastResponse(std::string* pings, size_t max);
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000566
567 bool reported() const { return reported_; }
568 void set_reported(bool reported) { reported_ = reported;}
569
honghaiz5a3acd82015-08-20 15:53:17 -0700570 // This signal will be fired if this connection is nominated by the
571 // controlling side.
572 sigslot::signal1<Connection*> SignalNominated;
Peter Thatcher54360512015-07-08 11:08:35 -0700573
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000574 // Invoked when Connection receives STUN error response with 487 code.
575 void HandleRoleConflictFromPeer();
576
577 State state() const { return state_; }
578
honghaiz524ecc22016-05-25 12:48:31 -0700579 int num_pings_sent() const { return num_pings_sent_; }
580
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000581 IceMode remote_ice_mode() const { return remote_ice_mode_; }
582
honghaize1a0c942016-02-16 14:54:56 -0800583 uint32_t ComputeNetworkCost() const;
584
Honghai Zhang4cedf2b2016-08-31 08:18:11 -0700585 // Update the ICE password and/or generation of the remote candidate if the
586 // ufrag in |params| matches the candidate's ufrag, and the
Taylor Brandstetter0a1bc532016-04-19 18:03:26 -0700587 // candidate's password and/or ufrag has not been set.
Honghai Zhang4cedf2b2016-08-31 08:18:11 -0700588 void MaybeSetRemoteIceParametersAndGeneration(const IceParameters& params,
589 int generation);
jiayl@webrtc.orgdacdd942015-01-23 17:33:34 +0000590
591 // If |remote_candidate_| is peer reflexive and is equivalent to
592 // |new_candidate| except the type, update |remote_candidate_| to
593 // |new_candidate|.
594 void MaybeUpdatePeerReflexiveCandidate(const Candidate& new_candidate);
595
Peter Thatcher54360512015-07-08 11:08:35 -0700596 // Returns the last received time of any data, stun request, or stun
597 // response in milliseconds
honghaiz34b11eb2016-03-16 08:55:44 -0700598 int64_t last_received() const;
honghaiz9ad0db52016-07-14 19:30:28 -0700599 // Returns the last time when the connection changed its receiving state.
600 int64_t receiving_unchanged_since() const {
601 return receiving_unchanged_since_;
602 }
Peter Thatcher54360512015-07-08 11:08:35 -0700603
Taylor Brandstetterb825aee2016-06-29 13:07:16 -0700604 bool stable(int64_t now) const;
zhihuang435264a2016-06-21 11:28:38 -0700605
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000606 protected:
Guo-wei Shiehbe508a12015-04-06 12:48:47 -0700607 enum { MSG_DELETE = 0, MSG_FIRST_AVAILABLE };
608
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000609 // Constructs a new connection to the given remote port.
610 Connection(Port* port, size_t index, const Candidate& candidate);
611
612 // Called back when StunRequestManager has a stun packet to send
613 void OnSendStunPacket(const void* data, size_t size, StunRequest* req);
614
615 // Callbacks from ConnectionRequest
Guo-wei Shiehbe508a12015-04-06 12:48:47 -0700616 virtual void OnConnectionRequestResponse(ConnectionRequest* req,
617 StunMessage* response);
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000618 void OnConnectionRequestErrorResponse(ConnectionRequest* req,
619 StunMessage* response);
620 void OnConnectionRequestTimeout(ConnectionRequest* req);
Peter Thatcher1cf6f812015-05-15 10:40:45 -0700621 void OnConnectionRequestSent(ConnectionRequest* req);
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000622
Taylor Brandstetterb825aee2016-06-29 13:07:16 -0700623 bool rtt_converged() const;
zhihuang435264a2016-06-21 11:28:38 -0700624
625 // If the response is not received within 2 * RTT, the response is assumed to
626 // be missing.
Taylor Brandstetterb825aee2016-06-29 13:07:16 -0700627 bool missing_responses(int64_t now) const;
zhihuang435264a2016-06-21 11:28:38 -0700628
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000629 // Changes the state and signals if necessary.
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000630 void set_write_state(WriteState value);
honghaiz9ad0db52016-07-14 19:30:28 -0700631 void UpdateReceiving(int64_t now);
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000632 void set_state(State state);
633 void set_connected(bool value);
634
Honghai Zhang8cd8f812016-08-03 19:50:41 -0700635 uint32_t nomination() const { return nomination_; }
636
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000637 void OnMessage(rtc::Message *pmsg);
638
639 Port* port_;
640 size_t local_candidate_index_;
641 Candidate remote_candidate_;
Honghai Zhang8cd8f812016-08-03 19:50:41 -0700642
643 ConnectionInfo stats_;
644 rtc::RateTracker recv_rate_tracker_;
645 rtc::RateTracker send_rate_tracker_;
646
647 private:
Taylor Brandstetter62351c92016-08-11 16:05:07 -0700648 // Update the local candidate based on the mapped address attribute.
649 // If the local candidate changed, fires SignalStateChange.
650 void MaybeUpdateLocalCandidate(ConnectionRequest* request,
651 StunMessage* response);
652
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000653 WriteState write_state_;
Peter Thatcher04ac81f2015-09-21 11:48:28 -0700654 bool receiving_;
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000655 bool connected_;
656 bool pruned_;
657 // By default |use_candidate_attr_| flag will be true,
honghaiz5a3acd82015-08-20 15:53:17 -0700658 // as we will be using aggressive nomination.
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000659 // But when peer is ice-lite, this flag "must" be initialized to false and
660 // turn on when connection becomes "best connection".
661 bool use_candidate_attr_;
Honghai Zhang8cd8f812016-08-03 19:50:41 -0700662 // Used by the controlling side to indicate that this connection will be
663 // selected for transmission if the peer supports ICE-renomination when this
664 // value is positive. A larger-value indicates that a connection is nominated
665 // later and should be selected by the controlled side with higher precedence.
666 // A zero-value indicates not nominating this connection.
667 uint32_t nomination_ = 0;
668 // The last nomination that has been acknowledged.
669 uint32_t acked_nomination_ = 0;
670 // Used by the controlled side to remember the nomination value received from
671 // the controlling side. When the peer does not support ICE re-nomination,
672 // its value will be 1 if the connection has been nominated.
673 uint32_t remote_nomination_ = 0;
674
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000675 IceMode remote_ice_mode_;
676 StunRequestManager requests_;
honghaiz34b11eb2016-03-16 08:55:44 -0700677 int rtt_;
zhihuang435264a2016-06-21 11:28:38 -0700678 int rtt_samples_ = 0;
honghaiz34b11eb2016-03-16 08:55:44 -0700679 int64_t last_ping_sent_; // last time we sent a ping to the other side
680 int64_t last_ping_received_; // last time we received a ping from the other
681 // side
682 int64_t last_data_received_;
683 int64_t last_ping_response_received_;
honghaiz9ad0db52016-07-14 19:30:28 -0700684 int64_t receiving_unchanged_since_ = 0;
Peter Thatcher1cf6f812015-05-15 10:40:45 -0700685 std::vector<SentPing> pings_since_last_response_;
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000686
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000687 bool reported_;
688 State state_;
Peter Thatcher04ac81f2015-09-21 11:48:28 -0700689 // Time duration to switch from receiving to not receiving.
honghaiz34b11eb2016-03-16 08:55:44 -0700690 int receiving_timeout_;
691 int64_t time_created_ms_;
honghaiz524ecc22016-05-25 12:48:31 -0700692 int num_pings_sent_ = 0;
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000693
694 friend class Port;
695 friend class ConnectionRequest;
696};
697
deadbeef376e1232015-11-25 09:00:08 -0800698// ProxyConnection defers all the interesting work to the port.
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000699class ProxyConnection : public Connection {
700 public:
deadbeef376e1232015-11-25 09:00:08 -0800701 ProxyConnection(Port* port, size_t index, const Candidate& remote_candidate);
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000702
deadbeef376e1232015-11-25 09:00:08 -0800703 int Send(const void* data,
704 size_t size,
705 const rtc::PacketOptions& options) override;
706 int GetError() override { return error_; }
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000707
708 private:
deadbeef376e1232015-11-25 09:00:08 -0800709 int error_ = 0;
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000710};
711
712} // namespace cricket
713
714#endif // WEBRTC_P2P_BASE_PORT_H_