CronetEngine

public abstract class CronetEngine

Znane bezpośrednie podklasy

CronetEngineBase

CronetEngineBase

Znane podklasy pośrednie

JavaCronetEngine

JavaCronetEngine

java.net.HttpURLConnection obsługuje CronetEngine.

---

Silnik do przetwarzania UrlRequest, który korzysta z najlepszego stosu HTTP dostępnego na bieżącej platformie. Instancję tej klasy można utworzyć za pomocą Builder.

Podsumowanie

Typy zagnieżdżone
public class CronetEngine.Builder Konstruktor obiektów CronetEngine, który umożliwia konfigurowanie w czasie działania obiektu CronetEngine.
public abstract class CronetEngine.Builder.LibraryLoader Klasa, która udostępnia metodę wczytywania natywnej biblioteki Cronet.

Stałe
static final int	ACTIVE_REQUEST_COUNT_UNKNOWN = -1 Wartość liczby aktywnych żądań jest nieznana
static final int	CONNECTION_METRIC_UNKNOWN = -1 Wartość danych o połączeniu jest nieznana.
static final int	EFFECTIVE_CONNECTION_TYPE_2G = 3 Szacowany rodzaj połączenia to 2G.
static final int	EFFECTIVE_CONNECTION_TYPE_3G = 4 Szacowany rodzaj połączenia to 3G.
static final int	EFFECTIVE_CONNECTION_TYPE_4G = 5 Szacowany rodzaj połączenia to 4G.
static final int	EFFECTIVE_CONNECTION_TYPE_OFFLINE = 1 Urządzenie jest offline.
static final int	EFFECTIVE_CONNECTION_TYPE_SLOW_2G = 2 Szacowany rodzaj połączenia to wolna sieć 2G.
static final int	EFFECTIVE_CONNECTION_TYPE_UNKNOWN = 0 Oszacowanie użytego rodzaju połączenia jest nieznane.
static final long	UNBIND_NETWORK_HANDLE = -1 Wartość, która ma zostać użyta do cofnięcia poprzedniego powiązania sieci.

Konstruktory publiczne
CronetEngine()

Metody publiczne
void	addRequestFinishedListener(RequestFinishedInfo.Listener listener) Rejestruje odbiorcę, który jest wywoływany po zakończeniu każdej prośby z informacjami o niej.
void	addRttListener(NetworkQualityRttListener listener) Rejestruje detektor, który jest wywoływany, gdy estymator jakości sieci zarejestruje próbkę czasu podróży w obie strony.
void	addThroughputListener(NetworkQualityThroughputListener listener) Rejestruje odbiorcę, który jest wywoływany za każdym razem, gdy estymator jakości sieci zarejestruje próbkę pomiaru przepustowości.
void	bindToNetwork(long networkHandle) Wiąże silnik z określonym uchwytem sieciowym.
void	configureNetworkQualityEstimatorForTesting(     boolean useLocalHostRequests,     boolean useSmallerResponses,     boolean disableOfflineCheck ) Konfiguruje estymator jakości sieci na potrzeby testowania.
abstract URLStreamHandlerFactory	createURLStreamHandlerFactory() Tworzy URLStreamHandlerFactory do obsługi ruchu HTTP i HTTPS.
int	getActiveRequestCount() Zwraca liczbę aktywnych żądań.
int	getDownstreamThroughputKbps() Zwraca szacunkową przepustowość pobierania (w kilobitach na sekundę) obliczoną przez narzędzie do szacowania jakości sieci.
int	getEffectiveConnectionType() Zwraca szacunkową wartość efektywnego typu połączenia obliczoną przez narzędzie do szacowania jakości sieci.
abstract byte[]	getGlobalMetricsDeltas() Ta metoda została wycofana. W nowoczesnych wersjach Croneta ta funkcja zawsze zwraca pustą tablicę.
int	getHttpRttMs() Zwraca szacunkową wartość RTT HTTP (w milisekundach) obliczoną przez narzędzie do szacowania jakości sieci.
int	getTransportRttMs() Zwraca szacunkowy czas RTT transportu (w milisekundach) obliczony przez narzędzie do szacowania jakości sieci.
abstract String	getVersionString()
abstract UrlRequest.Builder	newUrlRequestBuilder(     String url,     UrlRequest.Callback callback,     Executor executor ) Tworzy kreator dla UrlRequest.
abstract URLConnection	openConnection(URL url) Nawiązuje nowe połączenie z zasobem określonym przez URLurl.
void	removeRequestFinishedListener(RequestFinishedInfo.Listener listener) Usuwa odbiorcę zakończonego żądania.
void	removeRttListener(NetworkQualityRttListener listener) Usuwa odbiorcę czasu podróży w obie strony, jeśli został wcześniej zarejestrowany za pomocą addRttListener.
void	removeThroughputListener(NetworkQualityThroughputListener listener) Usuwa detektor przepustowości.
abstract void	shutdown() Zamyka CronetEngine, jeśli nie ma aktywnych żądań, w przeciwnym razie zgłasza wyjątek.
void	startNetLogToDisk(String dirPath, boolean logAll, int maxSize) Uruchamia rejestrowanie w NetLog w określonym katalogu o ograniczonej wielkości.
abstract void	startNetLogToFile(String fileName, boolean logAll) Rozpoczyna rejestrowanie w NetLogu w pliku.
abstract void	stopNetLog() Zatrzymuje rejestrowanie w NetLogu i zapisuje plik na dysku.

Stałe

ACTIVE_REQUEST_COUNT_UNKNOWN

public static final int ACTIVE_REQUEST_COUNT_UNKNOWN = -1

