JavaCronetEngine

class JavaCronetEngine : CronetEngineBase


java.net.HttpURLConnection obsługuje CronetEngine.

Nie obsługuje dzienników sieci, pomiaru przesyłanych danych, bidistream, pamięci podręcznej ani priorytetu.

Podsumowanie

Konstruktory publiczne

Funkcje publiczne

Unit

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

Unit

Rejestruje detektor, który jest wywoływany, gdy estymator jakości sieci zarejestruje próbkę czasu podróży w obie strony.

Unit

Rejestruje odbiorcę, który jest wywoływany za każdym razem, gdy estymator jakości sieci zarejestruje próbkę pomiaru przepustowości.

Unit
bindToNetwork(networkHandle: Long)

Wiąże silnik z określonym uchwytem sieciowym.

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

Konfiguruje estymator jakości sieci na potrzeby testowania.

ExperimentalUrlRequest!
createRequest(
    url: String!,
    callback: UrlRequest.Callback!,
    executor: Executor!,
    priority: Int,
    connectionAnnotations: (Mutable)Collection<Any!>!,
    disableCache: Boolean,
    disableConnectionMigration: Boolean,
    allowDirectExecutor: Boolean,
    trafficStatsTagSet: Boolean,
    trafficStatsTag: Int,
    trafficStatsUidSet: Boolean,
    trafficStatsUid: Int,
    requestFinishedListener: RequestFinishedInfo.Listener!,
    idempotency: Int,
    networkHandle: Long,
    method: String!,
    requestHeaders: ArrayList<(Mutable)Map.Entry<String!, String!>!>!,
    uploadDataProvider: UploadDataProvider!,
    uploadDataProviderExecutor: Executor!,
    sharedDictionaryHash: ByteArray!,
    sharedDictionary: ByteBuffer!,
    sharedDictionaryId: String
)
URLStreamHandlerFactory!

Tworzy URLStreamHandlerFactory do obsługi ruchu HTTP i HTTPS.

Int

Zwraca liczbę aktywnych żądań.

Int

Zwraca szacunkową przepustowość pobierania (w kilobitach na sekundę) obliczoną przez narzędzie do szacowania jakości sieci.

Int

Zwraca szacunkową wartość efektywnego typu połączenia obliczoną przez narzędzie do szacowania jakości sieci.

ByteArray<Byte>!

Ta funkcja została wycofana.

W nowoczesnych wersjach Croneta ta funkcja zawsze zwraca pustą tablicę.

Int

Zwraca szacunkową wartość RTT HTTP (w milisekundach) obliczoną przez narzędzie do szacowania jakości sieci.

Int

Zwraca szacunkowy czas RTT transportu (w milisekundach) obliczony przez narzędzie do szacowania jakości sieci.

String!
URLConnection!

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

URLConnection!
openConnection(url: URL!, proxy: Proxy!)

Ustanawia nowe połączenie z zasobem określonym przez URLurl przy użyciu podanego serwera proxy.

Unit

Usuwa odbiorcę zakończonego żądania.

Unit

Usuwa odbiorcę czasu podróży w obie strony, jeśli został wcześniej zarejestrowany za pomocą addRttListener.

Unit

Usuwa detektor przepustowości.

Unit

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

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

Uruchamia rejestrowanie w NetLog w określonym katalogu o ograniczonej wielkości.

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

Rozpoczyna rejestrowanie w NetLogu w pliku.

Unit

Zatrzymuje rejestrowanie w NetLogu i zapisuje plik na dysku.

Funkcje chronione

ExperimentalBidirectionalStream!
createBidirectionalStream(
    url: String!,
    callback: BidirectionalStream.Callback!,
    executor: Executor!,
    httpMethod: String!,
    requestHeaders: (Mutable)List<(Mutable)Map.Entry<String!, String!>!>!,
    @CronetEngineBase.StreamPriority priority: Int,
    delayRequestHeadersUntilFirstFlush: Boolean,
    connectionAnnotations: (Mutable)Collection<Any!>!,
    trafficStatsTagSet: Boolean,
    trafficStatsTag: Int,
    trafficStatsUidSet: Boolean,
    trafficStatsUid: Int,
    networkHandle: Long
)

