CronetEngine

const val ACTIVE_REQUEST_COUNT_UNKNOWN = -1: Int

Der Wert der Anzahl aktiver Anfragen ist unbekannt.

const val CONNECTION_METRIC_UNKNOWN = -1: Int

Der Wert eines Verbindungsmesswerts ist unbekannt.

const val EFFECTIVE_CONNECTION_TYPE_2G = 3: Int

Der geschätzte effektive Verbindungstyp ist 2G.

const val EFFECTIVE_CONNECTION_TYPE_3G = 4: Int

Die Schätzung des effektiven Verbindungstyps ist „3G“.

const val EFFECTIVE_CONNECTION_TYPE_4G = 5: Int

Die Schätzung des effektiven Verbindungstyps ist 4G.

const val EFFECTIVE_CONNECTION_TYPE_OFFLINE = 1: Int

Das Gerät ist offline.

const val EFFECTIVE_CONNECTION_TYPE_SLOW_2G = 2: Int

Die Schätzung des effektiven Verbindungstyps ist „Langsame 2G-Verbindung“.

const val EFFECTIVE_CONNECTION_TYPE_UNKNOWN = 0: Int

Die Schätzung des effektiven Verbindungstyps ist unbekannt.

const val UNBIND_NETWORK_HANDLE = -1: Long

Der Wert, der zum Aufheben einer vorherigen Netzwerkbindung verwendet werden soll.

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

Registriert einen Listener, der nach dem Ende jeder Anfrage mit den Anfrageinformationen aufgerufen wird.

Der Listener wird für ein java.util.concurrent.Executor aufgerufen, das vom Listener bereitgestellt wird.

fun addRttListener(listener: NetworkQualityRttListener!): Unit

Registriert einen Listener, der aufgerufen wird, wenn der Schätzer für die Netzwerkqualität eine Stichproben-Roundtrip-Zeit erfasst. Diese Methode muss nach enableNetworkQualityEstimator aufgerufen werden. Andernfalls wird eine Ausnahme ausgelöst. Die Round-Trip-Zeiten können auf verschiedenen Ebenen des Netzwerk-Stacks aufgezeichnet werden, einschließlich TCP, QUIC und auf der Ebene der URL-Anfrage. Der Listener wird für das java.util.concurrent.Executor aufgerufen, das an enableNetworkQualityEstimator übergeben wird.

fun addThroughputListener(listener: NetworkQualityThroughputListener!): Unit

Registriert einen Listener, der aufgerufen wird, wenn der Schätzer für die Netzwerkqualität eine Messung des Durchsatzes einer Stichprobe beobachtet. Diese Funktion muss nach enableNetworkQualityEstimator aufgerufen werden. Der Durchsatz wird berechnet, indem die über die aktive Netzwerkschnittstelle gelesenen Byte zu Zeiten gemessen werden, zu denen mindestens eine URL-Antwort empfangen wird. Der Listener wird für das java.util.concurrent.Executor aufgerufen, das an enableNetworkQualityEstimator übergeben wird.

fun bindToNetwork(networkHandle: Long): Unit

Bindet die Engine an das angegebene Netzwerk-Handle. Für alle Anfragen, die über diese Engine erstellt werden, wird das mit diesem Alias verknüpfte Netzwerk verwendet. Wenn die Verbindung zum Netzwerk getrennt wird, schlagen alle Anfragen fehl. Der genaue Fehler hängt davon ab, in welcher Phase der Anfrageverarbeitung die Verbindung zum Netzwerk getrennt wird. Netzwerk-Handles können über Network#getNetworkHandle abgerufen werden. Nur ab Android Marshmallow verfügbar.

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

Konfiguriert den Schätzer für die Netzwerkqualität für Tests. Diese Methode muss aufgerufen werden, bevor Listener für die Round-Trip-Zeit und den Durchsatz hinzugefügt werden, und nachdem der Schätzer für die Netzwerkqualität aktiviert wurde.

abstract fun createURLStreamHandlerFactory(): URLStreamHandlerFactory!

Erstellt eine URLStreamHandlerFactory zur Verarbeitung von HTTP- und HTTPS-Traffic. Eine Instanz dieser Klasse kann über setURLStreamHandlerFactory installiert werden. Diese CronetEngine wird dann standardmäßig für alle Anfragen verwendet, die über openConnection erstellt werden.

Cronet verwendet bestimmte HTTP-Funktionen, die über das System bereitgestellt werden, nicht:

• Der HTTP-Cache, der über HttpResponseCache.install() installiert wurde
• die über setDefault installierte HTTP-Authentifizierungsmethode
• der über setDefault installierte HTTP-Cookie-Speicher

Cronet unterstützt und empfiehlt zwar Anfragen über das HTTPS-Protokoll, bietet aber keine Unterstützung für die HttpsURLConnection API. Diese fehlende Unterstützung umfasst auch die Nichtverwendung bestimmter HTTPS-Funktionen, die über das System bereitgestellt werden:

• der über HttpsURLConnection.setDefaultHostnameVerifier() installierte HTTPS-Hostname-Verifier
• die über HttpsURLConnection.setDefaultSSLSocketFactory() installierte HTTPS-Socket-Factory

fun getActiveRequestCount(): Int

Gibt die Anzahl der aktiven Anfragen zurück.

