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/macros.h"
 #include "base/memory/scoped_ptr.h"
+#include "base/threading/thread_checker.h"
+#include "base/timer/timer.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 {
 
 // 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::StunProber::Observer,
+                        public sigslot::has_slots<> {
+ public:
+  struct Param {
+    Param();
+    ~Param();
+    int requests_per_ip = 0;
+    int interval_ms = 0;
+    int shared_socket_mode = 0;
+    int batch_size = 0;
+    int total_batches = 0;
+    std::vector<rtc::SocketAddress> servers;
+  };
 
-// 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);
+  StunProberTrial(rtc::NetworkManager* network_manager,
+                  const std::string& params,
+                  rtc::PacketSocketFactory* factory);
+  ~StunProberTrial() override;
+
+  // 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();

[Sergey Ulanov, 2015/10/30 22:50:06]

This doesn't need to be public.

[guoweis_left_chromium, 2015/10/30 23:15:00]

Done.

+
+  // Parsing function to decode the '/' separated parameter string |params|.
+  static CONTENT_EXPORT bool ParseParameters(const std::string& param_line,

[Sergey Ulanov, 2015/10/30 22:50:06]

It looks like this function is public just so that tests can access it. Make it
private and make the test friends so that it can call this function. See
FRIEND_TEST_ALL_PREFIXES.

[guoweis_left_chromium, 2015/10/30 23:15:00]

Done.

+                                             Param* params);
+
+  // stunprober::StunProber::Observer:
+  void OnPrepared(stunprober::StunProber* prober,

[Sergey Ulanov, 2015/10/30 22:50:06]

Move this to the private section to indicate that this interface is not intended
to be used by other classes. The interface should still be marked as public in
the class definition..

[guoweis_left_chromium, 2015/10/30 23:14:59]

Done.

+                  stunprober::StunProber::Status status) override;
+  void OnFinished(stunprober::StunProber* prober,
+                  stunprober::StunProber::Status status) override;
+
+  // This will be invoked repeatedly for |total_probers_| times with the
+  // interval equal to the estimated run time of a prober.
+  void OnTimer();

[Sergey Ulanov, 2015/10/30 22:50:06]

This doesn't need to be public.

[guoweis_left_chromium, 2015/10/30 23:14:59]

Done.

+
+ private:
+  void SaveHistogramData();
+
+  rtc::NetworkManager* network_manager_;
+  std::string param_line_;
+  rtc::PacketSocketFactory* factory_ = nullptr;
+  int total_probers_ = 0;
+  int batch_size_ = 0;
+  int ready_probers_ = 0;
+  int started_probers_ = 0;
+  int finished_probers_ = 0;
+  std::vector<stunprober::StunProber*> probers_;

[Sergey Ulanov, 2015/10/30 22:50:06]

add #include <vector>

[guoweis_left_chromium, 2015/10/30 23:15:00]

Done.

+  base::ThreadChecker thread_checker_;
+
+  base::RepeatingTimer timer_;
+
+  DISALLOW_COPY_AND_ASSIGN(StunProberTrial);
+};
 
 }  // namespace content
 
 #endif  // CONTENT_RENDERER_MEDIA_WEBRTC_STUN_FIELD_TRIAL_H_