CronetEngine

const val ACTIVE_REQUEST_COUNT_UNKNOWN = -1: Int

Wartość liczby aktywnych żądań jest nieznana

const val CONNECTION_METRIC_UNKNOWN = -1: Int

Wartość danych o połączeniu jest nieznana.

const val EFFECTIVE_CONNECTION_TYPE_2G = 3: Int

Szacowany typ połączenia to 2G.

const val EFFECTIVE_CONNECTION_TYPE_3G = 4: Int

Szacowany efektywny typ połączenia to 3G.

const val EFFECTIVE_CONNECTION_TYPE_4G = 5: Int

Szacowany efektywny typ połączenia to 4G.

const val EFFECTIVE_CONNECTION_TYPE_OFFLINE = 1: Int

Urządzenie jest offline.

const val EFFECTIVE_CONNECTION_TYPE_SLOW_2G = 2: Int

Szacowany efektywny typ połączenia to wolne 2G.

const val EFFECTIVE_CONNECTION_TYPE_UNKNOWN = 0: Int

Oszacowanie efektywnego typu połączenia jest nieznane.

const val UNBIND_NETWORK_HANDLE = -1: Long

Wartość, która ma zostać użyta do cofnięcia poprzedniego powiązania sieci.

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

Rejestruje odbiorcę, który jest wywoływany po zakończeniu każdej prośby z informacjami o niej.

Detektor jest wywoływany na java.util.concurrent.Executor dostarczonym przez detektor.

fun addRttListener(listener: NetworkQualityRttListener!): Unit

Rejestruje odbiornik, który jest wywoływany, gdy estymator jakości sieci zarejestruje próbkę czasu podróży w obie strony. Tę metodę należy wywołać po wywołaniu metody enableNetworkQualityEstimator. W przeciwnym razie zostanie zgłoszony wyjątek. Czasy podróży w obie strony mogą być rejestrowane na różnych warstwach stosu sieciowego, w tym TCP, QUIC i na warstwie żądania URL. Funkcja nasłuchująca jest wywoływana na obiekcie java.util.concurrent.Executor przekazywanym do funkcji enableNetworkQualityEstimator.

fun addThroughputListener(listener: NetworkQualityThroughputListener!): Unit

Rejestruje odbiorcę, który jest wywoływany za każdym razem, gdy estymator jakości sieci zarejestruje pomiar przepustowości próbki. Musi być wywoływana po enableNetworkQualityEstimator. Obserwacje przepustowości są obliczane na podstawie pomiaru liczby bajtów odczytanych przez aktywny interfejs sieciowy w czasie, gdy otrzymywana jest co najmniej 1 odpowiedź na adres URL. Funkcja nasłuchująca jest wywoływana na obiekcie java.util.concurrent.Executor przekazywanym do funkcji enableNetworkQualityEstimator.

fun bindToNetwork(networkHandle: Long): Unit

Wiąże silnik z określonym uchwytem sieci. Wszystkie żądania utworzone za pomocą tego mechanizmu będą korzystać z sieci powiązanej z tym uchwytem. Jeśli ta sieć zostanie odłączona, wszystkie żądania zakończą się niepowodzeniem. Dokładny błąd zależy od etapu przetwarzania żądania w momencie odłączenia sieci. Uchwyty sieci można uzyskać za pomocą Network#getNetworkHandle. Dostępne tylko na urządzeniach z Androidem Marshmallow i nowszym.

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

Konfiguruje narzędzie do szacowania jakości sieci na potrzeby testowania. Tę funkcję należy wywołać przed dodaniem odbiorników czasu podróży w obie strony i przepustowości oraz po włączeniu narzędzia do szacowania jakości sieci.

abstract fun createURLStreamHandlerFactory(): URLStreamHandlerFactory!

Tworzy URLStreamHandlerFactory do obsługi ruchu HTTP i HTTPS. Instancję tej klasy można zainstalować za pomocą setURLStreamHandlerFactory, dzięki czemu ten obiekt CronetEngine będzie domyślnie używany w przypadku wszystkich żądań utworzonych za pomocą openConnection.

Cronet nie korzysta z niektórych funkcji HTTP udostępnianych przez system:

• pamięć podręczna HTTP zainstalowana za pomocą HttpResponseCache.install();
• metoda uwierzytelniania HTTP zainstalowana za pomocą setDefault
• pamięć plików cookie HTTP zainstalowana za pomocą setDefault.

Cronet obsługuje i zaleca żądania korzystające z protokołu HTTPS, ale nie obsługuje interfejsu HttpsURLConnection API. Brak obsługi obejmuje też nieużywanie niektórych funkcji HTTPS udostępnianych przez system:

• weryfikator nazwy hosta HTTPS zainstalowany za pomocą HttpsURLConnection.setDefaultHostnameVerifier()
• fabryka gniazd HTTPS zainstalowana za pomocą HttpsURLConnection.setDefaultSSLSocketFactory().

fun getActiveRequestCount(): Int

Zwraca liczbę aktywnych żądań.

