From bb82e7df9dd4aa1fd8b02a50c49874d019e61148 Mon Sep 17 00:00:00 2001 From: olly Date: Fri, 25 Jun 2021 16:07:58 +0100 Subject: [PATCH] Cronet: Align terminology with documentation PiperOrigin-RevId: 381472436 --- extensions/cronet/README.md | 8 +----- .../ext/cronet/CronetEngineWrapper.java | 8 +++--- .../exoplayer2/ext/cronet/CronetUtil.java | 26 ++++++++++--------- 3 files changed, 19 insertions(+), 23 deletions(-) diff --git a/extensions/cronet/README.md b/extensions/cronet/README.md index bdacfdbd8b..cc3c8b2137 100644 --- a/extensions/cronet/README.md +++ b/extensions/cronet/README.md @@ -3,7 +3,7 @@ The Cronet extension is an [HttpDataSource][] implementation using [Cronet][]. [HttpDataSource]: https://exoplayer.dev/doc/reference/com/google/android/exoplayer2/upstream/HttpDataSource.html -[Cronet]: https://chromium.googlesource.com/chromium/src/+/master/components/cronet?autodive=0%2F%2F +[Cronet]: https://developer.android.com/guide/topics/connectivity/cronet ## Getting the extension ## @@ -76,12 +76,6 @@ approximately 8MB to your application, however it may be suitable if: not widely available. * You want to control the exact version of the Cronet implementation being used. -If you do embed the library, you can specify which implementation should -be preferred if the Google Play Services implementation is also available. This -is controlled by a `preferGMSCoreCronet` parameter, which can be passed to the -`CronetEngineWrapper` constructor (GMS Core is another name for Google Play -Services). - ## Links ## * [Javadoc][]: Classes matching `com.google.android.exoplayer2.ext.cronet.*` diff --git a/extensions/cronet/src/main/java/com/google/android/exoplayer2/ext/cronet/CronetEngineWrapper.java b/extensions/cronet/src/main/java/com/google/android/exoplayer2/ext/cronet/CronetEngineWrapper.java index 21b90c834c..8851ac2efe 100644 --- a/extensions/cronet/src/main/java/com/google/android/exoplayer2/ext/cronet/CronetEngineWrapper.java +++ b/extensions/cronet/src/main/java/com/google/android/exoplayer2/ext/cronet/CronetEngineWrapper.java @@ -53,12 +53,12 @@ public final class CronetEngineWrapper { * @param context A context. * @param userAgent A default user agent, or {@code null} to use a default user agent of the * {@link CronetEngine}. - * @param preferGMSCoreCronet Whether Cronet from GMSCore should be preferred over natively - * bundled Cronet if both are available. + * @param preferGooglePlayServices Whether Cronet from Google Play Services should be preferred + * over Cronet Embedded, if both are available. */ public CronetEngineWrapper( - Context context, @Nullable String userAgent, boolean preferGMSCoreCronet) { - cronetEngine = CronetUtil.buildCronetEngine(context, userAgent, preferGMSCoreCronet); + Context context, @Nullable String userAgent, boolean preferGooglePlayServices) { + cronetEngine = CronetUtil.buildCronetEngine(context, userAgent, preferGooglePlayServices); } /** diff --git a/extensions/cronet/src/main/java/com/google/android/exoplayer2/ext/cronet/CronetUtil.java b/extensions/cronet/src/main/java/com/google/android/exoplayer2/ext/cronet/CronetUtil.java index 05dda1ff0b..b448c67e2d 100644 --- a/extensions/cronet/src/main/java/com/google/android/exoplayer2/ext/cronet/CronetUtil.java +++ b/extensions/cronet/src/main/java/com/google/android/exoplayer2/ext/cronet/CronetUtil.java @@ -50,13 +50,13 @@ public final class CronetUtil { * @param context A context. * @param userAgent A default user agent, or {@code null} to use a default user agent of the * {@link CronetEngine}. - * @param preferGMSCoreCronet Whether Cronet from GMSCore should be preferred over natively - * bundled Cronet, if both are available. + * @param preferGooglePlayServices Whether Cronet from Google Play Services should be preferred + * over Cronet Embedded, if both are available. * @return The {@link CronetEngine}, or {@code null} if no suitable engine could be built. */ @Nullable public static CronetEngine buildCronetEngine( - Context context, @Nullable String userAgent, boolean preferGMSCoreCronet) { + Context context, @Nullable String userAgent, boolean preferGooglePlayServices) { List cronetProviders = new ArrayList<>(CronetProvider.getAllProviders(context)); // Remove disabled and fallback Cronet providers from list. for (int i = cronetProviders.size() - 1; i >= 0; i--) { @@ -66,7 +66,8 @@ public final class CronetUtil { } } // Sort remaining providers by type and version. - CronetProviderComparator providerComparator = new CronetProviderComparator(preferGMSCoreCronet); + CronetProviderComparator providerComparator = + new CronetProviderComparator(preferGooglePlayServices); Collections.sort(cronetProviders, providerComparator); for (int i = 0; i < cronetProviders.size(); i++) { String providerName = cronetProviders.get(i).getName(); @@ -81,12 +82,12 @@ public final class CronetUtil { } catch (SecurityException e) { Log.w( TAG, - "Failed to build CronetEngine. Please check if current process has " + "Failed to build CronetEngine. Please check that the process has " + "android.permission.ACCESS_NETWORK_STATE."); } catch (UnsatisfiedLinkError e) { Log.w( TAG, - "Failed to link Cronet binaries. Please check if native Cronet binaries are " + "Failed to link Cronet binaries. Please check that native Cronet binaries are" + "bundled into your app."); } } @@ -103,12 +104,13 @@ public final class CronetUtil { * copy because GMSCore CronetProvider classes are unavailable in some (internal to Google) * build configurations. */ - private static final String GMS_CORE_PROVIDER_NAME = "Google-Play-Services-Cronet-Provider"; + private static final String GOOGLE_PLAY_SERVICES_PROVIDER_NAME = + "Google-Play-Services-Cronet-Provider"; - private final boolean preferGMSCoreCronet; + private final boolean preferGooglePlayServices; - public CronetProviderComparator(boolean preferGMSCoreCronet) { - this.preferGMSCoreCronet = preferGMSCoreCronet; + public CronetProviderComparator(boolean preferGooglePlayServices) { + this.preferGooglePlayServices = preferGooglePlayServices; } @Override @@ -128,8 +130,8 @@ public final class CronetUtil { String providerName = provider.getName(); if (CronetProvider.PROVIDER_NAME_APP_PACKAGED.equals(providerName)) { return 1; - } else if (GMS_CORE_PROVIDER_NAME.equals(providerName)) { - return preferGMSCoreCronet ? 0 : 2; + } else if (GOOGLE_PLAY_SERVICES_PROVIDER_NAME.equals(providerName)) { + return preferGooglePlayServices ? 0 : 2; } else { return 3; }