CronetEngine

const val ACTIVE_REQUEST_COUNT_UNKNOWN = -1: Int

La valeur du nombre de requêtes actives est inconnue

const val CONNECTION_METRIC_UNKNOWN = -1: Int

La valeur d'une métrique de connexion est inconnue.

const val EFFECTIVE_CONNECTION_TYPE_2G = 3: Int

Le type de connexion effectif estimé est la 2G.

const val EFFECTIVE_CONNECTION_TYPE_3G = 4: Int

Le type de connexion effectif estimé est la 3G.

const val EFFECTIVE_CONNECTION_TYPE_4G = 5: Int

Le type de connexion effectif estimé est la 4G.

const val EFFECTIVE_CONNECTION_TYPE_OFFLINE = 1: Int

L'appareil est hors connexion.

const val EFFECTIVE_CONNECTION_TYPE_SLOW_2G = 2: Int

Le type de connexion compatible estimé est la 2G lente.

const val EFFECTIVE_CONNECTION_TYPE_UNKNOWN = 0: Int

L'estimation du type de connexion effectif est inconnue.

const val UNBIND_NETWORK_HANDLE = -1: Long

Valeur à utiliser pour annuler toute liaison réseau précédente.

fun addRequestFinishedListener(listener: RequestFinishedInfo.Listener!): Unit

Enregistre un écouteur qui est appelé après la fin de chaque requête avec les informations de la requête.

L'écouteur est appelé sur un java.util.concurrent.Executor fourni par l'écouteur.

fun addRttListener(listener: NetworkQualityRttListener!): Unit

Enregistre un écouteur qui est appelé chaque fois que l'estimateur de qualité du réseau constate un temps d'aller-retour d'échantillon. Cette méthode doit être appelée après enableNetworkQualityEstimator, sinon une exception sera générée. Les temps d'aller-retour peuvent être enregistrés à différents niveaux de la pile réseau, y compris TCP, QUIC et au niveau de la requête d'URL. L'écouteur est appelé sur le java.util.concurrent.Executor transmis à enableNetworkQualityEstimator.

fun addThroughputListener(listener: NetworkQualityThroughputListener!): Unit

Enregistre un écouteur qui est appelé chaque fois que l'estimateur de qualité du réseau observe une mesure du débit d'échantillon. Cette méthode doit être appelée après enableNetworkQualityEstimator. Les observations du débit sont calculées en mesurant les octets lus sur l'interface réseau active lorsque au moins une réponse d'URL est reçue. L'écouteur est appelé sur le java.util.concurrent.Executor transmis à enableNetworkQualityEstimator.

fun bindToNetwork(networkHandle: Long): Unit

Lie le moteur au handle réseau spécifié. Toutes les demandes créées via ce moteur utiliseront le réseau associé à ce compte. Si ce réseau se déconnecte, toutes les requêtes échoueront. L'erreur exacte dépendra de l'étape de traitement de la requête au moment de la déconnexion du réseau. Les identifiants réseau peuvent être obtenus via Network#getNetworkHandle. Disponible uniquement à partir d'Android Marshmallow.

fun configureNetworkQualityEstimatorForTesting(
    useLocalHostRequests: Boolean,
    useSmallerResponses: Boolean,
    disableOfflineCheck: Boolean
): Unit

Configure l'estimateur de qualité du réseau pour les tests. Cette méthode doit être appelée avant l'ajout des écouteurs de temps d'aller-retour et de débit, et après l'activation de l'estimateur de qualité du réseau.

abstract fun createURLStreamHandlerFactory(): URLStreamHandlerFactory!

Crée un URLStreamHandlerFactory pour gérer le trafic HTTP et HTTPS. Une instance de cette classe peut être installée via setURLStreamHandlerFactory, ce qui permet d'utiliser cette CronetEngine par défaut pour toutes les requêtes créées via openConnection.

Cronet n'utilise pas certaines fonctionnalités HTTP fournies par le système :

• le cache HTTP installé via HttpResponseCache.install() ;
• la méthode d'authentification HTTP installée via setDefault ;
• le stockage des cookies HTTP installé via setDefault

Bien que Cronet accepte et encourage les requêtes utilisant le protocole HTTPS, il n'est pas compatible avec l'API HttpsURLConnection. Ce manque de compatibilité inclut également l'impossibilité d'utiliser certaines fonctionnalités HTTPS fournies par le système :

• le vérificateur de nom d'hôte HTTPS installé via HttpsURLConnection.setDefaultHostnameVerifier().
• la fabrique de sockets HTTPS installée via HttpsURLConnection.setDefaultSSLSocketFactory()

fun getActiveRequestCount(): Int

Renvoie le nombre de requêtes actives.