Wartość liczby aktywnych żądań jest nieznana

CONNECTION_METRIC_UNKNOWN

public static final int CONNECTION_METRIC_UNKNOWN = -1

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

EFFECTIVE_CONNECTION_TYPE_2G

public static final int EFFECTIVE_CONNECTION_TYPE_2G = 3

Szacowany rodzaj połączenia to 2G.

Zobacz też
getEffectiveConnectionType

EFFECTIVE_CONNECTION_TYPE_3G

public static final int EFFECTIVE_CONNECTION_TYPE_3G = 4

Szacowany rodzaj połączenia to 3G.

Zobacz też
getEffectiveConnectionType

EFFECTIVE_CONNECTION_TYPE_4G

public static final int EFFECTIVE_CONNECTION_TYPE_4G = 5

Szacowany rodzaj połączenia to 4G.

Zobacz też
getEffectiveConnectionType

EFFECTIVE_CONNECTION_TYPE_OFFLINE

public static final int EFFECTIVE_CONNECTION_TYPE_OFFLINE = 1

Urządzenie jest offline.

Zobacz też
getEffectiveConnectionType

EFFECTIVE_CONNECTION_TYPE_SLOW_2G

public static final int EFFECTIVE_CONNECTION_TYPE_SLOW_2G = 2

Szacowany rodzaj połączenia to wolna sieć 2G.

Zobacz też
getEffectiveConnectionType

EFFECTIVE_CONNECTION_TYPE_UNKNOWN

public static final int EFFECTIVE_CONNECTION_TYPE_UNKNOWN = 0

Oszacowanie użytego rodzaju połączenia jest nieznane.

Zobacz też
getEffectiveConnectionType

UNBIND_NETWORK_HANDLE

public static final long UNBIND_NETWORK_HANDLE = -1

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

Konstruktory publiczne

CronetEngine

public CronetEngine()

Metody publiczne

addRequestFinishedListener

public void addRequestFinishedListener(RequestFinishedInfo.Listener listener)

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
RequestFinishedInfo.Listener listener	odbiornik ukończonych żądań.

addRttListener

public void addRttListener(NetworkQualityRttListener listener)

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
NetworkQualityRttListener listener	słuchacz czasów błądzenia.

addThroughputListener

public void addThroughputListener(NetworkQualityThroughputListener listener)

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
NetworkQualityThroughputListener listener	odbiorca przepustowości.

bindToNetwork

public void bindToNetwork(long networkHandle)

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
long networkHandle	uchwyt sieci, do której ma być przypisany silnik; Aby usunąć powiązanie, wpisz UNBIND_NETWORK_HANDLE.

configureNetworkQualityEstimatorForTesting

public void configureNetworkQualityEstimatorForTesting(
    boolean useLocalHostRequests,
    boolean useSmallerResponses,
    boolean disableOfflineCheck
)

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
boolean useLocalHostRequests	uwzględniać w szacunkach żądania wysyłane do hosta lokalnego.
boolean useSmallerResponses	uwzględniać małe odpowiedzi w szacunkach przepustowości;
boolean disableOfflineCheck	Gdy ma wartość Prawda, wyłącza sprawdzanie stanu offline urządzenia podczas obliczania efektywnego typu połączenia lub zapisywania ustawień.

createURLStreamHandlerFactory

public abstract URLStreamHandlerFactory createURLStreamHandlerFactory()

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()

Zwraca
URLStreamHandlerFactory	instancja URLStreamHandlerFactory zaimplementowana przez ten obiekt CronetEngine.

getActiveRequestCount

public int getActiveRequestCount()

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

public int getDownstreamThroughputKbps()

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

public int getEffectiveConnectionType()

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

public abstract byte[] getGlobalMetricsDeltas()

Ta metoda została wycofana.

W nowoczesnych wersjach Croneta ta funkcja zawsze zwraca pustą tablicę. W starszych wersjach zwracało to zserializowany protokół buforów protokołu zawierający dane o rodzajach danych.

getHttpRttMs

public int getHttpRttMs()

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

public int getTransportRttMs()

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

public abstract String getVersionString()

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

newUrlRequestBuilder

public abstract UrlRequest.Builder newUrlRequestBuilder(
    String url,
    UrlRequest.Callback callback,
    Executor executor
)

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.

Parametry
String url	Adres URL wygenerowanych żądań.
UrlRequest.Callback callback	obiekt wywołania zwrotnego, który jest wywoływany w przypadku różnych zdarzeń.
Executor executor	Executor, w którym będą wywoływane wszystkie wywołania zwrotne.

openConnection

public abstract URLConnection openConnection(URL url)

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.

removeRequestFinishedListener

public void removeRequestFinishedListener(RequestFinishedInfo.Listener listener)

Usuwa odbiorcę zakończonego żądania.

Parametry
RequestFinishedInfo.Listener listener	słuchacza do usunięcia.

removeRttListener

public void removeRttListener(NetworkQualityRttListener listener)

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
NetworkQualityRttListener listener	słuchacz czasów błądzenia.

removeThroughputListener

public void removeThroughputListener(NetworkQualityThroughputListener listener)

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

Parametry
NetworkQualityThroughputListener listener	odbiorca przepustowości.

wyłączenie,

public abstract void shutdown()

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

public void startNetLogToDisk(String dirPath, boolean logAll, int maxSize)

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
String dirPath	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.
boolean logAll	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.
int maxSize	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

public abstract void startNetLogToFile(String fileName, boolean logAll)

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
String fileName	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.
boolean logAll	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

public abstract void stopNetLog()

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