Expose RTT and throughput estimates from Cronet

components/cronet/android/api/src/org/chromium/net/CronetEngine.java

 // 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.
 
 package org.chromium.net;
 
 import android.annotation.SuppressLint;
 import android.content.Context;
 import android.net.http.HttpResponseCache;
 import android.support.annotation.IntDef;
@@ skipping 762 matching lines @@
                 cronetEngine = new JavaCronetEngine(getUserAgent());
             }
             Log.i(TAG, "Using network stack: " + cronetEngine.getVersionString());
             // Clear MOCK_CERT_VERIFIER reference if there is any, since
             // the ownership has been transferred to the engine.
             mMockCertVerifier = 0;
             return cronetEngine;
         }
     }
 
+    /**
+     * RTT and throughput estimates are set to {@link INVALID_RTT_THROUGHPUT} if
+     * a valid value is unavailable,

[mgersh, 2016/10/17 16:53:09]

nit: comma should be period

[tbansal1, 2016/10/17 19:20:57]

Done.

+     */
+    public static final int INVALID_RTT_THROUGHPUT = -1;
+
     private static final String TAG = "UrlRequestFactory";
     private static final String CRONET_URL_REQUEST_CONTEXT =
             "org.chromium.net.impl.CronetUrlRequestContext";
 
     /**
      * Creates a {@link UrlRequest} object. All callbacks will
      * be called on {@code executor}'s thread. {@code executor} must not run
      * tasks on the current thread to prevent blocking networking operations
      * and causing exceptions during shutdown. Request is given medium priority,
      * see {@link UrlRequest.Builder#REQUEST_PRIORITY_MEDIUM}. To specify other
@@ skipping 193 matching lines @@
     public abstract byte[] getGlobalMetricsDeltas();
 
     /**
      * Returns the effective connection type computed by the network quality
      * estimator.
      * @hide as it's a prototype.
      */
     public abstract int getEffectiveConnectionType();
 
     /**
+     * Returns the HTTP RTT estimate (in milliseconds) computed by the network
+     * quality estimator. Set to {@link INVALID_RTT_THROUGHPUT} if a valid value

[mgersh, 2016/10/17 16:53:09]

This javadoc and the others could mention that you need to enable NQE before
using it.

[tbansal1, 2016/10/17 19:20:57]

Done.

+     * is unavailable.
+     * @hide as it's a prototype.
+     * @return Estimate of the HTTP RTT in milliseconds.
+     */
+    public abstract int getHttpRttMsec();

[mgersh, 2016/10/17 16:53:09]

Elsewhere in Cronet we use Ms, not Msec. Let's change this to Ms for
consistency.

[tbansal1, 2016/10/17 19:20:57]

Done.

+
+    /**
+     * Returns the transport RTT estimate (in milliseconds) computed by the
+     * network quality estimator. Set to {@link INVALID_RTT_THROUGHPUT} if a
+     * valid value is unavailable.
+     * @hide as it's a prototype.
+     * @return Estimate of the transport RTT in milliseconds.
+     */
+    public abstract int getTransportRttMsec();

[mgersh, 2016/10/17 16:53:09]

same as above: Msec -> Ms

[tbansal1, 2016/10/17 19:20:57]

Done.

+
+    /**
+     * Returns the downstream throughput estimate (in kilobits per second)
+     * computed by the network quality estimator. Set to
+     * {@link INVALID_RTT_THROUGHPUT} if a valid value is unavailable.
+     * @hide as it's a prototype.
+     * @return Estimate of the downstream throughput in kilobits per second.
+     */
+    public abstract int getDownstreamThroughputKbps();
+
+    /**
      * Configures the network quality estimator for testing. This must be called
      * before round trip time and throughput listeners are added, and after the
      * network quality estimator has been enabled.
      * @param useLocalHostRequests include requests to localhost in estimates.
      * @param useSmallerResponses include small responses in throughput
      * estimates.
      * @hide as it's a prototype.
      */
     public abstract void configureNetworkQualityEstimatorForTesting(
             boolean useLocalHostRequests, boolean useSmallerResponses);
@@ skipping 158 matching lines @@
      *
      * @param url URL for the generated requests.
      * @param callback callback object that gets invoked on different events.
      * @param executor {@link Executor} on which all callbacks will be invoked.
      */
     public UrlRequest.Builder newUrlRequestBuilder(
             String url, UrlRequest.Callback callback, Executor executor) {
         return new UrlRequest.Builder(url, callback, executor, this);
     }
 }