Une requête devient "active" dans UrlRequest.start(), en supposant que cette méthode ne génère pas d'exception. Il devient inactif lorsque tous les rappels ont été renvoyés et qu'aucun autre rappel ne peut être déclenché à l'avenir. En pratique, cela signifie que la requête est inactive une fois que onSucceeded/onCanceled/onFailed a renvoyé une réponse et que tous les écouteurs de requête terminée ont renvoyé une réponse. Pour en savoir plus, consultez Cycle de vie des requêtes Cronet.

fun getDownstreamThroughputKbps(): Int

Renvoie l'estimation du débit descendant (en kilobits par seconde) calculée par l'estimateur de qualité du réseau. Définissez sur CONNECTION_METRIC_UNKNOWN si la valeur n'est pas disponible. Cette méthode doit être appelée après enableNetworkQualityEstimator, sinon une exception sera générée.

fun getEffectiveConnectionType(): Int

Renvoie une estimation du type de connexion effectif calculé par l'estimateur de qualité du réseau. Appelez enableNetworkQualityEstimator pour commencer à calculer cette valeur.

fun getHttpRttMs(): Int

Renvoie l'estimation du temps d'aller-retour HTTP (en millisecondes) calculée par l'estimateur de qualité du réseau. Définissez sur CONNECTION_METRIC_UNKNOWN si la valeur n'est pas disponible. Cette méthode doit être appelée après enableNetworkQualityEstimator, sinon une exception sera générée.

fun getTransportRttMs(): Int

Renvoie l'estimation du RTT de transport (en millisecondes) calculée par l'estimateur de qualité du réseau. Définissez sur CONNECTION_METRIC_UNKNOWN si la valeur n'est pas disponible. Cette méthode doit être appelée après enableNetworkQualityEstimator, sinon une exception sera générée.

abstract fun newUrlRequestBuilder(
    url: String!,
    callback: UrlRequest.Callback!,
    executor: Executor!
): UrlRequest.Builder!

Crée un compilateur pour UrlRequest. Tous les rappels pour les objets UrlRequest générés seront appelés sur les threads de executor. executor ne doit pas exécuter de tâches sur le thread appelant execute pour éviter de bloquer les opérations réseau et de provoquer des exceptions lors de l'arrêt.

abstract fun openConnection(url: URL!): URLConnection!

Établit une nouvelle connexion à la ressource spécifiée par URLurl.

Remarque : L'implémentation java.net.HttpURLConnection de Cronet est soumise à certaines limites. Pour en savoir plus, consultez createURLStreamHandlerFactory.

fun removeRequestFinishedListener(listener: RequestFinishedInfo.Listener!): Unit

Supprime un écouteur de requête terminée.

fun removeRttListener(listener: NetworkQualityRttListener!): Unit

Supprime un écouteur des temps d'aller-retour s'il a été précédemment enregistré avec addRttListener. Cette méthode doit être appelée après l'ajout d'un NetworkQualityRttListener afin d'arrêter de recevoir des observations.

fun removeThroughputListener(listener: NetworkQualityThroughputListener!): Unit

Supprime un écouteur de débit. Cette méthode doit être appelée après l'ajout d'un NetworkQualityThroughputListener avec addThroughputListener afin d'arrêter de recevoir des observations.

abstract fun shutdown(): Unit

Arrête le CronetEngine s'il n'y a aucune requête active, sinon génère une exception.

Ne peut pas être appelé sur le thread réseau (le thread sur lequel Cronet appelle Executor, qui est différent du thread sur lequel Executor appelle les rappels). Peut bloquer jusqu'à ce que toutes les ressources de CronetEngine aient été nettoyées.

fun startNetLogToDisk(dirPath: String!, logAll: Boolean, maxSize: Int): Unit

Démarre la journalisation NetLog dans un répertoire spécifié avec une taille limitée. Le NetLog contient les événements émis par tous les CronetEngines actifs. NetLog est utile pour le débogage. Une fois la journalisation arrêtée stopNetLog, les données sont écrites dans netlog.json dans dirPath. Si la journalisation est interrompue, vous pouvez assembler manuellement les fichiers trouvés dans le sous-répertoire .inprogress à l'aide de https://chromium.googlesource.com/chromium/src/+/main/net/tools/stitch_net_log_files.py. Vous pouvez consulter le journal dans un navigateur Chrome en accédant à chrome://net-internals/#import.

abstract fun startNetLogToFile(fileName: String!, logAll: Boolean): Unit

Démarre la consignation NetLog dans un fichier. Le NetLog contient les événements émis par tous les CronetEngines actifs. NetLog est utile pour le débogage. Vous pouvez afficher le fichier dans un navigateur Chrome en accédant à chrome://net-internals/#import.

abstract fun stopNetLog(): Unit

Arrête la journalisation NetLog et vide le fichier sur le disque. Si aucune session de journalisation n'est en cours, cet appel est ignoré.