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 rodzaj połączenia to 2G.

const val EFFECTIVE_CONNECTION_TYPE_3G = 4: Int

Szacowany rodzaj połączenia to 3G.

const val EFFECTIVE_CONNECTION_TYPE_4G = 5: Int

Szacowany rodzaj 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 rodzaj połączenia to wolna sieć 2G.

const val EFFECTIVE_CONNECTION_TYPE_UNKNOWN = 0: Int

Oszacowanie użytego rodzaju 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.

Słuchacz jest wywoływany na java.util.concurrent.Executor podany przez niego.

fun addRttListener(listener: NetworkQualityRttListener!): Unit

Rejestruje detektor, który jest wywoływany, gdy estymator jakości sieci zarejestruje próbkę czasu podróży w obie strony. Tę funkcję należy wywołać po wywołaniu funkcji 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 w przypadku protokołów TCP i QUIC oraz na warstwie żądania adresu URL. Detektor jest wywoływany na obiekcie java.util.concurrent.Executor, który jest przekazywany do enableNetworkQualityEstimator.

fun addThroughputListener(listener: NetworkQualityThroughputListener!): Unit

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

fun bindToNetwork(networkHandle: Long): Unit

Wiąże silnik z określonym uchwytem sieciowym. Wszystkie żądania utworzone za pomocą tego silnika 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, na którym nastąpi odłączenie sieci. Uchwyty sieci można uzyskać za pomocą Network#getNetworkHandle. Dostępne tylko na urządzeniach z Androidem Marshmallow.

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

Konfiguruje estymator 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()
• metodę uwierzytelniania HTTP zainstalowaną 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 w przyszłości nie będzie można wywołać żadnych dodatkowych wywołań zwrotnych. W praktyce oznacza to, że żądanie jest nieaktywne po zwróceniu wartości przez funkcje onSucceeded, onCanceled lub onFailed oraz po zwróceniu wartości przez wszystkich słuchaczy zakończenia żądania. Więcej informacji znajdziesz w sekcji Cykl życia żądań Cronet.

fun getDownstreamThroughputKbps(): Int

Zwraca szacunkową przepustowość pobierania (w kilobitach na sekundę) obliczoną przez narzędzie do szacowania jakości sieci. Jeśli wartość jest niedostępna, ustaw ją na CONNECTION_METRIC_UNKNOWN. Tę metodę należy wywołać po wywołaniu metody 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. Zadzwoń pod numer enableNetworkQualityEstimator, aby rozpocząć obliczanie tej wartości.

fun getHttpRttMs(): Int

Zwraca szacunkową wartość RTT HTTP (w milisekundach) obliczoną przez narzędzie do szacowania jakości sieci. Jeśli wartość jest niedostępna, ustaw ją na CONNECTION_METRIC_UNKNOWN. Tę metodę należy wywołać po wywołaniu metody 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. Jeśli wartość jest niedostępna, ustaw ją na CONNECTION_METRIC_UNKNOWN. Tę metodę należy wywołać po wywołaniu metody enableNetworkQualityEstimator. W przeciwnym razie zostanie zgłoszony 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. Szczegóły znajdziesz w sekcji createURLStreamHandlerFactory.

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

Usuwa odbiorcę zakończonego żądania.

fun removeRttListener(listener: NetworkQualityRttListener!): Unit

Usuwa odbiorcę czasu podróży w obie strony, jeśli został wcześniej zarejestrowany za pomocą addRttListener. Tę funkcję należy wywołać po dodaniu NetworkQualityRttListener, aby przestać otrzymywać obserwacje.

fun removeThroughputListener(listener: NetworkQualityThroughputListener!): Unit

Usuwa detektor przepustowości. Tę metodę należy wywołać po dodaniu NetworkQualityThroughputListener za pomocą metody 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 Executor (który różni się od wątku, w którym Executor wywołuje wywołania zwrotne). Może blokować do czasu wyczyszczenia wszystkich zasobów CronetEngine.

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

Uruchamia 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 narzędzia: https://chromium.googlesource.com/chromium/src/+/main/net/tools/stitch_net_log_files.py. Dziennik można wyświetlić w przeglądarce Chrome, otwierając stronę chrome://net-internals/#import.

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

Rozpoczyna rejestrowanie w NetLogu w pliku. 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, otwierając stronę 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.