Create an experiment to study whether too many bindings cause NAT failure

content/renderer/media/webrtc/stun_field_trial.h

 // Copyright 2015 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #ifndef CONTENT_RENDERER_MEDIA_WEBRTC_STUN_FIELD_TRIAL_H_
 #define CONTENT_RENDERER_MEDIA_WEBRTC_STUN_FIELD_TRIAL_H_
 
 #include <string>
 
 #include "base/memory/scoped_ptr.h"
+#include "base/memory/weak_ptr.h"
+#include "base/threading/thread_checker.h"
 #include "content/common/content_export.h"
+#include "content/renderer/p2p/network_list_manager.h"
+#include "content/renderer/p2p/network_list_observer.h"
 #include "third_party/webrtc/base/network.h"
+#include "third_party/webrtc/base/sigslot.h"
+#include "third_party/webrtc/p2p/stunprober/stunprober.h"
 
 namespace rtc {
 class PacketSocketFactory;
 class SocketAddress;
 }  // namespace rtc
 
-namespace stunprober {
-class StunProber;
-}  // namespace stunprober
+namespace content {
 
-namespace content {
+using StunProber = stunprober::StunProber;
+
+// Helper class to link the StunProbers together such that the first STUN ping
+// in the next prober could be sent at the same interval as inside a
+// prober. This is to maintain the consistency of intervals across the whole
+// trial. It uses weak pointer to trigger next prober's Start(), in case if the
+// owning PeerConnectionDependencyFactory is deleted in between.
+class StunProberWithWeakPtr {
+ public:
+  StunProberWithWeakPtr(StunProber* prober);

[Alexei Svitkine (slow), 2015/10/30 15:49:39]

Nit: explicit

[guoweis_webrtc, 2015/10/30 16:34:13]

Done.

+  virtual ~StunProberWithWeakPtr();

[Alexei Svitkine (slow), 2015/10/30 15:49:39]

Nit: Add a blank line below.

[guoweis_webrtc, 2015/10/30 16:34:13]

Done.

+  void set_next_prober(StunProberWithWeakPtr* prober);
+  void Start(StunProber::Observer* observer);
+  base::WeakPtr<StunProberWithWeakPtr> GetWeakPtr() {
+    return weak_factory_.GetWeakPtr();
+  }
+  bool GetStats(StunProber::Stats* stats) { return prober_->GetStats(stats); }
+  StunProberWithWeakPtr* GetNextProber() { return next_prober_; }
+
+ private:
+  scoped_ptr<StunProber> prober_;
+  StunProberWithWeakPtr* next_prober_ = nullptr;
+  base::WeakPtrFactory<StunProberWithWeakPtr> weak_factory_;
+};

[Alexei Svitkine (slow), 2015/10/30 15:49:39]

Nit: DISALLOW_COPY_AND_ASSIGN()

[guoweis_webrtc, 2015/10/30 16:34:13]

Done.

 
 // Wait for 30 seconds to avoid high CPU usage during browser start-up which
 // might affect the accuracy of the trial. The trial wakes up the browser every
 // 1 ms for no more than 3 seconds to see if time has passed for sending next
 // stun probe.
 static const int kExperimentStartDelayMs = 30000;
 
-// This will use |factory| to create sockets, send stun binding requests with
-// various intervals as determined by |params|, observed the success rate and
-// latency of the stun responses and report through UMA.
-scoped_ptr<stunprober::StunProber> StartStunProbeTrial(
-    const rtc::NetworkManager::NetworkList& networks,
-    const std::string& params,
-    rtc::PacketSocketFactory* factory);
+class StunProberTrial : public StunProber::Observer,
+                        public sigslot::has_slots<> {
+ public:
+  StunProberTrial(rtc::NetworkManager* network_manager,
+                  const std::string& params,
+                  rtc::PacketSocketFactory* factory);
+  ~StunProberTrial() override;
 
-// Parsing function to decode the '/' separated parameter string |params|.
-CONTENT_EXPORT bool ParseStunProbeParameters(
-    const std::string& params,
-    int* requests_per_ip,
-    int* interval_ms,
-    int* shared_socket_mode,
-    std::vector<rtc::SocketAddress>* servers);
+  // This will use |factory_| to create sockets, send stun binding requests with
+  // various intervals as determined by |params|, observed the success rate and
+  // latency of the stun responses and report through UMA.
+  void OnNetworksChanged();
+
+  // Parsing function to decode the '/' separated parameter string |params|.
+  static CONTENT_EXPORT bool ParseParameters(
+      const std::string& params,
+      int* requests_per_ip,
+      int* interval_ms,
+      int* shared_socket_mode,
+      int* batch_size,
+      int* total_batches,
+      std::vector<rtc::SocketAddress>* servers);
+
+  // stunprober::StunProber::Observer
+  void OnPrepared(StunProber* prober, StunProber::Status status) override;
+  void OnFinished(StunProber* prober, StunProber::Status status) override;
+
+ private:
+  void SaveHistogramData();
+
+  rtc::NetworkManager* network_manager_;
+  std::string params_;
+  rtc::PacketSocketFactory* factory_ = nullptr;
+  int total_probers_ = 0;
+  int batch_size_ = 0;
+  int ready_probers_ = 0;
+  int finished_probers_ = 0;
+  scoped_ptr<StunProberWithWeakPtr> prober_head_;
+  base::ThreadChecker thread_checker_;
+};

[Alexei Svitkine (slow), 2015/10/30 15:49:39]

Nit: DISALLOW_COPY_AND_ASSIGN()

[guoweis_webrtc, 2015/10/30 16:34:13]

Done.

 
 }  // namespace content
 
 #endif  // CONTENT_RENDERER_MEDIA_WEBRTC_STUN_FIELD_TRIAL_H_