Odziedziczone stałe

org.chromium.net.CronetEngine
const Int

Wartość liczby aktywnych żądań jest nieznana

org.chromium.net.impl.CronetEngineBase

Funkcje dziedziczone

org.chromium.net.impl.CronetEngineBase
ExperimentalUrlRequest.Builder!
newUrlRequestBuilder(
    url: String!,
    callback: UrlRequest.Callback!,
    executor: Executor!
)

Tworzy kreator dla UrlRequest.

Konstruktory publiczne

JavaCronetEngine

JavaCronetEngine(builder: CronetEngineBuilderImpl!)

Funkcje publiczne

addRequestFinishedListener

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.

Parametry
listener: RequestFinishedInfo.Listener!

odbiornik ukończonych żądań.

addRttListener

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.

Parametry
listener: NetworkQualityRttListener!

słuchacz czasów błądzenia.

addThroughputListener

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.

Parametry
listener: NetworkQualityThroughputListener!

odbiorca przepustowości.

bindToNetwork

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.

Parametry
networkHandle: Long

uchwyt sieci, do której ma być przypisany silnik; Aby usunąć powiązanie, wpisz UNBIND_NETWORK_HANDLE.

configureNetworkQualityEstimatorForTesting

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.

Parametry
useLocalHostRequests: Boolean

uwzględniać w szacunkach żądania wysyłane do hosta lokalnego.

useSmallerResponses: Boolean

uwzględniać małe odpowiedzi w szacunkach przepustowości;

disableOfflineCheck: Boolean

Gdy ma wartość Prawda, wyłącza sprawdzanie stanu offline urządzenia podczas obliczania efektywnego typu połączenia lub zapisywania ustawień.

createRequest

fun createRequest(
    url: String!,
    callback: UrlRequest.Callback!,
    executor: Executor!,
    priority: Int,
    connectionAnnotations: (Mutable)Collection<Any!>!,
    disableCache: Boolean,
    disableConnectionMigration: Boolean,
    allowDirectExecutor: Boolean,
    trafficStatsTagSet: Boolean,
    trafficStatsTag: Int,
    trafficStatsUidSet: Boolean,
    trafficStatsUid: Int,
    requestFinishedListener: RequestFinishedInfo.Listener!,
    idempotency: Int,
    networkHandle: Long,
    method: String!,
    requestHeaders: ArrayList<(Mutable)Map.Entry<String!, String!>!>!,
    uploadDataProvider: UploadDataProvider!,
    uploadDataProviderExecutor: Executor!,
    sharedDictionaryHash: ByteArray!,
    sharedDictionary: ByteBuffer!,
    sharedDictionaryId: String
): ExperimentalUrlRequest!

createURLStreamHandlerFactory

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:

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:

Zwraca
URLStreamHandlerFactory!

instancja URLStreamHandlerFactory zaimplementowana przez ten obiekt CronetEngine.

getActiveRequestCount

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.

getDownstreamThroughputKbps

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.

Zwraca
Int

Szacunkowa przepustowość pobierania w kilobitach na sekundę.

getEffectiveConnectionType

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.

Zwraca
Int

szacowany typ połączenia. Zwracana wartość to jedna z tych wartości: EFFECTIVE_CONNECTION_TYPE_* .

getGlobalMetricsDeltas

fun getGlobalMetricsDeltas(): ByteArray<Byte>!

getHttpRttMs

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.

Zwraca
Int

Szacunkowy czas RTT protokołu HTTP w milisekundach.

getTransportRttMs

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.

Zwraca
Int

Szacowany czas RTT transportu w milisekundach.

getVersionString

fun getVersionString(): String!
Zwraca
String!

zrozumiały dla człowieka ciąg tekstowy z wersją silnika.

openConnection

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.

Parametry
url: URL!

Adres URL zasobu, z którym zostanie nawiązane połączenie.

