Use continual gathering to restore backup connections

webrtc/p2p/client/basicportallocator.h

 /*
  *  Copyright 2004 The WebRTC Project Authors. All rights reserved.
  *
  *  Use of this source code is governed by a BSD-style license
  *  that can be found in the LICENSE file in the root of the source
  *  tree. An additional intellectual property rights grant can be found
  *  in the file PATENTS.  All contributing project authors may
  *  be found in the AUTHORS file in the root of the source tree.
  */
 
@@ skipping 29 matching lines @@
   // Set to kDefaultNetworkIgnoreMask by default.
   void SetNetworkIgnoreMask(int network_ignore_mask) override {
     // TODO(phoglund): implement support for other types than loopback.
     // See https://code.google.com/p/webrtc/issues/detail?id=4288.
     // Then remove set_network_ignore_list from NetworkManager.
     network_ignore_mask_ = network_ignore_mask;
   }
 
   int network_ignore_mask() const { return network_ignore_mask_; }
 
-  rtc::NetworkManager* network_manager() { return network_manager_; }
+  rtc::NetworkManager* network_manager() const override {
+    return network_manager_;
+  }
 
   // If socket_factory() is set to NULL each PortAllocatorSession
   // creates its own socket factory.
   rtc::PacketSocketFactory* socket_factory() { return socket_factory_; }
 
   PortAllocatorSession* CreateSessionInternal(
       const std::string& content_name,
       int component,
       const std::string& ice_ufrag,
       const std::string& ice_pwd) override;
@@ skipping 16 matching lines @@
 class BasicPortAllocatorSession : public PortAllocatorSession,
                                   public rtc::MessageHandler {
  public:
   BasicPortAllocatorSession(BasicPortAllocator* allocator,
                             const std::string& content_name,
                             int component,
                             const std::string& ice_ufrag,
                             const std::string& ice_pwd);
   ~BasicPortAllocatorSession();
 
+  // TODO(honghaiz): When continual gathering is fully enabled, we don't need
+  // the state STATE_STOPPED. A session can always start new allocation
+  // sequences.
+  enum State {
+    STATE_RUNNING,  // Current allocation sequence is running, can start new
+                    // allocation sequences.
+    STATE_CLEARED,  // Current allocation sequence is complete, can start new
+                    // allocation sequences.
+    STATE_STOPPED   // Current allocation sequence is complete, cannot start
+                    // new allocation sequences.
+  };
+
   virtual BasicPortAllocator* allocator() { return allocator_; }
   rtc::Thread* network_thread() { return network_thread_; }
   rtc::PacketSocketFactory* socket_factory() { return socket_factory_; }
 
   void SetCandidateFilter(uint32_t filter) override;
+
   void StartGettingPorts() override;
   void StopGettingPorts() override;
   void ClearGettingPorts() override;
-  bool IsGettingPorts() override { return running_; }
+  bool IsGettingPorts() override { return state_ == STATE_RUNNING; }
+  bool CanGetPorts() override { return state_ != STATE_STOPPED; }
+
   // These will all be cricket::Ports.
   std::vector<PortInterface*> ReadyPorts() const override;
   std::vector<Candidate> ReadyCandidates() const override;
+  std::vector<Candidate> ReadyCandidates(PortInterface* port) const override;
   bool CandidatesAllocationDone() const override;
+  bool RegatherOnFailedNetworks() override;
 
  protected:
   void UpdateIceParametersInternal() override;
 
   // Starts the process of getting the port configurations.
   virtual void GetPortConfigurations();
 
   // Adds a port configuration that is now ready.  Once we have one for each
   // network (or a timeout occurs), we will start allocating ports.
   virtual void ConfigReady(PortConfiguration* config);
@@ skipping 53 matching lines @@
   void AddAllocatedPort(Port* port, AllocationSequence* seq,
                         bool prepare_address);
   void OnCandidateReady(Port* port, const Candidate& c);
   void OnPortComplete(Port* port);
   void OnPortError(Port* port);
   void OnProtocolEnabled(AllocationSequence* seq, ProtocolType proto);
   void OnPortDestroyed(PortInterface* port);
   void MaybeSignalCandidatesAllocationDone();
   void OnPortAllocationComplete(AllocationSequence* seq);
   PortData* FindPort(Port* port);
-  void GetNetworks(std::vector<rtc::Network*>* networks);
+  std::vector<rtc::Network*> GetNetworks() const;
+  std::vector<rtc::Network*> GetFailedNetworks() const;
 
   bool CheckCandidateFilter(const Candidate& c) const;
   bool CandidatePairable(const Candidate& c, const Port* port) const;
   // Clear the related address according to the flags and candidate filter
   // in order to avoid leaking any information.
   Candidate SanitizeRelatedAddress(const Candidate& c) const;
 
   BasicPortAllocator* allocator_;
   rtc::Thread* network_thread_;
   std::unique_ptr<rtc::PacketSocketFactory> owned_socket_factory_;
   rtc::PacketSocketFactory* socket_factory_;
   bool allocation_started_;
   bool network_manager_started_;
-  bool running_;  // set when StartGetAllPorts is called
+  State state_ = STATE_RUNNING;
   bool allocation_sequences_created_;
   std::vector<PortConfiguration*> configs_;
   std::vector<AllocationSequence*> sequences_;
   std::vector<PortData> ports_;
   uint32_t candidate_filter_ = CF_ALL;
 
   friend class AllocationSequence;
 };
 
 // Records configuration information useful in creating ports.
@@ skipping 50 matching lines @@
 
     // kInit --> kRunning --> {kCompleted|kStopped}
   };
   AllocationSequence(BasicPortAllocatorSession* session,
                      rtc::Network* network,
                      PortConfiguration* config,
                      uint32_t flags);
   ~AllocationSequence();
   bool Init();
   void Clear();
-  void OnNetworkRemoved();
+  void OnNetworkInactivated();
 
   State state() const { return state_; }
   const rtc::Network* network() const { return network_; }
-  bool network_removed() const { return network_removed_; }
+
+  bool network_inactive() const { return network_inactive_; }
+  void set_network_inactive(bool network_inactive) {
+    network_inactive_ = network_inactive;
+  }
 
   // Disables the phases for a new sequence that this one already covers for an
   // equivalent network setup.
   void DisableEquivalentPhases(rtc::Network* network,
                                PortConfiguration* config,
                                uint32_t* flags);
 
   // Starts and stops the sequence.  When started, it will continue allocating
   // new ports on its own timed schedule.
   void Start();
@@ skipping 29 matching lines @@
 
   void OnReadPacket(rtc::AsyncPacketSocket* socket,
                     const char* data,
                     size_t size,
                     const rtc::SocketAddress& remote_addr,
                     const rtc::PacketTime& packet_time);
 
   void OnPortDestroyed(PortInterface* port);
 
   BasicPortAllocatorSession* session_;
-  bool network_removed_ = false;
+  bool network_inactive_ = false;
   rtc::Network* network_;
   rtc::IPAddress ip_;
   PortConfiguration* config_;
   State state_;
   uint32_t flags_;
   ProtocolList protocols_;
   std::unique_ptr<rtc::AsyncPacketSocket> udp_socket_;
   // There will be only one udp port per AllocationSequence.
   UDPPort* udp_port_;
   std::vector<TurnPort*> turn_ports_;
   int phase_;
 };
 
 }  // namespace cricket
 
 #endif  // WEBRTC_P2P_CLIENT_BASICPORTALLOCATOR_H_