Notify NQE of TCP RTT values

net/socket/tcp_socket_posix.h

 // Copyright 2013 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_SOCKET_TCP_SOCKET_POSIX_H_
 #define NET_SOCKET_TCP_SOCKET_POSIX_H_
 
 #include <stdint.h>
 
 #include "base/callback.h"
 #include "base/compiler_specific.h"
 #include "base/macros.h"
 #include "base/memory/scoped_ptr.h"
 #include "base/time/time.h"
 #include "net/base/address_family.h"
 #include "net/base/completion_callback.h"
 #include "net/base/net_export.h"
+#include "net/base/socket_performance_watcher.h"
 #include "net/log/net_log.h"
 
+namespace base {
+class TickClock;
+}
+
 namespace net {
 
 class AddressList;
 class IOBuffer;
 class IPEndPoint;
 class SocketPosix;
 
 class NET_EXPORT TCPSocketPosix {
  public:
-  TCPSocketPosix(NetLog* net_log, const NetLog::Source& source);
+  // |socket_performance_watcher| is notified of the performance metrics related
+  // to this socket. |socket_performance_watcher| may be null.
+  TCPSocketPosix(
+      scoped_ptr<SocketPerformanceWatcher> socket_performance_watcher,
+      NetLog* net_log,
+      const NetLog::Source& source);
   virtual ~TCPSocketPosix();
 
   int Open(AddressFamily family);
   // Takes ownership of |socket_fd|.
   int AdoptConnectedSocket(int socket_fd, const IPEndPoint& peer_address);
 
   int Bind(const IPEndPoint& address);
 
   int Listen(int backlog);
   int Accept(scoped_ptr<TCPSocketPosix>* socket,
@@ skipping 48 matching lines @@
   // succeeds in establishing a connection. The corresponding log will have
   // multiple NetLog::TYPE_TCP_CONNECT_ATTEMPT entries nested within a
   // NetLog::TYPE_TCP_CONNECT. These methods set the start/end of
   // NetLog::TYPE_TCP_CONNECT.
   //
   // TODO(yzshen): Change logging format and let TCPClientSocket log the
   // start/end of a series of connect attempts itself.
   void StartLoggingMultipleConnectAttempts(const AddressList& addresses);
   void EndLoggingMultipleConnectAttempts(int net_error);
 
+  void SetTickClockForTesting(scoped_ptr<base::TickClock> tick_clock);
+
   const BoundNetLog& net_log() const { return net_log_; }
 
  private:
   // States that using a socket with TCP FastOpen can lead to.
   enum TCPFastOpenStatus {
     TCP_FASTOPEN_STATUS_UNKNOWN,
 
     // The initial FastOpen connect attempted returned synchronously,
     // indicating that we had and sent a cookie along with the initial data.
     TCP_FASTOPEN_FAST_CONNECT_RETURN,
@@ skipping 62 matching lines @@
   void AcceptCompleted(scoped_ptr<TCPSocketPosix>* tcp_socket,
                        IPEndPoint* address,
                        const CompletionCallback& callback,
                        int rv);
   int HandleAcceptCompleted(scoped_ptr<TCPSocketPosix>* tcp_socket,
                             IPEndPoint* address,
                             int rv);
   int BuildTcpSocketPosix(scoped_ptr<TCPSocketPosix>* tcp_socket,
                           IPEndPoint* address);
 
-  void ConnectCompleted(const CompletionCallback& callback, int rv) const;
-  int HandleConnectCompleted(int rv) const;
+  void ConnectCompleted(const CompletionCallback& callback, int rv);
+  int HandleConnectCompleted(int rv);
   void LogConnectBegin(const AddressList& addresses) const;
   void LogConnectEnd(int net_error) const;
 
   void ReadCompleted(const scoped_refptr<IOBuffer>& buf,
                      const CompletionCallback& callback,
                      int rv);
   int HandleReadCompleted(IOBuffer* buf, int rv);
 
   void WriteCompleted(const scoped_refptr<IOBuffer>& buf,
                       const CompletionCallback& callback,
                       int rv);
   int HandleWriteCompleted(IOBuffer* buf, int rv);
   int TcpFastOpenWrite(IOBuffer* buf,
                        int buf_len,
                        const CompletionCallback& callback);
 
+  // Notifies |socket_performance_watcher_| of the latest RTT estimate available
+  // from the tcp_info struct for this TCP socket.
+  void NotifySocketPerformanceWatcher();
+
   // Called after the first read completes on a TCP FastOpen socket.
   void UpdateTCPFastOpenStatusAfterRead();
 
+  // Minimum interval betweeen consecutive notifications to
+  // |socket_performance_watcher_|.
+  const base::TimeDelta rtt_notifications_minimum_interval_;

[Ryan Sleevi, 2016/04/11 22:06:56]

This seems like a very odd ordering to add this member.

Wouldn't it make more sense between 228 and 232?

[tbansal1, 2016/04/12 16:14:33]

Done.

+
   scoped_ptr<SocketPosix> socket_;
   scoped_ptr<SocketPosix> accept_socket_;
 
+  // Socket performance statistics (such as RTT) are reported to the
+  // |socket_performance_watcher_|. May be nullptr.
+  scoped_ptr<SocketPerformanceWatcher> socket_performance_watcher_;
+
+  scoped_ptr<base::TickClock> tick_clock_;
+
+  // Time when the |socket_performance_watcher_| was last notified of updated
+  // RTT.
+  base::TimeTicks last_rtt_notification_;
+
   // Enables experimental TCP FastOpen option.
   bool use_tcp_fastopen_;
 
   // True when TCP FastOpen is in use and we have attempted the
   // connect with write.
   bool tcp_fastopen_write_attempted_;
 
   // True when TCP FastOpen is in use and we have done the connect.
   bool tcp_fastopen_connected_;
 
   TCPFastOpenStatus tcp_fastopen_status_;
 
   bool logging_multiple_connect_attempts_;
 
   BoundNetLog net_log_;
 
   DISALLOW_COPY_AND_ASSIGN(TCPSocketPosix);
 };
 
 }  // namespace net
 
 #endif  // NET_SOCKET_TCP_SOCKET_POSIX_H_