Relanding: Implement RTCConfiguration.iceCandidatePoolSize.

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 20 matching lines @@
   BasicPortAllocator(rtc::NetworkManager* network_manager,
                      rtc::PacketSocketFactory* socket_factory,
                      const ServerAddresses& stun_servers);
   BasicPortAllocator(rtc::NetworkManager* network_manager,
                      const ServerAddresses& stun_servers,
                      const rtc::SocketAddress& relay_server_udp,
                      const rtc::SocketAddress& relay_server_tcp,
                      const rtc::SocketAddress& relay_server_ssl);
   virtual ~BasicPortAllocator();
 
-  void SetIceServers(
-      const ServerAddresses& stun_servers,
-      const std::vector<RelayServerConfig>& turn_servers) override {
-    stun_servers_ = stun_servers;
-    turn_servers_ = turn_servers;
-  }
-
   // 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_; }
 
   // If socket_factory() is set to NULL each PortAllocatorSession
   // creates its own socket factory.
   rtc::PacketSocketFactory* socket_factory() { return socket_factory_; }
 
-  const ServerAddresses& stun_servers() const {
-    return stun_servers_;
-  }
-
-  const std::vector<RelayServerConfig>& turn_servers() const {
-    return turn_servers_;
-  }
-  virtual void AddTurnServer(const RelayServerConfig& turn_server) {
-    turn_servers_.push_back(turn_server);
-  }
-
   PortAllocatorSession* CreateSessionInternal(
       const std::string& content_name,
       int component,
       const std::string& ice_ufrag,
       const std::string& ice_pwd) override;
 
+  // Convenience method that adds a TURN server to the configuration.
+  void AddTurnServer(const RelayServerConfig& turn_server);
+
  private:
   void Construct();
 
   rtc::NetworkManager* network_manager_;
   rtc::PacketSocketFactory* socket_factory_;
-  ServerAddresses stun_servers_;
-  std::vector<RelayServerConfig> turn_servers_;
   bool allow_tcp_listen_;
   int network_ignore_mask_ = rtc::kDefaultNetworkIgnoreMask;
 };
 
 struct PortConfiguration;
 class AllocationSequence;
 
 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();
 
   virtual BasicPortAllocator* allocator() { return allocator_; }
   rtc::Thread* network_thread() { return network_thread_; }
   rtc::PacketSocketFactory* socket_factory() { return socket_factory_; }
 
   void StartGettingPorts() override;
   void StopGettingPorts() override;
   void ClearGettingPorts() override;
   bool IsGettingPorts() override { return running_; }
+  // These will all be cricket::Ports.
+  std::vector<PortInterface*> ReadyPorts() const override;
+  std::vector<Candidate> ReadyCandidates() const override;
+  bool CandidatesAllocationDone() const override;
 
  protected:
+  void UpdateTransportInformationInternal() 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);
 
   // MessageHandler.  Can be overriden if message IDs do not conflict.
   void OnMessage(rtc::Message* message) override;
 
  private:
   class PortData {
    public:
     PortData() : port_(NULL), sequence_(NULL), state_(STATE_INIT) {}
     PortData(Port* port, AllocationSequence* seq)
     : port_(port), sequence_(seq), state_(STATE_INIT) {
     }
 
-    Port* port() { return port_; }
-    AllocationSequence* sequence() { return sequence_; }
+    Port* port() const { return port_; }
+    AllocationSequence* sequence() const { return sequence_; }
     bool ready() const { return state_ == STATE_READY; }
-    bool complete() const {
-      // Returns true if candidate allocation has completed one way or another.
+    bool ready_or_complete() const {
+      return ((state_ == STATE_READY) || (state_ == STATE_COMPLETE));
+    }

[pthatcher1, 2016/05/05 21:51:25]

Why not just have complete() and then let callers do "ready() || complete()"?

[Taylor Brandstetter, 2016/05/06 03:53:35]

I was just keeping it the way it was before. I assume it was written this way
because the check occurs so often it was convenient to only call one method. But
I'll change it.

+    // Returns true if candidate allocation has completed one way or another.
+    bool complete_or_error() const {
       return ((state_ == STATE_COMPLETE) || (state_ == STATE_ERROR));
     }

[pthatcher1, 2016/05/05 21:51:25]

Same here: "complete() || error()"

[Taylor Brandstetter, 2016/05/06 03:53:35]

Done.

 
     void set_ready() { ASSERT(state_ == STATE_INIT); state_ = STATE_READY; }
     void set_complete() {
       state_ = STATE_COMPLETE;
     }
     void set_error() {
       ASSERT(state_ == STATE_INIT || state_ == STATE_READY);
       state_ = STATE_ERROR;
     }
 
@@ skipping 25 matching lines @@
   void OnPortComplete(Port* port);
   void OnPortError(Port* port);
   void OnProtocolEnabled(AllocationSequence* seq, ProtocolType proto);
   void OnPortDestroyed(PortInterface* port);
   void OnShake();
   void MaybeSignalCandidatesAllocationDone();
   void OnPortAllocationComplete(AllocationSequence* seq);
   PortData* FindPort(Port* port);
   void GetNetworks(std::vector<rtc::Network*>* networks);
 
-  bool CheckCandidateFilter(const Candidate& c);
+  bool CheckCandidateFilter(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
   bool allocation_sequences_created_;
   std::vector<PortConfiguration*> configs_;
@@ skipping 128 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_