NQE: Add net log events when there is a significant change in metrics

net/nqe/event_creator.h

 // Copyright 2017 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 NET_NQE_EVENT_CREATOR_H_
 #define NET_NQE_EVENT_CREATOR_H_
 
 #include <stdint.h>
 
+#include "base/macros.h"
+#include "base/threading/thread_checker.h"
 #include "base/time/time.h"
+#include "net/base/net_export.h"
+#include "net/log/net_log_with_source.h"
 #include "net/nqe/effective_connection_type.h"
+#include "net/nqe/network_quality.h"
 
 namespace net {
 
 class NetLogWithSource;
 
 namespace nqe {
 
 namespace internal {
 
-// Adds network quality changed event to the net-internals log. |http_rtt| is
-// the estimate of the HTTP RTT. |transport_rtt| is the estimate of the
-// transport RTT. |downstream_throughput_kbps| is the estimate of the
-// downstream throughput (in kilobits per second). |effective_connection_type|
-// is the current estimate of the effective connection type.
-void AddEffectiveConnectionTypeChangedEventToNetLog(
-    const NetLogWithSource& net_log,
-    base::TimeDelta http_rtt,
-    base::TimeDelta transport_rtt,
-    int32_t downstream_throughput_kbps,
-    EffectiveConnectionType effective_connection_type);
+// Class that adds net log events for network quality estimator.
+class NET_EXPORT_PRIVATE EventCreator {
+ public:
+  explicit EventCreator(NetLogWithSource net_log);
+  ~EventCreator();
+
+  // May add network quality changed event to the net-internals log.

[RyanSturm, 2017/01/25 22:56:50]

Add to the comment about either when it will add to the log or when it won't.

[tbansal1, 2017/01/26 00:05:45]

Done.

+  // |effective_connection_type| is the current effective connection type.
+  // |network_quality| is the current network quality.
+  void MaybeAddEffectiveConnectionTypeChangedEventToNetLog(
+      EffectiveConnectionType effective_connection_type,
+      const NetworkQuality& network_quality);
+
+ private:
+  NetLogWithSource net_log_;
+
+  //  |past_effective_connection_type| is the effective connection type when the

[RyanSturm, 2017/01/25 22:56:50]

reformat these comments to not reference the variable name:

"The effective connection...."

[tbansal1, 2017/01/26 00:05:45]

Done.

+  // net log event was last added.
+  EffectiveConnectionType past_effective_connection_type_;
+
+  //  |past_network_quality_| is the network quality when the net log event was
+  //  last added.
+  NetworkQuality past_network_quality_;
+
+  base::ThreadChecker thread_checker_;
+
+  DISALLOW_COPY_AND_ASSIGN(EventCreator);
+};
 
 }  // namespace internal
 
 }  // namespace nqe
 
 }  // namespace net
 
 #endif  // NET_NQE_EVENT_CREATOR_H_