Eine Anfrage wird mit UrlRequest.start() „aktiv“, sofern für diese Methode keine Ausnahme ausgelöst wird. Sie wird inaktiv, wenn alle Callbacks zurückgegeben wurden und keine zusätzlichen Callbacks mehr ausgelöst werden können. In der Praxis bedeutet das, dass die Anfrage inaktiv ist, sobald „onSucceeded“/„onCanceled“/„onFailed“ zurückgegeben wurde und alle Listener für abgeschlossene Anfragen zurückgegeben wurden. Weitere Informationen finden Sie unter Lebenszyklus von Cronet-Anfragen.

fun getDownstreamThroughputKbps(): Int

Gibt die vom Schätzer für die Netzwerkqualität berechnete Schätzung für den Downstream-Durchsatz (in Kilobit pro Sekunde) zurück. Legen Sie den Wert auf CONNECTION_METRIC_UNKNOWN fest, wenn er nicht verfügbar ist. Diese Methode muss nach enableNetworkQualityEstimator aufgerufen werden. Andernfalls wird eine Ausnahme ausgelöst.

fun getEffectiveConnectionType(): Int

Gibt eine Schätzung des effektiven Verbindungstyps zurück, der vom Schätzer für die Netzwerkqualität berechnet wurde. Rufen Sie enableNetworkQualityEstimator auf, um diesen Wert zu berechnen.

fun getHttpRttMs(): Int

Gibt die vom Schätzer für die Netzwerkqualität berechnete geschätzte HTTP-RTT (in Millisekunden) zurück. Legen Sie den Wert auf CONNECTION_METRIC_UNKNOWN fest, wenn er nicht verfügbar ist. Diese Methode muss nach enableNetworkQualityEstimator aufgerufen werden. Andernfalls wird eine Ausnahme ausgelöst.

fun getTransportRttMs(): Int

Gibt die vom Schätzer für die Netzwerkqualität berechnete geschätzte Transport-RTT (in Millisekunden) zurück. Legen Sie den Wert auf CONNECTION_METRIC_UNKNOWN fest, wenn er nicht verfügbar ist. Diese Methode muss nach enableNetworkQualityEstimator aufgerufen werden. Andernfalls wird eine Ausnahme ausgelöst.

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

Erstellt einen Builder für UrlRequest. Alle Callbacks für generierte UrlRequest-Objekte werden in den Threads von executor aufgerufen. executor darf keine Aufgaben im Thread ausführen, der execute aufruft, um Netzwerkoperationen nicht zu blockieren und Ausnahmen beim Herunterfahren zu vermeiden.

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

Stellt eine neue Verbindung zur Ressource her, die durch URLurl angegeben wird.

Hinweis:Die java.net.HttpURLConnection-Implementierung von Cronet unterliegt bestimmten Einschränkungen. Weitere Informationen finden Sie unter createURLStreamHandlerFactory.

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

Entfernt einen Listener für abgeschlossene Anfragen.

fun removeRttListener(listener: NetworkQualityRttListener!): Unit

Entfernt einen Listener für Round-Trip-Zeiten, wenn er zuvor mit addRttListener registriert wurde. Diese Methode sollte aufgerufen werden, nachdem ein NetworkQualityRttListener hinzugefügt wurde, um keine Beobachtungen mehr zu empfangen.

fun removeThroughputListener(listener: NetworkQualityThroughputListener!): Unit

Entfernt einen Listener für den Durchsatz. Diese Methode sollte aufgerufen werden, nachdem ein NetworkQualityThroughputListener mit addThroughputListener hinzugefügt wurde, um keine Beobachtungen mehr zu empfangen.

abstract fun shutdown(): Unit

Fährt CronetEngine herunter, wenn keine aktiven Anfragen vorhanden sind. Andernfalls wird eine Ausnahme ausgelöst.

Kann nicht im Netzwerk-Thread aufgerufen werden – der Thread, in dem Cronet den Executor aufruft (der sich vom Thread unterscheidet, in dem der Executor Callbacks aufruft). Die Funktion wird möglicherweise blockiert, bis alle Ressourcen des CronetEngine bereinigt wurden.

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

Startet die NetLog-Protokollierung in einem angegebenen Verzeichnis mit einer begrenzten Größe. Das NetLog enthält Ereignisse, die von allen aktiven CronetEngines ausgegeben werden. Das NetLog ist für das Debugging nützlich. Sobald die Protokollierung beendet wurde stopNetLog, werden die Daten in dirPath in die Datei „netlog.json“ geschrieben. Wenn die Protokollierung unterbrochen wird, können Sie die Dateien im Unterverzeichnis „.inprogress“ manuell zusammenfügen. Verwenden Sie dazu https://chromium.googlesource.com/chromium/src/+/main/net/tools/stitch_net_log_files.py. Das Protokoll kann in einem Chrome-Browser unter chrome://net-internals/#import aufgerufen werden.

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

Startet die NetLog-Protokollierung in einer Datei. Das NetLog enthält Ereignisse, die von allen aktiven CronetEngines ausgegeben werden. Das NetLog ist für das Debugging nützlich. Die Datei kann in einem Chrome-Browser unter chrome://net-internals/#import aufgerufen werden.

abstract fun stopNetLog(): Unit

Beendet die NetLog-Protokollierung und schreibt die Datei auf die Festplatte. Wenn keine Protokollierungssitzung läuft, wird dieser Aufruf ignoriert.