NetConnectivity - Collect stats for TCP/UDP network

chrome/browser/net/network_stats.h

 // Copyright (c) 2012 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 CHROME_BROWSER_NET_NETWORK_STATS_H_
 #define CHROME_BROWSER_NET_NETWORK_STATS_H_
 #pragma once
 
 #include <string>
 
 #include "base/basictypes.h"
 #include "base/memory/ref_counted.h"
 #include "base/memory/scoped_ptr.h"
 #include "base/string_util.h"
 #include "base/time.h"
 #include "chrome/browser/io_thread.h"
 #include "net/base/address_list.h"
 #include "net/base/completion_callback.h"
 #include "net/base/host_port_pair.h"
 #include "net/base/host_resolver.h"
 #include "net/base/io_buffer.h"
 #include "net/base/ip_endpoint.h"
 #include "net/base/test_data_stream.h"
+#include "net/proxy/proxy_info.h"
 #include "net/socket/socket.h"
 namespace chrome_browser_net {
 
 // This class is used for live experiment of network connectivity (either TCP or
 // UDP) metrics. A small percentage of users participate in this experiment. All
 // users (who are in the experiment) must have enabled "UMA upload".
 //
 // This class collects the following stats from users who have opted in.
 // a) What percentage of users can get a message end-to-end to a UDP server?
 // b) What percentage of users can get a message end-to-end to a TCP server?
@@ skipping 60 matching lines @@
   // Starts the client, connecting to |server|.
   // Client will send |bytes_to_send| bytes to |server|.
   // When client has received all echoed bytes from the server, or
   // when an error occurs causing the client to stop, |Finish| will be
   // called with a net status code.
   // |Finish| will collect histogram stats.
   // Returns true if successful in starting the client.
   bool Start(net::HostResolver* host_resolver,
              const net::HostPortPair& server,
              HistogramPortSelector histogram_port,
+             bool has_proxy_server,
              uint32 bytes_to_send,
              uint32 packets_to_send,
              const net::CompletionCallback& callback);
 
  protected:
   // Constructs an NetworkStats object that collects metrics for network
   // connectivity (either TCP or UDP).
   NetworkStats();
+  // NetworkStats is deleted when Finish() is called.
   virtual ~NetworkStats();
 
   // Initializes |finished_callback_| and the number of bytes to send to the
   // server. |finished_callback| is called when we are done with the test.
   // |finished_callback| is mainly useful for unittests.
   void Initialize(uint32 bytes_to_send,
                   HistogramPortSelector histogram_port,
+                  bool has_proxy_server,
                   uint32 packets_to_send,
                   const net::CompletionCallback& finished_callback);
 
   // Called after host is resolved. UDPStatsClient and TCPStatsClient implement
   // this method. They create the socket and connect to the server.
   virtual bool DoConnect(int result) = 0;
 
   // This method is called after socket connection is completed. It will start
   // the process of sending packets to |server| by calling SendPacket(). Returns
   // false if connection is not established (result is less than 0).
@@ skipping 135 matching lines @@
   std::string encoded_message_;
 
   // |stream_| is used to generate data to be sent to the server and it is also
   // used to verify the data received from the server.
   net::TestDataStream stream_;
 
   // |histogram_port_| specifies the port for which we are testing the network
   // connectivity.
   HistogramPortSelector histogram_port_;
 
+  // |has_proxy_server_| specifies if there is a proxy server or not.
+  bool has_proxy_server_;
+
   // HostResolver fills out the |addresses_| after host resolution is completed.
   net::AddressList addresses_;
 
   // Callback to call when echo protocol is successefully finished or whenever
   // there is an error (this allows unittests to wait until echo protocol's
   // round trip is finished).
   net::CompletionCallback finished_callback_;
 
   // The time when the session was started.
   base::TimeTicks start_time_;
 
   // Data to track number of packets to send to the server and the packets we
   // have received from the server.
   uint32 packets_to_send_;
   uint32 packets_sent_;
   uint32 base_packet_number_;
   uint32 packets_received_mask_;
 
   // We use this factory to create timeout tasks for socket's ReadData.
   base::WeakPtrFactory<NetworkStats> weak_factory_;
 };
 
 class UDPStatsClient : public NetworkStats {
  public:
   // Constructs an UDPStatsClient object that collects metrics for UDP
   // connectivity.
   UDPStatsClient();
+  // UDPStatsClient is deleted when Finish() is called.
   virtual ~UDPStatsClient();
 
  protected:
   // Allow tests to access our innards for testing purposes.
   friend class NetworkStatsTestUDP;
 
   // Called after host is resolved. Creates UDClientSocket and connects to the
   // server. If successfully connected, then calls ConnectComplete() to start
   // the echo protocol. Returns |false| if there is any error.
   virtual bool DoConnect(int result) OVERRIDE;
 
   // This method calls NetworkStats::ReadComplete() to verify the data and calls
   // Finish() if there is an error or if read callback didn't return any data
   // (|result| is less than or equal to 0).
   virtual bool ReadComplete(int result) OVERRIDE;
 
   // Collects stats for UDP connectivity. This is called when all the data from
-  // server is read or when there is a failure during connect/read/write.
+  // server is read or when there is a failure during connect/read/write. This
+  // object is deleted at the end of this method.
   virtual void Finish(Status status, int result) OVERRIDE;
 };
 
 class TCPStatsClient : public NetworkStats {
  public:
   // Constructs a TCPStatsClient object that collects metrics for TCP
   // connectivity.
   TCPStatsClient();
+  // TCPStatsClient is deleted when Finish() is called.
   virtual ~TCPStatsClient();
 
  protected:
   // Allow tests to access our innards for testing purposes.
   friend class NetworkStatsTestTCP;
 
   // Called after host is resolved. Creates TCPClientSocket and connects to the
   // server.
   virtual bool DoConnect(int result) OVERRIDE;
 
   // This method calls NetworkStats::ReadComplete() to verify the data and calls
   // Finish() if there is an error (|result| is less than 0).
   virtual bool ReadComplete(int result) OVERRIDE;
 
   // Collects stats for TCP connectivity. This is called when all the data from
-  // server is read or when there is a failure during connect/read/write.
+  // server is read or when there is a failure during connect/read/write. This
+  // object is deleted at the end of this method.
   virtual void Finish(Status status, int result) OVERRIDE;
 
  private:
   // Callback that is called when connect is completed and calls
   // ConnectComplete() to start the echo protocol.
   void OnConnectComplete(int result);
 };
 
