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;
 
+import javax.annotation.concurrent.GuardedBy;
+
 /**
  * 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 boolean mNetworkQualityEstimatorEnabled;
+
+    /** Locks operations on network quality listeners, because listener
+     * addition and removal may occur on a different thread from notification.
+     */
+    private final Object mNetworkQualityLock = new Object();
+
+    @GuardedBy("mNetworkQualityLock")
+    private final ObserverList<NetworkQualityRttListener> mRttListenerList =
+            new ObserverList<NetworkQualityRttListener>();
+
+    @GuardedBy("mNetworkQualityLock")
+    private final ObserverList<NetworkQualityThroughputListener> mThroughputListenerList =
+            new ObserverList<NetworkQualityThroughputListener>();
+
     @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) {
+        enableNetworkQualityEstimatorForTesting(false, false, executor);
+    }
+
+    @VisibleForTesting
+    @Override
+    void enableNetworkQualityEstimatorForTesting(
+            boolean useLocalHostRequests, boolean useSmallerResponses, Executor executor) {
+        if (mNetworkQualityEstimatorEnabled) {
+            throw new IllegalStateException("Network quality estimator already enabled");
+        }
+        mNetworkQualityEstimatorEnabled = true;
+        if (executor == null) {
+            throw new NullPointerException("Network quality estimator requires an executor");
+        }
+        mNetworkQualityExecutor = executor;
+        synchronized (mLock) {
+            checkHaveAdapter();
+            nativeEnableNetworkQualityEstimator(
+                    mUrlRequestContextAdapter, useLocalHostRequests, useSmallerResponses);
+        }
+    }
+
+    @Override
+    public void addRttListener(NetworkQualityRttListener listener) {
+        if (!mNetworkQualityEstimatorEnabled) {
+            throw new IllegalStateException("Network quality estimator must be enabled");
+        }
+        synchronized (mNetworkQualityLock) {
+            if (mRttListenerList.isEmpty()) {
+                synchronized (mLock) {
+                    checkHaveAdapter();
+                    nativeProvideRTTObservations(mUrlRequestContextAdapter, true);
+                }
+            }
+            mRttListenerList.addObserver(listener);
+        }
+    }
+
+    @Override
+    public void removeRttListener(NetworkQualityRttListener listener) {
+        if (!mNetworkQualityEstimatorEnabled) {
+            throw new IllegalStateException("Network quality estimator must be enabled");
+        }
+        synchronized (mNetworkQualityLock) {
+            mRttListenerList.removeObserver(listener);
+            if (mRttListenerList.isEmpty()) {
+                synchronized (mLock) {
+                    checkHaveAdapter();
+                    nativeProvideRTTObservations(mUrlRequestContextAdapter, false);
+                }
+            }
+        }
+    }
+
+    @Override
+    public void addThroughputListener(NetworkQualityThroughputListener listener) {
+        if (!mNetworkQualityEstimatorEnabled) {
+            throw new IllegalStateException("Network quality estimator must be enabled");
+        }
+        synchronized (mNetworkQualityLock) {
+            if (mThroughputListenerList.isEmpty()) {
+                synchronized (mLock) {
+                    checkHaveAdapter();
+                    nativeProvideThroughputObservations(mUrlRequestContextAdapter, true);
+                }
+            }
+            mThroughputListenerList.addObserver(listener);
+        }
+    }
+
+    @Override
+    public void removeThroughputListener(NetworkQualityThroughputListener listener) {
+        if (!mNetworkQualityEstimatorEnabled) {
+            throw new IllegalStateException("Network quality estimator must be enabled");
+        }
+        synchronized (mNetworkQualityLock) {
+            mThroughputListenerList.removeObserver(listener);
+            if (mThroughputListenerList.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 rttMs, final long whenMs, final int source) {
+        Runnable task = new Runnable() {
+            @Override
+            public void run() {
+                synchronized (mNetworkQualityLock) {
+                    for (NetworkQualityRttListener listener : mRttListenerList) {
+                        listener.onRttObservation(rttMs, whenMs, source);
+                    }
+                }
+            }
+        };
+        postObservationTaskToExecutor(task);
+    }
+
+    @SuppressWarnings("unused")
+    @CalledByNative
+    private void onThroughputObservation(
+            final int throughputKbps, final long whenMs, final int source) {
+        Runnable task = new Runnable() {
+            @Override
+            public void run() {
+                synchronized (mNetworkQualityLock) {
+                    for (NetworkQualityThroughputListener listener : mThroughputListenerList) {
+                        listener.onThroughputObservation(throughputKbps, whenMs, source);
+                    }
+                }
+            }
+        };
+        postObservationTaskToExecutor(task);
+    }
+
+    void postObservationTaskToExecutor(Runnable task) {

[pauljensen, 2015/10/06 19:10:28]

Executor->NetworkQualityExecutor
so as to differentiate from the same named function in CronetUrlRequest and to
indicate which executor this is

[pauljensen, 2015/10/06 20:06:09]

You didn't address this.

[bengr, 2015/10/06 20:33:14]

Done.

+        try {
+            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);
 }