Added Network Quality Estimator Real-time interface to Cronet

components/cronet/android/java/src/org/chromium/net/CronetUrlRequestContext.java

 // Copyright 2014 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.content.Context;
 import android.os.Build;
 import android.os.ConditionVariable;
 import android.os.Handler;
 import android.os.Looper;
 import android.os.Process;
 import android.util.Log;
 
+import org.chromium.base.ObserverList;
 import org.chromium.base.VisibleForTesting;
 import org.chromium.base.annotations.CalledByNative;
 import org.chromium.base.annotations.JNINamespace;
 import org.chromium.base.annotations.NativeClassQualifiedName;
 import org.chromium.base.annotations.UsedByReflection;
 
 import java.util.concurrent.Executor;
+import java.util.concurrent.RejectedExecutionException;
 import java.util.concurrent.atomic.AtomicInteger;
 
 /**
  * UrlRequestContext using Chromium HTTP stack implementation.
  */
 @JNINamespace("cronet")
 @UsedByReflection("UrlRequestContext.java")
 class CronetUrlRequestContext extends UrlRequestContext {
     private static final int LOG_NONE = 3;  // LOG(FATAL), no VLOG.
     private static final int LOG_DEBUG = -1;  // LOG(FATAL...INFO), VLOG(1)
     private static final int LOG_VERBOSE = -2;  // LOG(FATAL...INFO), VLOG(2)
     static final String LOG_TAG = "ChromiumNetwork";
 
     /**
      * Synchronize access to mUrlRequestContextAdapter and shutdown routine.
      */
     private final Object mLock = new Object();
     private final ConditionVariable mInitCompleted = new ConditionVariable(false);
     private final AtomicInteger mActiveRequestCount = new AtomicInteger(0);
 
     private long mUrlRequestContextAdapter = 0;
     private Thread mNetworkThread;
 
+    private Executor mNetworkQualityExecutor;
+    private final Object mNetworkQualityLock = new Object();

[pauljensen, 2015/09/02 16:54:48]

Please add a comment about what this is locking.

[bengr, 2015/09/14 21:04:35]

Done.

+
+    private final ObserverList<NetworkQualityRTTObserver> mRTTObserverList =

[pauljensen, 2015/09/02 16:54:48]

Can we use @GuardedBy?

[bengr, 2015/09/14 21:04:35]

Done.

+            new ObserverList<NetworkQualityRTTObserver>();
+    private final ObserverList<NetworkQualityThroughputObserver> mThroughputObserverList =
+            new ObserverList<NetworkQualityThroughputObserver>();
+
     @UsedByReflection("UrlRequestContext.java")
     public CronetUrlRequestContext(Context context,
                                    UrlRequestContextConfig config) {
         CronetLibraryLoader.ensureInitialized(context, config);
         nativeSetMinLogLevel(getLoggingLevel());
         mUrlRequestContextAdapter = nativeCreateRequestContextAdapter(config.toString());
         if (mUrlRequestContextAdapter == 0) {
             throw new NullPointerException("Context Adapter creation failed.");
         }
 
@@ skipping 86 matching lines @@
     }
 
     @Override
     public void stopNetLog() {
         synchronized (mLock) {
             checkHaveAdapter();
             nativeStopNetLog(mUrlRequestContextAdapter);
         }
     }
 
+    @Override
+    public void enableNetworkQualityEstimator(Executor executor) {
+        enableNetworkQualityEstimator(false, false, executor);
+    }
+
+    @Override
+    void enableNetworkQualityEstimator(
+            boolean useLocalHostRequests, boolean useSmallerResponses, Executor executor) {
+        mNetworkQualityExecutor = executor;
+        synchronized (mLock) {
+            checkHaveAdapter();
+            nativeEnableNetworkQualityEstimator(
+                    mUrlRequestContextAdapter, useLocalHostRequests, useSmallerResponses);
+        }
+    }
+
+    @Override
+    public void addRTTObserver(NetworkQualityRTTObserver observer) {
+        if (mRTTObserverList.isEmpty()) {

[pauljensen, 2015/09/02 16:54:48]

You lock mRTTObserverList on line 186 but not here?  Ditto for other functions
and mThroughputObserverList.

[bengr, 2015/09/14 21:04:35]

Good catch. Thanks.

+            synchronized (mLock) {
+                checkHaveAdapter();
+                nativeProvideRTTObservations(mUrlRequestContextAdapter, true);
+            }
+        }
+        synchronized (mNetworkQualityLock) {
+            mRTTObserverList.addObserver(observer);
+        }
+    }
+
+    @Override
+    public void removeRTTObserver(NetworkQualityRTTObserver observer) {
+        synchronized (mNetworkQualityLock) {
+            mRTTObserverList.removeObserver(observer);
+        }
+        if (mRTTObserverList.isEmpty()) {
+            synchronized (mLock) {
+                checkHaveAdapter();
+                nativeProvideRTTObservations(mUrlRequestContextAdapter, false);
+            }
+        }
+    }
+
+    @Override
+    public void addThroughputObserver(NetworkQualityThroughputObserver observer) {
+        if (mThroughputObserverList.isEmpty()) {
+            synchronized (mLock) {
+                checkHaveAdapter();
+                nativeProvideThroughputObservations(mUrlRequestContextAdapter, true);
+            }
+        }
+        synchronized (mNetworkQualityLock) {
+            mThroughputObserverList.addObserver(observer);
+        }
+    }
+
+    @Override
+    public void removeThroughputObserver(NetworkQualityThroughputObserver observer) {
+        synchronized (mNetworkQualityLock) {
+            mThroughputObserverList.removeObserver(observer);
+        }
+        if (mThroughputObserverList.isEmpty()) {
+            synchronized (mLock) {
+                checkHaveAdapter();
+                nativeProvideThroughputObservations(mUrlRequestContextAdapter, false);
+            }
+        }
+    }
+
     /**
      * Mark request as started to prevent shutdown when there are active
      * requests.
      */
     void onRequestStarted(UrlRequest urlRequest) {
         mActiveRequestCount.incrementAndGet();
     }
 
     /**
      * Mark request as completed to allow shutdown when there are no active
@@ skipping 41 matching lines @@
     @CalledByNative
     private void initNetworkThread() {
         synchronized (mLock) {
             mNetworkThread = Thread.currentThread();
             mInitCompleted.open();
         }
         Thread.currentThread().setName("ChromiumNet");
         Process.setThreadPriority(Process.THREAD_PRIORITY_BACKGROUND);
     }
 
+    @SuppressWarnings("unused")
+    @CalledByNative
+    private void onRTTObservation(final int value, final long when, final int source) {
+        Runnable task = new Runnable() {
+            @Override
+            public void run() {
+                for (NetworkQualityRTTObserver observer : mRTTObserverList) {
+                    observer.onRTTObservation(value, when, source);
+                }
+            }
+        };
+        postObservationTaskToExecutor(task);
+    }
+
+    @SuppressWarnings("unused")
+    @CalledByNative
+    private void onThroughputObservation(final int value, final long when, final int source) {
+        Runnable task = new Runnable() {
+            @Override
+            public void run() {
+                for (NetworkQualityThroughputObserver observer : mThroughputObserverList) {
+                    observer.onThroughputObservation(value, when, source);
+                }
+            }
+        };
+        postObservationTaskToExecutor(task);
+    }
+
+    void postObservationTaskToExecutor(Runnable task) {
+        try {
+            synchronized (mNetworkQualityLock) {
+                mNetworkQualityExecutor.execute(task);
+            }
+        } catch (RejectedExecutionException failException) {
+            Log.e(CronetUrlRequestContext.LOG_TAG, "Exception posting task to executor",
+                    failException);
+        }
+    }
+
     // Native methods are implemented in cronet_url_request_context.cc.
     private static native long nativeCreateRequestContextAdapter(String config);
 
     private static native int nativeSetMinLogLevel(int loggingLevel);
 
     @NativeClassQualifiedName("CronetURLRequestContextAdapter")
     private native void nativeDestroy(long nativePtr);
 
     @NativeClassQualifiedName("CronetURLRequestContextAdapter")
     private native void nativeStartNetLogToFile(long nativePtr,
             String fileName, boolean logAll);
 
     @NativeClassQualifiedName("CronetURLRequestContextAdapter")
     private native void nativeStopNetLog(long nativePtr);
 
     @NativeClassQualifiedName("CronetURLRequestContextAdapter")
     private native void nativeInitRequestContextOnMainThread(long nativePtr);
+
+    @NativeClassQualifiedName("CronetURLRequestContextAdapter")
+    private native void nativeEnableNetworkQualityEstimator(
+            long nativePtr, boolean useLocalHostRequests, boolean useSmallerResponses);
+
+    @NativeClassQualifiedName("CronetURLRequestContextAdapter")
+    private native void nativeProvideRTTObservations(long nativePtr, boolean should);
+
+    @NativeClassQualifiedName("CronetURLRequestContextAdapter")
+    private native void nativeProvideThroughputObservations(long nativePtr, boolean should);
 }