Signal to remove remote candidates if ports are pruned.

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 124 matching lines @@
     bool has_pairable_candidate() const { return has_pairable_candidate_; }
     bool complete() const { return state_ == STATE_COMPLETE; }
     bool error() const { return state_ == STATE_ERROR; }
     bool pruned() const { return state_ == STATE_PRUNED; }
     bool inprogress() const { return state_ == STATE_INPROGRESS; }
     // Returns true if this port is ready to be used.
     bool ready() const {
       return has_pairable_candidate_ && state_ != STATE_ERROR &&
              state_ != STATE_PRUNED;
     }
-
     void set_pruned() { state_ = STATE_PRUNED; }

[skvlad, 2016/09/14 02:35:11]

This doesn't seem to be called from anywhere else. Could this be inlined into
PrunePort()?

[honghaiz3, 2016/09/14 16:50:31]

Done.

+    // Sets the state to "PRUNED" and prunes the Port.
+    void PrunePort() {
+      set_pruned();
+      if (port()) {
+        port()->Prune();
+      }
+    }
     void set_has_pairable_candidate(bool has_pairable_candidate) {
       if (has_pairable_candidate) {
         ASSERT(state_ == STATE_INPROGRESS);
       }
       has_pairable_candidate_ = has_pairable_candidate;
     }
     void set_complete() {
       state_ = STATE_COMPLETE;
     }
     void set_error() {
@@ skipping 37 matching lines @@
   PortData* FindPort(Port* port);
   std::vector<rtc::Network*> GetNetworks();
   std::vector<rtc::Network*> GetFailedNetworks();
 
   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;
 
-  // Removes the ports and candidates on given networks.
-  void RemovePortsAndCandidates(const std::vector<rtc::Network*>& networks);
+  std::vector<PortData*> GetUnprunedPortsOnNetworks(
+      const std::vector<rtc::Network*>& networks);
+  // Prunes ports and signal the remote side to remove the candidates generated
+  // by these ports.
+  void PrunePortsAndRemoveCandidates(
+      const std::vector<PortData*>& port_data_list);
   // Gets filtered and sanitized candidates generated from a port and
   // append to |candidates|.
   void GetCandidatesFromPort(const PortData& data,
                              std::vector<Candidate>* candidates) const;
   Port* GetBestTurnPortForNetwork(const std::string& network_name) const;
   // Returns true if at least one TURN port is pruned.
   bool PruneTurnPorts(Port* newly_pairable_turn_port);
 
   BasicPortAllocator* allocator_;
   rtc::Thread* network_thread_;
@@ skipping 140 matching lines @@
   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_