blob: 6b1a551963d06a375f5368218d1b200f4d1d9fec [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[];
hnslb68cc752016-12-13 10:33:41 -080048extern const char TLS_PROTOCOL_NAME[];
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +000049
50// RFC 6544, TCP candidate encoding rules.
51extern const int DISCARD_PORT;
52extern const char TCPTYPE_ACTIVE_STR[];
53extern const char TCPTYPE_PASSIVE_STR[];
54extern const char TCPTYPE_SIMOPEN_STR[];
55
Honghai Zhang2b342bf2015-09-30 09:51:58 -070056// The minimum time we will wait before destroying a connection after creating
57// it.
honghaiz34b11eb2016-03-16 08:55:44 -070058static const int MIN_CONNECTION_LIFETIME = 10 * 1000; // 10 seconds.
Peter Thatcher04ac81f2015-09-21 11:48:28 -070059
Honghai Zhang2cd7afe2015-11-12 11:14:33 -080060// A connection will be declared dead if it has not received anything for this
61// long.
honghaiz34b11eb2016-03-16 08:55:44 -070062static const int DEAD_CONNECTION_RECEIVE_TIMEOUT = 30 * 1000; // 30 seconds.
Honghai Zhang2cd7afe2015-11-12 11:14:33 -080063
Peter Thatcher04ac81f2015-09-21 11:48:28 -070064// The timeout duration when a connection does not receive anything.
honghaiz34b11eb2016-03-16 08:55:44 -070065static const int WEAK_CONNECTION_RECEIVE_TIMEOUT = 2500; // 2.5 seconds
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +000066
67// The length of time we wait before timing out writability on a connection.
honghaiz34b11eb2016-03-16 08:55:44 -070068static const int CONNECTION_WRITE_TIMEOUT = 15 * 1000; // 15 seconds
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +000069
70// The length of time we wait before we become unwritable.
honghaiz34b11eb2016-03-16 08:55:44 -070071static const int CONNECTION_WRITE_CONNECT_TIMEOUT = 5 * 1000; // 5 seconds
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +000072
73// This is the length of time that we wait for a ping response to come back.
honghaiz34b11eb2016-03-16 08:55:44 -070074static const int CONNECTION_RESPONSE_TIMEOUT = 5 * 1000; // 5 seconds
75
76// The number of pings that must fail to respond before we become unwritable.
77static const uint32_t CONNECTION_WRITE_CONNECT_FAILURES = 5;
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +000078
79enum RelayType {
80 RELAY_GTURN, // Legacy google relay service.
81 RELAY_TURN // Standard (TURN) relay service.
82};
83
84enum IcePriorityValue {
hnsl277b2502016-12-13 05:17:23 -080085 ICE_TYPE_PREFERENCE_RELAY_TLS = 0,
86 ICE_TYPE_PREFERENCE_RELAY_TCP = 1,
87 ICE_TYPE_PREFERENCE_RELAY_UDP = 2,
Taylor Brandstetter62351c92016-08-11 16:05:07 -070088 ICE_TYPE_PREFERENCE_PRFLX_TCP = 80,
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +000089 ICE_TYPE_PREFERENCE_HOST_TCP = 90,
90 ICE_TYPE_PREFERENCE_SRFLX = 100,
91 ICE_TYPE_PREFERENCE_PRFLX = 110,
92 ICE_TYPE_PREFERENCE_HOST = 126
93};
94
95const char* ProtoToString(ProtocolType proto);
96bool StringToProto(const char* value, ProtocolType* proto);
97
98struct ProtocolAddress {
99 rtc::SocketAddress address;
100 ProtocolType proto;
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000101
102 ProtocolAddress(const rtc::SocketAddress& a, ProtocolType p)
hnsl277b2502016-12-13 05:17:23 -0800103 : address(a), proto(p) {}
Taylor Brandstettera1c30352016-05-13 08:15:11 -0700104
105 bool operator==(const ProtocolAddress& o) const {
hnsl277b2502016-12-13 05:17:23 -0800106 return address == o.address && proto == o.proto;
Taylor Brandstettera1c30352016-05-13 08:15:11 -0700107 }
108 bool operator!=(const ProtocolAddress& o) const { return !(*this == o); }
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000109};
110
111typedef std::set<rtc::SocketAddress> ServerAddresses;
112
113// Represents a local communication mechanism that can be used to create
114// connections to similar mechanisms of the other client. Subclasses of this
115// one add support for specific mechanisms like local UDP ports.
116class Port : public PortInterface, public rtc::MessageHandler,
117 public sigslot::has_slots<> {
118 public:
Honghai Zhanga74363c2016-07-28 18:06:15 -0700119 // INIT: The state when a port is just created.
120 // KEEP_ALIVE_UNTIL_PRUNED: A port should not be destroyed even if no
121 // connection is using it.
122 // PRUNED: It will be destroyed if no connection is using it for a period of
123 // 30 seconds.
124 enum class State { INIT, KEEP_ALIVE_UNTIL_PRUNED, PRUNED };
pkasting@chromium.org332331f2014-11-06 20:19:22 +0000125 Port(rtc::Thread* thread,
Honghai Zhangd00c0572016-06-28 09:44:47 -0700126 const std::string& type,
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000127 rtc::PacketSocketFactory* factory,
pkasting@chromium.org332331f2014-11-06 20:19:22 +0000128 rtc::Network* network,
129 const rtc::IPAddress& ip,
130 const std::string& username_fragment,
131 const std::string& password);
132 Port(rtc::Thread* thread,
133 const std::string& type,
134 rtc::PacketSocketFactory* factory,
135 rtc::Network* network,
136 const rtc::IPAddress& ip,
Peter Boström0c4e06b2015-10-07 12:23:21 +0200137 uint16_t min_port,
138 uint16_t max_port,
pkasting@chromium.org332331f2014-11-06 20:19:22 +0000139 const std::string& username_fragment,
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000140 const std::string& password);
141 virtual ~Port();
142
143 virtual const std::string& Type() const { return type_; }
144 virtual rtc::Network* Network() const { return network_; }
145
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000146 // Methods to set/get ICE role and tiebreaker values.
147 IceRole GetIceRole() const { return ice_role_; }
148 void SetIceRole(IceRole role) { ice_role_ = role; }
149
Peter Boström0c4e06b2015-10-07 12:23:21 +0200150 void SetIceTiebreaker(uint64_t tiebreaker) { tiebreaker_ = tiebreaker; }
151 uint64_t IceTiebreaker() const { return tiebreaker_; }
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000152
153 virtual bool SharedSocket() const { return shared_socket_; }
154 void ResetSharedSocket() { shared_socket_ = false; }
155
Honghai Zhanga74363c2016-07-28 18:06:15 -0700156 // Should not destroy the port even if no connection is using it. Called when
157 // a port is ready to use.
158 void KeepAliveUntilPruned();
159 // Allows a port to be destroyed if no connection is using it.
160 void Prune();
161
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000162 // The thread on which this port performs its I/O.
163 rtc::Thread* thread() { return thread_; }
164
165 // The factory used to create the sockets of this port.
166 rtc::PacketSocketFactory* socket_factory() const { return factory_; }
167 void set_socket_factory(rtc::PacketSocketFactory* factory) {
168 factory_ = factory;
169 }
170
171 // For debugging purposes.
172 const std::string& content_name() const { return content_name_; }
173 void set_content_name(const std::string& content_name) {
174 content_name_ = content_name;
175 }
176
177 int component() const { return component_; }
178 void set_component(int component) { component_ = component; }
179
180 bool send_retransmit_count_attribute() const {
181 return send_retransmit_count_attribute_;
182 }
183 void set_send_retransmit_count_attribute(bool enable) {
184 send_retransmit_count_attribute_ = enable;
185 }
186
187 // Identifies the generation that this port was created in.
deadbeef14f97f52016-06-22 17:14:15 -0700188 uint32_t generation() const { return generation_; }
Peter Boström0c4e06b2015-10-07 12:23:21 +0200189 void set_generation(uint32_t generation) { generation_ = generation; }
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000190
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000191 const std::string username_fragment() const;
192 const std::string& password() const { return password_; }
193
Taylor Brandstettera1c30352016-05-13 08:15:11 -0700194 // May be called when this port was initially created by a pooled
195 // PortAllocatorSession, and is now being assigned to an ICE transport.
196 // Updates the information for candidates as well.
197 void SetIceParameters(int component,
198 const std::string& username_fragment,
199 const std::string& password);
200
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000201 // Fired when candidates are discovered by the port. When all candidates
202 // are discovered that belong to port SignalAddressReady is fired.
203 sigslot::signal2<Port*, const Candidate&> SignalCandidateReady;
204
205 // Provides all of the above information in one handy object.
206 virtual const std::vector<Candidate>& Candidates() const {
207 return candidates_;
208 }
209
210 // SignalPortComplete is sent when port completes the task of candidates
211 // allocation.
212 sigslot::signal1<Port*> SignalPortComplete;
213 // This signal sent when port fails to allocate candidates and this port
214 // can't be used in establishing the connections. When port is in shared mode
215 // and port fails to allocate one of the candidates, port shouldn't send
216 // this signal as other candidates might be usefull in establishing the
217 // connection.
218 sigslot::signal1<Port*> SignalPortError;
219
220 // Returns a map containing all of the connections of this port, keyed by the
221 // remote address.
222 typedef std::map<rtc::SocketAddress, Connection*> AddressMap;
223 const AddressMap& connections() { return connections_; }
224
225 // Returns the connection to the given address or NULL if none exists.
226 virtual Connection* GetConnection(
227 const rtc::SocketAddress& remote_addr);
228
229 // Called each time a connection is created.
230 sigslot::signal2<Port*, Connection*> SignalConnectionCreated;
231
232 // In a shared socket mode each port which shares the socket will decide
233 // to accept the packet based on the |remote_addr|. Currently only UDP
234 // port implemented this method.
235 // TODO(mallinath) - Make it pure virtual.
236 virtual bool HandleIncomingPacket(
237 rtc::AsyncPacketSocket* socket, const char* data, size_t size,
238 const rtc::SocketAddress& remote_addr,
239 const rtc::PacketTime& packet_time) {
240 ASSERT(false);
241 return false;
242 }
243
244 // Sends a response message (normal or error) to the given request. One of
245 // these methods should be called as a response to SignalUnknownAddress.
246 // NOTE: You MUST call CreateConnection BEFORE SendBindingResponse.
247 virtual void SendBindingResponse(StunMessage* request,
248 const rtc::SocketAddress& addr);
249 virtual void SendBindingErrorResponse(
250 StunMessage* request, const rtc::SocketAddress& addr,
251 int error_code, const std::string& reason);
252
253 void set_proxy(const std::string& user_agent,
254 const rtc::ProxyInfo& proxy) {
255 user_agent_ = user_agent;
256 proxy_ = proxy;
257 }
258 const std::string& user_agent() { return user_agent_; }
259 const rtc::ProxyInfo& proxy() { return proxy_; }
260
261 virtual void EnablePortPackets();
262
263 // Called if the port has no connections and is no longer useful.
264 void Destroy();
265
266 virtual void OnMessage(rtc::Message *pmsg);
267
268 // Debugging description of this port
269 virtual std::string ToString() const;
pthatcher@webrtc.org0ba15332015-01-10 00:47:02 +0000270 const rtc::IPAddress& ip() const { return ip_; }
Peter Boström0c4e06b2015-10-07 12:23:21 +0200271 uint16_t min_port() { return min_port_; }
272 uint16_t max_port() { return max_port_; }
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000273
274 // Timeout shortening function to speed up unit tests.
275 void set_timeout_delay(int delay) { timeout_delay_ = delay; }
276
277 // This method will return local and remote username fragements from the
278 // stun username attribute if present.
279 bool ParseStunUsername(const StunMessage* stun_msg,
280 std::string* local_username,
Peter Thatcher7cbd1882015-09-17 18:54:52 -0700281 std::string* remote_username) const;
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000282 void CreateStunUsername(const std::string& remote_username,
283 std::string* stun_username_attr_str) const;
284
285 bool MaybeIceRoleConflict(const rtc::SocketAddress& addr,
286 IceMessage* stun_msg,
287 const std::string& remote_ufrag);
288
stefanc1aeaf02015-10-15 07:26:07 -0700289 // Called when a packet has been sent to the socket.
Stefan Holmer55674ff2016-01-14 15:49:16 +0100290 // This is made pure virtual to notify subclasses of Port that they MUST
291 // listen to AsyncPacketSocket::SignalSentPacket and then call
292 // PortInterface::OnSentPacket.
293 virtual void OnSentPacket(rtc::AsyncPacketSocket* socket,
294 const rtc::SentPacket& sent_packet) = 0;
stefanc1aeaf02015-10-15 07:26:07 -0700295
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000296 // Called when the socket is currently able to send.
297 void OnReadyToSend();
298
299 // Called when the Connection discovers a local peer reflexive candidate.
300 // Returns the index of the new local candidate.
301 size_t AddPrflxCandidate(const Candidate& local);
302
honghaiza0c44ea2016-03-23 16:07:48 -0700303 int16_t network_cost() const { return network_cost_; }
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000304
305 protected:
Honghai Zhanga74363c2016-07-28 18:06:15 -0700306 enum { MSG_DESTROY_IF_DEAD = 0, MSG_FIRST_AVAILABLE };
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000307
Honghai Zhang351d77b2016-05-20 15:08:29 -0700308 virtual void UpdateNetworkCost();
309
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000310 void set_type(const std::string& type) { type_ = type; }
311
312 void AddAddress(const rtc::SocketAddress& address,
313 const rtc::SocketAddress& base_address,
314 const rtc::SocketAddress& related_address,
Guo-wei Shieh3d564c12015-08-19 16:51:15 -0700315 const std::string& protocol,
316 const std::string& relay_protocol,
317 const std::string& tcptype,
318 const std::string& type,
Peter Boström0c4e06b2015-10-07 12:23:21 +0200319 uint32_t type_preference,
320 uint32_t relay_preference,
Guo-wei Shieh3d564c12015-08-19 16:51:15 -0700321 bool final);
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000322
honghaiz36f50e82016-06-01 15:57:03 -0700323 // Adds the given connection to the map keyed by the remote candidate address.
324 // If an existing connection has the same address, the existing one will be
325 // replaced and destroyed.
326 void AddOrReplaceConnection(Connection* conn);
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000327
328 // Called when a packet is received from an unknown address that is not
329 // currently a connection. If this is an authenticated STUN binding request,
330 // then we will signal the client.
331 void OnReadPacket(const char* data, size_t size,
332 const rtc::SocketAddress& addr,
333 ProtocolType proto);
334
335 // If the given data comprises a complete and correct STUN message then the
336 // return value is true, otherwise false. If the message username corresponds
337 // with this port's username fragment, msg will contain the parsed STUN
338 // message. Otherwise, the function may send a STUN response internally.
339 // remote_username contains the remote fragment of the STUN username.
kwiberg6baec032016-03-15 11:09:39 -0700340 bool GetStunMessage(const char* data,
341 size_t size,
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000342 const rtc::SocketAddress& addr,
kwiberg3ec46792016-04-27 07:22:53 -0700343 std::unique_ptr<IceMessage>* out_msg,
kwiberg6baec032016-03-15 11:09:39 -0700344 std::string* out_username);
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000345
346 // Checks if the address in addr is compatible with the port's ip.
347 bool IsCompatibleAddress(const rtc::SocketAddress& addr);
348
349 // Returns default DSCP value.
350 rtc::DiffServCodePoint DefaultDscpValue() const {
351 // No change from what MediaChannel set.
352 return rtc::DSCP_NO_CHANGE;
353 }
354
honghaiz36f50e82016-06-01 15:57:03 -0700355 // Extra work to be done in subclasses when a connection is destroyed.
356 virtual void HandleConnectionDestroyed(Connection* conn) {}
357
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000358 private:
359 void Construct();
360 // Called when one of our connections deletes itself.
361 void OnConnectionDestroyed(Connection* conn);
362
Honghai Zhang351d77b2016-05-20 15:08:29 -0700363 void OnNetworkTypeChanged(const rtc::Network* network);
364
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000365 rtc::Thread* thread_;
366 rtc::PacketSocketFactory* factory_;
367 std::string type_;
368 bool send_retransmit_count_attribute_;
369 rtc::Network* network_;
370 rtc::IPAddress ip_;
Peter Boström0c4e06b2015-10-07 12:23:21 +0200371 uint16_t min_port_;
372 uint16_t max_port_;
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000373 std::string content_name_;
374 int component_;
Peter Boström0c4e06b2015-10-07 12:23:21 +0200375 uint32_t generation_;
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000376 // In order to establish a connection to this Port (so that real data can be
377 // sent through), the other side must send us a STUN binding request that is
378 // authenticated with this username_fragment and password.
379 // PortAllocatorSession will provide these username_fragment and password.
380 //
381 // Note: we should always use username_fragment() instead of using
382 // |ice_username_fragment_| directly. For the details see the comment on
383 // username_fragment().
384 std::string ice_username_fragment_;
385 std::string password_;
386 std::vector<Candidate> candidates_;
387 AddressMap connections_;
388 int timeout_delay_;
389 bool enable_port_packets_;
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000390 IceRole ice_role_;
Peter Boström0c4e06b2015-10-07 12:23:21 +0200391 uint64_t tiebreaker_;
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000392 bool shared_socket_;
393 // Information to use when going through a proxy.
394 std::string user_agent_;
395 rtc::ProxyInfo proxy_;
396
honghaize1a0c942016-02-16 14:54:56 -0800397 // A virtual cost perceived by the user, usually based on the network type
398 // (WiFi. vs. Cellular). It takes precedence over the priority when
399 // comparing two connections.
honghaiza0c44ea2016-03-23 16:07:48 -0700400 uint16_t network_cost_;
Honghai Zhanga74363c2016-07-28 18:06:15 -0700401 State state_ = State::INIT;
Honghai Zhangb5db1ec2016-07-28 13:23:05 -0700402 int64_t last_time_all_connections_removed_ = 0;
honghaize1a0c942016-02-16 14:54:56 -0800403
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000404 friend class Connection;
405};
406
407// Represents a communication link between a port on the local client and a
408// port on the remote client.
Honghai Zhangcc411c02016-03-29 17:27:21 -0700409class Connection : public CandidatePairInterface,
410 public rtc::MessageHandler,
411 public sigslot::has_slots<> {
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000412 public:
Peter Thatcher1cf6f812015-05-15 10:40:45 -0700413 struct SentPing {
Honghai Zhang8cd8f812016-08-03 19:50:41 -0700414 SentPing(const std::string id, int64_t sent_time, uint32_t nomination)
415 : id(id), sent_time(sent_time), nomination(nomination) {}
Peter Thatcher1cf6f812015-05-15 10:40:45 -0700416
417 std::string id;
honghaiz34b11eb2016-03-16 08:55:44 -0700418 int64_t sent_time;
Honghai Zhang8cd8f812016-08-03 19:50:41 -0700419 uint32_t nomination;
Peter Thatcher1cf6f812015-05-15 10:40:45 -0700420 };
421
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000422 // States are from RFC 5245. http://tools.ietf.org/html/rfc5245#section-5.7.4
423 enum State {
424 STATE_WAITING = 0, // Check has not been performed, Waiting pair on CL.
425 STATE_INPROGRESS, // Check has been sent, transaction is in progress.
426 STATE_SUCCEEDED, // Check already done, produced a successful result.
427 STATE_FAILED // Check for this connection failed.
428 };
429
430 virtual ~Connection();
431
432 // The local port where this connection sends and receives packets.
433 Port* port() { return port_; }
434 const Port* port() const { return port_; }
435
Honghai Zhangcc411c02016-03-29 17:27:21 -0700436 // Implementation of virtual methods in CandidatePairInterface.
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000437 // Returns the description of the local port
438 virtual const Candidate& local_candidate() const;
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000439 // Returns the description of the remote port to which we communicate.
Honghai Zhangcc411c02016-03-29 17:27:21 -0700440 virtual const Candidate& remote_candidate() const;
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000441
442 // Returns the pair priority.
Peter Boström0c4e06b2015-10-07 12:23:21 +0200443 uint64_t priority() const;
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000444
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000445 enum WriteState {
446 STATE_WRITABLE = 0, // we have received ping responses recently
447 STATE_WRITE_UNRELIABLE = 1, // we have had a few ping failures
448 STATE_WRITE_INIT = 2, // we have yet to receive a ping response
449 STATE_WRITE_TIMEOUT = 3, // we have had a large number of ping failures
450 };
451
452 WriteState write_state() const { return write_state_; }
453 bool writable() const { return write_state_ == STATE_WRITABLE; }
Peter Thatcher04ac81f2015-09-21 11:48:28 -0700454 bool receiving() const { return receiving_; }
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000455
456 // Determines whether the connection has finished connecting. This can only
457 // be false for TCP connections.
458 bool connected() const { return connected_; }
Honghai Zhang2b342bf2015-09-30 09:51:58 -0700459 bool weak() const { return !(writable() && receiving() && connected()); }
460 bool active() const {
Honghai Zhang2b342bf2015-09-30 09:51:58 -0700461 return write_state_ != STATE_WRITE_TIMEOUT;
462 }
honghaiz059e1832016-06-24 11:03:55 -0700463
Honghai Zhang2b342bf2015-09-30 09:51:58 -0700464 // A connection is dead if it can be safely deleted.
honghaiz34b11eb2016-03-16 08:55:44 -0700465 bool dead(int64_t now) const;
honghaiz89374372015-09-24 13:14:47 -0700466
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000467 // Estimate of the round-trip time over this connection.
honghaiz34b11eb2016-03-16 08:55:44 -0700468 int rtt() const { return rtt_; }
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000469
zhihuang5ecf16c2016-06-01 17:09:15 -0700470 ConnectionInfo stats();
471
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000472 sigslot::signal1<Connection*> SignalStateChange;
473
474 // Sent when the connection has decided that it is no longer of value. It
475 // will delete itself immediately after this call.
476 sigslot::signal1<Connection*> SignalDestroyed;
477
478 // The connection can send and receive packets asynchronously. This matches
479 // the interface of AsyncPacketSocket, which may use UDP or TCP under the
480 // covers.
481 virtual int Send(const void* data, size_t size,
482 const rtc::PacketOptions& options) = 0;
483
484 // Error if Send() returns < 0
485 virtual int GetError() = 0;
486
Peter Thatcher04ac81f2015-09-21 11:48:28 -0700487 sigslot::signal4<Connection*, const char*, size_t, const rtc::PacketTime&>
488 SignalReadPacket;
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000489
490 sigslot::signal1<Connection*> SignalReadyToSend;
491
492 // Called when a packet is received on this connection.
493 void OnReadPacket(const char* data, size_t size,
494 const rtc::PacketTime& packet_time);
495
496 // Called when the socket is currently able to send.
497 void OnReadyToSend();
498
499 // Called when a connection is determined to be no longer useful to us. We
500 // still keep it around in case the other side wants to use it. But we can
501 // safely stop pinging on it and we can allow it to time out if the other
502 // side stops using it as well.
503 bool pruned() const { return pruned_; }
504 void Prune();
505
506 bool use_candidate_attr() const { return use_candidate_attr_; }
507 void set_use_candidate_attr(bool enable);
508
Honghai Zhang8cd8f812016-08-03 19:50:41 -0700509 void set_nomination(uint32_t value) { nomination_ = value; }
510
511 uint32_t remote_nomination() const { return remote_nomination_; }
512 bool nominated() const { return remote_nomination_ > 0; }
513 // Public for unit tests.
514 void set_remote_nomination(uint32_t remote_nomination) {
515 remote_nomination_ = remote_nomination;
516 }
517 // Public for unit tests.
518 uint32_t acked_nomination() const { return acked_nomination_; }
honghaiz5a3acd82015-08-20 15:53:17 -0700519
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000520 void set_remote_ice_mode(IceMode mode) {
521 remote_ice_mode_ = mode;
522 }
523
bertholdherrmann0812030662016-10-18 14:00:02 -0700524 void set_receiving_timeout(int receiving_timeout_ms) {
Peter Thatcher04ac81f2015-09-21 11:48:28 -0700525 receiving_timeout_ = receiving_timeout_ms;
526 }
527
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000528 // Makes the connection go away.
529 void Destroy();
530
deadbeef376e1232015-11-25 09:00:08 -0800531 // Makes the connection go away, in a failed state.
532 void FailAndDestroy();
533
honghaiz079a7a12016-06-22 16:26:29 -0700534 // Prunes the connection and sets its state to STATE_FAILED,
535 // It will not be used or send pings although it can still receive packets.
536 void FailAndPrune();
537
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000538 // Checks that the state of this connection is up-to-date. The argument is
539 // the current time, which is compared against various timeouts.
honghaiz34b11eb2016-03-16 08:55:44 -0700540 void UpdateState(int64_t now);
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000541
542 // Called when this connection should try checking writability again.
honghaiz34b11eb2016-03-16 08:55:44 -0700543 int64_t last_ping_sent() const { return last_ping_sent_; }
544 void Ping(int64_t now);
Honghai Zhang8cd8f812016-08-03 19:50:41 -0700545 void ReceivedPingResponse(int rtt, const std::string& request_id);
honghaiz34b11eb2016-03-16 08:55:44 -0700546 int64_t last_ping_response_received() const {
Honghai Zhang381b4212015-12-04 12:24:03 -0800547 return last_ping_response_received_;
548 }
Honghai Zhangfd16da22016-08-17 16:12:46 -0700549 // Used to check if any STUN ping response has been received.
550 int rtt_samples() const { return rtt_samples_; }
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000551
552 // Called whenever a valid ping is received on this connection. This is
553 // public because the connection intercepts the first ping for us.
honghaiz34b11eb2016-03-16 08:55:44 -0700554 int64_t last_ping_received() const { return last_ping_received_; }
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000555 void ReceivedPing();
honghaiz9b5ee9c2015-11-11 13:19:17 -0800556 // Handles the binding request; sends a response if this is a valid request.
557 void HandleBindingRequest(IceMessage* msg);
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000558
Honghai Zhang572b0942016-06-23 12:26:57 -0700559 int64_t last_data_received() const { return last_data_received_; }
560
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000561 // Debugging description of this connection
guoweis@webrtc.org8c9ff202014-12-04 07:56:02 +0000562 std::string ToDebugId() const;
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000563 std::string ToString() const;
564 std::string ToSensitiveString() const;
Peter Thatcher1cf6f812015-05-15 10:40:45 -0700565 // Prints pings_since_last_response_ into a string.
566 void PrintPingsSinceLastResponse(std::string* pings, size_t max);
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000567
568 bool reported() const { return reported_; }
569 void set_reported(bool reported) { reported_ = reported;}
570
honghaiz5a3acd82015-08-20 15:53:17 -0700571 // This signal will be fired if this connection is nominated by the
572 // controlling side.
573 sigslot::signal1<Connection*> SignalNominated;
Peter Thatcher54360512015-07-08 11:08:35 -0700574
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000575 // Invoked when Connection receives STUN error response with 487 code.
576 void HandleRoleConflictFromPeer();
577
578 State state() const { return state_; }
579
honghaiz524ecc22016-05-25 12:48:31 -0700580 int num_pings_sent() const { return num_pings_sent_; }
581
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000582 IceMode remote_ice_mode() const { return remote_ice_mode_; }
583
honghaize1a0c942016-02-16 14:54:56 -0800584 uint32_t ComputeNetworkCost() const;
585
Honghai Zhang4cedf2b2016-08-31 08:18:11 -0700586 // Update the ICE password and/or generation of the remote candidate if the
587 // ufrag in |params| matches the candidate's ufrag, and the
Taylor Brandstetter0a1bc532016-04-19 18:03:26 -0700588 // candidate's password and/or ufrag has not been set.
Honghai Zhang4cedf2b2016-08-31 08:18:11 -0700589 void MaybeSetRemoteIceParametersAndGeneration(const IceParameters& params,
590 int generation);
jiayl@webrtc.orgdacdd942015-01-23 17:33:34 +0000591
592 // If |remote_candidate_| is peer reflexive and is equivalent to
593 // |new_candidate| except the type, update |remote_candidate_| to
594 // |new_candidate|.
595 void MaybeUpdatePeerReflexiveCandidate(const Candidate& new_candidate);
596
Peter Thatcher54360512015-07-08 11:08:35 -0700597 // Returns the last received time of any data, stun request, or stun
598 // response in milliseconds
honghaiz34b11eb2016-03-16 08:55:44 -0700599 int64_t last_received() const;
honghaiz9ad0db52016-07-14 19:30:28 -0700600 // Returns the last time when the connection changed its receiving state.
601 int64_t receiving_unchanged_since() const {
602 return receiving_unchanged_since_;
603 }
Peter Thatcher54360512015-07-08 11:08:35 -0700604
Taylor Brandstetterb825aee2016-06-29 13:07:16 -0700605 bool stable(int64_t now) const;
zhihuang435264a2016-06-21 11:28:38 -0700606
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000607 protected:
Guo-wei Shiehbe508a12015-04-06 12:48:47 -0700608 enum { MSG_DELETE = 0, MSG_FIRST_AVAILABLE };
609
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000610 // Constructs a new connection to the given remote port.
611 Connection(Port* port, size_t index, const Candidate& candidate);
612
613 // Called back when StunRequestManager has a stun packet to send
614 void OnSendStunPacket(const void* data, size_t size, StunRequest* req);
615
616 // Callbacks from ConnectionRequest
Guo-wei Shiehbe508a12015-04-06 12:48:47 -0700617 virtual void OnConnectionRequestResponse(ConnectionRequest* req,
618 StunMessage* response);
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000619 void OnConnectionRequestErrorResponse(ConnectionRequest* req,
620 StunMessage* response);
621 void OnConnectionRequestTimeout(ConnectionRequest* req);
Peter Thatcher1cf6f812015-05-15 10:40:45 -0700622 void OnConnectionRequestSent(ConnectionRequest* req);
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000623
Taylor Brandstetterb825aee2016-06-29 13:07:16 -0700624 bool rtt_converged() const;
zhihuang435264a2016-06-21 11:28:38 -0700625
626 // If the response is not received within 2 * RTT, the response is assumed to
627 // be missing.
Taylor Brandstetterb825aee2016-06-29 13:07:16 -0700628 bool missing_responses(int64_t now) const;
zhihuang435264a2016-06-21 11:28:38 -0700629
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000630 // Changes the state and signals if necessary.
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000631 void set_write_state(WriteState value);
honghaiz9ad0db52016-07-14 19:30:28 -0700632 void UpdateReceiving(int64_t now);
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000633 void set_state(State state);
634 void set_connected(bool value);
635
Honghai Zhang8cd8f812016-08-03 19:50:41 -0700636 uint32_t nomination() const { return nomination_; }
637
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000638 void OnMessage(rtc::Message *pmsg);
639
640 Port* port_;
641 size_t local_candidate_index_;
642 Candidate remote_candidate_;
Honghai Zhang8cd8f812016-08-03 19:50:41 -0700643
644 ConnectionInfo stats_;
645 rtc::RateTracker recv_rate_tracker_;
646 rtc::RateTracker send_rate_tracker_;
647
648 private:
Taylor Brandstetter62351c92016-08-11 16:05:07 -0700649 // Update the local candidate based on the mapped address attribute.
650 // If the local candidate changed, fires SignalStateChange.
651 void MaybeUpdateLocalCandidate(ConnectionRequest* request,
652 StunMessage* response);
653
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000654 WriteState write_state_;
Peter Thatcher04ac81f2015-09-21 11:48:28 -0700655 bool receiving_;
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000656 bool connected_;
657 bool pruned_;
658 // By default |use_candidate_attr_| flag will be true,
honghaiz5a3acd82015-08-20 15:53:17 -0700659 // as we will be using aggressive nomination.
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000660 // But when peer is ice-lite, this flag "must" be initialized to false and
661 // turn on when connection becomes "best connection".
662 bool use_candidate_attr_;
Honghai Zhang8cd8f812016-08-03 19:50:41 -0700663 // Used by the controlling side to indicate that this connection will be
664 // selected for transmission if the peer supports ICE-renomination when this
665 // value is positive. A larger-value indicates that a connection is nominated
666 // later and should be selected by the controlled side with higher precedence.
667 // A zero-value indicates not nominating this connection.
668 uint32_t nomination_ = 0;
669 // The last nomination that has been acknowledged.
670 uint32_t acked_nomination_ = 0;
671 // Used by the controlled side to remember the nomination value received from
672 // the controlling side. When the peer does not support ICE re-nomination,
673 // its value will be 1 if the connection has been nominated.
674 uint32_t remote_nomination_ = 0;
675
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000676 IceMode remote_ice_mode_;
677 StunRequestManager requests_;
honghaiz34b11eb2016-03-16 08:55:44 -0700678 int rtt_;
zhihuang435264a2016-06-21 11:28:38 -0700679 int rtt_samples_ = 0;
honghaiz34b11eb2016-03-16 08:55:44 -0700680 int64_t last_ping_sent_; // last time we sent a ping to the other side
681 int64_t last_ping_received_; // last time we received a ping from the other
682 // side
683 int64_t last_data_received_;
684 int64_t last_ping_response_received_;
honghaiz9ad0db52016-07-14 19:30:28 -0700685 int64_t receiving_unchanged_since_ = 0;
Peter Thatcher1cf6f812015-05-15 10:40:45 -0700686 std::vector<SentPing> pings_since_last_response_;
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000687
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000688 bool reported_;
689 State state_;
Peter Thatcher04ac81f2015-09-21 11:48:28 -0700690 // Time duration to switch from receiving to not receiving.
honghaiz34b11eb2016-03-16 08:55:44 -0700691 int receiving_timeout_;
692 int64_t time_created_ms_;
honghaiz524ecc22016-05-25 12:48:31 -0700693 int num_pings_sent_ = 0;
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000694
695 friend class Port;
696 friend class ConnectionRequest;
697};
698
deadbeef376e1232015-11-25 09:00:08 -0800699// ProxyConnection defers all the interesting work to the port.
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000700class ProxyConnection : public Connection {
701 public:
deadbeef376e1232015-11-25 09:00:08 -0800702 ProxyConnection(Port* port, size_t index, const Candidate& remote_candidate);
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000703
deadbeef376e1232015-11-25 09:00:08 -0800704 int Send(const void* data,
705 size_t size,
706 const rtc::PacketOptions& options) override;
707 int GetError() override { return error_; }
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000708
709 private:
deadbeef376e1232015-11-25 09:00:08 -0800710 int error_ = 0;
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000711};
712
713} // namespace cricket
714
715#endif // WEBRTC_P2P_BASE_PORT_H_