Żądanie staje się „aktywne” w metodzie UrlRequest.start(), pod warunkiem że nie zgłasza ona wyjątku. Staje się nieaktywny, gdy wszystkie wywołania zwrotne zostaną zwrócone i nie będzie można wywołać kolejnych. W praktyce oznacza to, że żądanie jest nieaktywne, gdy funkcja onSucceeded/onCanceled/onFailed zwróci wartość i wszyscy odbiorcy zakończenia żądania zwrócą wartość. Więcej informacji znajdziesz w sekcji Cykl życia żądań Cronet.

fun getDownstreamThroughputKbps(): Int

Zwraca oszacowaną przepustowość pobierania (w kilobitach na sekundę) obliczoną przez narzędzie do szacowania jakości sieci. Ustaw wartość CONNECTION_METRIC_UNKNOWN, jeśli wartość jest niedostępna. Tę funkcję należy wywołać po wywołaniu funkcji enableNetworkQualityEstimator. W przeciwnym razie zostanie zgłoszony wyjątek.

fun getEffectiveConnectionType(): Int

Zwraca szacunkową wartość efektywnego typu połączenia obliczoną przez narzędzie do szacowania jakości sieci. Aby rozpocząć obliczanie tej wartości, wywołaj funkcję enableNetworkQualityEstimator.

fun getHttpRttMs(): Int

Zwraca oszacowany czas RTT HTTP (w milisekundach) obliczony przez narzędzie do szacowania jakości sieci. Ustaw wartość CONNECTION_METRIC_UNKNOWN, jeśli wartość jest niedostępna. Tę funkcję należy wywołać po wywołaniu funkcji enableNetworkQualityEstimator. W przeciwnym razie zostanie zgłoszony wyjątek.

fun getTransportRttMs(): Int

Zwraca szacunkowy czas RTT transportu (w milisekundach) obliczony przez narzędzie do szacowania jakości sieci. Ustaw wartość CONNECTION_METRIC_UNKNOWN, jeśli wartość jest niedostępna. Tę funkcję należy wywołać po funkcji enableNetworkQualityEstimator. W przeciwnym razie zgłosi wyjątek.

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

Tworzy kreator dla UrlRequest. Wszystkie wywołania zwrotne dla wygenerowanych obiektów UrlRequest będą wywoływane w wątkach executor. executor nie może wykonywać zadań w wątku wywołującym execute, aby zapobiec blokowaniu operacji sieciowych i powodowaniu wyjątków podczas zamykania.

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

Nawiązuje nowe połączenie z zasobem określonym przez URLurl.

Uwaga: implementacja Croneta java.net.HttpURLConnection podlega pewnym ograniczeniom. Więcej informacji znajdziesz w sekcji createURLStreamHandlerFactory.

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

Usuwa odbiorcę zakończonej prośby.

fun removeRttListener(listener: NetworkQualityRttListener!): Unit

Usuwa odbiorcę czasów podróży w obie strony, jeśli został wcześniej zarejestrowany za pomocą addRttListener. Tę metodę należy wywołać po dodaniu obiektu NetworkQualityRttListener, aby zatrzymać odbieranie obserwacji.

fun removeThroughputListener(listener: NetworkQualityThroughputListener!): Unit

Usuwa odbiorcę przepustowości. Tę metodę należy wywołać po dodaniu NetworkQualityThroughputListener za pomocą addThroughputListener, aby przestać otrzymywać obserwacje.

abstract fun shutdown(): Unit

Zamyka CronetEngine, jeśli nie ma aktywnych żądań, w przeciwnym razie zgłasza wyjątek.

Nie można wywoływać w wątku sieciowym – wątku, w którym Cronet wywołuje wykonawcę (różni się on od wątku, w którym wykonawca wywołuje wywołania zwrotne). Może blokować do czasu wyczyszczenia wszystkich zasobów CronetEngine.

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

Rozpoczyna rejestrowanie w NetLog w określonym katalogu o ograniczonej wielkości. NetLog będzie zawierać zdarzenia emitowane przez wszystkie aktywne obiekty CronetEngine. NetLog jest przydatny do debugowania. Po zatrzymaniu rejestrowania stopNetLog dane zostaną zapisane w pliku netlog.json w folderze dirPath. Jeśli rejestrowanie zostanie przerwane, możesz ręcznie połączyć pliki znajdujące się w podkatalogu .inprogress, korzystając z tego skryptu: https://chromium.googlesource.com/chromium/src/+/main/net/tools/stitch_net_log_files.py. Dziennik można wyświetlić w przeglądarce Chrome, przechodząc do strony chrome://net-internals/#import.

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

Rozpoczyna rejestrowanie w pliku informacji z NetLog. NetLog będzie zawierać zdarzenia emitowane przez wszystkie aktywne obiekty CronetEngine. NetLog jest przydatny do debugowania. Plik można wyświetlić w przeglądarce Chrome, przechodząc do strony chrome://net-internals/#import.

abstract fun stopNetLog(): Unit

Zatrzymuje rejestrowanie w NetLogu i zapisuje plik na dysku. Jeśli sesja rejestrowania nie jest w toku, to wywołanie jest ignorowane.