+class ProxyDetector {
+ public:
+  // Used for the callback that is called from |OnResolveProxyComplete|.
+  typedef base::Callback<void(bool)> ProxyDetectorCallback;

[eroman, 2012/05/08 01:02:27]

[optional] nit: since this is already enclosed in the "ProxyDetector" class, the
"ProxyDetector" prefix is a bit redundant. I suggest shortening it to something
like ResultCallback or OnResolvedCallback

[ramant (doing other things), 2012/05/08 05:28:19]

Done.

+
+  // Constructs a ProxyDetector object that finds out if access to
+  // |server_address| goes through a proxy server or not. Calls the |callback|
+  // after proxy resolution is completed by currying the proxy resolution
+  // status.
+  ProxyDetector(net::ProxyService* proxy_service,
+                const net::HostPortPair& server_address,
+                ProxyDetectorCallback callback);
+
+  // This method uses |proxy_service_| to resolve the proxy for
+  // |server_address_|.
+  void ResolveProxy();
+
+ private:
+  // This object is deleted from |OnResolveProxyComplete|.
+  ~ProxyDetector();
+
+  // Calls the |callback_| by currying the proxy resolution status.
+  void OnResolveProxyComplete(int result);
+
+  // |proxy_service_| specifies the proxy service that is to be used to find
+  // if access to |server_address_| goes through proxy server or not.
+  net::ProxyService* proxy_service_;
+
+  // |server_address_| specifies the server host and port pair for which we are
+  // trying to see if access to it, goes through proxy or not.
+  net::HostPortPair server_address_;
+
+  // |callback_| will be called after proxy resolution is completed.
+  ProxyDetectorCallback callback_;
+
+  // |proxy_info_| holds proxy information returned by ResolveProxy.
+  net::ProxyInfo proxy_info_;
+
+  // Indicates if there is a pending a proxy resolution. We use this to assert
+  // that there is no in-progress proxy resolution request.
+  bool has_pending_proxy_resolution_;
+};
+
 // This collects the network connectivity stats for UDP and TCP for small
 // percentage of users who are participating in the experiment. All users must
 // have enabled "UMA upload". This method gets called only if UMA upload to the
 // server has succeeded.
 void CollectNetworkStats(const std::string& network_stats_server_url,
                          IOThread* io_thread);
 
+// This starts a test randomly selected among "TCP test with small packet size",
+// "TCP test with large packet size", "UDP test with small packet size", "UDP
+// test with large packet size" and "UDP multi packet loss" tests to collect the
+// network connectivity stats.
+void StartNetworkStatsTest(net::HostResolver* host_resolver,
+                           const net::HostPortPair& server_address,
+                           NetworkStats::HistogramPortSelector histogram_port,
+                           bool has_proxy_server);
+
 }  // namespace chrome_browser_net
 
 #endif  // CHROME_BROWSER_NET_NETWORK_STATS_H_