Zwraca
URLConnection!

instancja java.net.HttpURLConnection zaimplementowana przez ten obiekt CronetEngine.

Zgłasza
java.io.IOException

jeśli podczas otwierania połączenia wystąpi błąd.

openConnection

fun openConnection(url: URL!, proxy: Proxy!): URLConnection!

Ustanawia nowe połączenie z zasobem określonym przez URLurl przy użyciu podanego serwera proxy.

Uwaga: implementacja Croneta java.net.HttpURLConnection podlega pewnym ograniczeniom. Szczegóły znajdziesz w sekcji createURLStreamHandlerFactory.

Parametry
url: URL!

Adres URL zasobu, z którym zostanie nawiązane połączenie.

proxy: Proxy!

serwer proxy, który ma być używany podczas nawiązywania połączenia.

Zwraca
URLConnection!

instancja java.net.HttpURLConnection zaimplementowana przez ten obiekt CronetEngine.

Zgłasza
java.io.IOException

jeśli podczas otwierania połączenia wystąpi błąd.

removeRequestFinishedListener

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

Usuwa odbiorcę zakończonego żądania.

Parametry
listener: RequestFinishedInfo.Listener!

słuchacza do usunięcia.

removeRttListener

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.

Parametry
listener: NetworkQualityRttListener!

słuchacz czasów błądzenia.

removeThroughputListener

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.

Parametry
listener: NetworkQualityThroughputListener!

odbiorca przepustowości.

wyłączenie,

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.

startNetLogToDisk

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.

Parametry
dirPath: String!

katalog, w którym zostanie utworzony plik netlog.json. Ścieżka dirPath musi już istnieć. W katalogu nie mogą znajdować się pliki NetLog. Jeśli aktywnie rejestrujesz dane, ta metoda jest ignorowana.

logAll: Boolean

true, aby uwzględnić w dzienniku podstawowe zdarzenia, pliki cookie użytkownika, dane logowania i wszystkie przeniesione bajty. Ta opcja stwarza ryzyko naruszenia prywatności, ponieważ ujawnia dane logowania użytkownika. Należy jej używać tylko za zgodą użytkownika i w sytuacjach, w których dziennik nie będzie publiczny. false, aby uwzględniać tylko podstawowe zdarzenia.

maxSize: Int

maksymalna łączna ilość miejsca na dysku (w bajtach), która powinna być używana przez NetLog. Rzeczywiste wykorzystanie miejsca na dysku może nieznacznie przekraczać ten limit.

startNetLogToFile

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.

Parametry
fileName: String!

pełną ścieżkę do pliku; Nie może być puste. Jeśli plik istnieje, przed rozpoczęciem jest obcinany. Jeśli aktywnie rejestrujesz dane, ta metoda jest ignorowana.

logAll: Boolean

true, aby uwzględnić w dzienniku podstawowe zdarzenia, pliki cookie użytkownika, dane logowania i wszystkie przeniesione bajty. Ta opcja stwarza ryzyko naruszenia prywatności, ponieważ ujawnia dane logowania użytkownika. Należy jej używać tylko za zgodą użytkownika i w sytuacjach, w których dziennik nie będzie publiczny. false, aby uwzględniać tylko podstawowe zdarzenia.

stopNetLog

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.

Funkcje chronione

createBidirectionalStream

protected fun createBidirectionalStream(
    url: String!,
    callback: BidirectionalStream.Callback!,
    executor: Executor!,
    httpMethod: String!,
    requestHeaders: (Mutable)List<(Mutable)Map.Entry<String!, String!>!>!,
    @CronetEngineBase.StreamPriority priority: Int,
    delayRequestHeadersUntilFirstFlush: Boolean,
    connectionAnnotations: (Mutable)Collection<Any!>!,
    trafficStatsTagSet: Boolean,
    trafficStatsTag: Int,
    trafficStatsUidSet: Boolean,
    trafficStatsUid: Int,
    networkHandle: Long
): ExperimentalBidirectionalStream!