CronetEngine

public abstract class CronetEngine

Znane bezpośrednie podklasy
Znane podklasy pośrednie
JavaCronetEngine

java.net.HttpURLConnection oparte na 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

Konstruktor CronetEngine, który umożliwia konfigurowanie CronetEngine w czasie działania.

Ta klasa została wycofana.

Funkcja System.loadLibrary była zawodna w przypadku minSDK <= 23, dlatego ta metoda była używana do udostępniania alternatywnych, bardziej niezawodnych programów wczytujących.

Stałe

static final int

Wartość liczby aktywnych żądań jest nieznana

static final int

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

static final int

Szacowany typ połączenia to 2G.

static final int

Szacowany efektywny typ połączenia to 3G.

static final int

Szacowany efektywny typ połączenia to 4G.

static final int

Urządzenie jest offline.

static final int

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

static final int

Oszacowanie efektywnego typu połączenia jest nieznane.

static final long

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

Konstruktory publiczne

Metody publiczne

void

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

void

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

void

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

void
bindToNetwork(long networkHandle)

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

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

Konfiguruje narzędzie do szacowania jakości sieci na potrzeby testowania.

abstract URLStreamHandlerFactory

Tworzy URLStreamHandlerFactory do obsługi ruchu HTTP i HTTPS.

int

Zwraca liczbę aktywnych żądań.

int

Zwraca oszacowaną 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.

abstract byte[]

Ta metoda została wycofana.

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

int

Zwraca oszacowany czas RTT HTTP (w milisekundach) obliczony 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.

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

Tworzy kreator dla UrlRequest.

abstract URLConnection

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

void

Usuwa odbiorcę zakończonej prośby.

void

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

void

Usuwa odbiorcę przepustowości.

abstract void

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

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

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

abstract void
startNetLogToFile(String fileName, boolean logAll)

Rozpoczyna rejestrowanie w pliku informacji z NetLog.

abstract void

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

EFFECTIVE_CONNECTION_TYPE_3G

public static final int EFFECTIVE_CONNECTION_TYPE_3G = 4

Szacowany efektywny typ połączenia to 3G.

EFFECTIVE_CONNECTION_TYPE_4G

public static final int EFFECTIVE_CONNECTION_TYPE_4G = 5

Szacowany efektywny typ połączenia to 4G.

EFFECTIVE_CONNECTION_TYPE_OFFLINE

public static final int EFFECTIVE_CONNECTION_TYPE_OFFLINE = 1

Urządzenie jest offline.

EFFECTIVE_CONNECTION_TYPE_SLOW_2G

public static final int EFFECTIVE_CONNECTION_TYPE_SLOW_2G = 2

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

EFFECTIVE_CONNECTION_TYPE_UNKNOWN

public static final int EFFECTIVE_CONNECTION_TYPE_UNKNOWN = 0

Oszacowanie efektywnego typu połączenia jest nieznane.

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.

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

Parametry
RequestFinishedInfo.Listener listener

słuchacz zrealizowanych żądań.

addRttListener

public void addRttListener(NetworkQualityRttListener listener)

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.

Parametry
NetworkQualityRttListener listener

odbiornik czasu 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 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.

Parametry
NetworkQualityThroughputListener listener

odbiorca przepustowości.

bindToNetwork

public void bindToNetwork(long networkHandle)

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.

Parametry
long networkHandle

uchwyt sieci, do której ma być przypisany silnik. Aby odłączyć konto, wpisz UNBIND_NETWORK_HANDLE.

configureNetworkQualityEstimatorForTesting

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

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.

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

Jeśli wartość to „true”, wyłącza sprawdzanie urządzenia w trybie offline 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:

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

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 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.

getDownstreamThroughputKbps

public int getDownstreamThroughputKbps()

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.

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. Aby rozpocząć obliczanie tej wartości, wywołaj funkcję enableNetworkQualityEstimator.

Zwraca
int

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

getGlobalMetricsDeltas

public abstract byte[] getGlobalMetricsDeltas()

getHttpRttMs

public int getHttpRttMs()

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.

Zwraca
int

Szacunkowy czas RTT HTTP w milisekundach.

getTransportRttMs

public int getTransportRttMs()

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 wywołaniu funkcji 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. Więcej informacji 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ńczonej prośby.

Parametry
RequestFinishedInfo.Listener listener

słuchacza do usunięcia.

removeRttListener

public void removeRttListener(NetworkQualityRttListener listener)

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.

Parametry
NetworkQualityRttListener listener

odbiornik czasu błądzenia.

removeThroughputListener

public void removeThroughputListener(NetworkQualityThroughputListener listener)

Usuwa odbiorcę przepustowości. Tę metodę należy wywołać po dodaniu NetworkQualityThroughputListener za pomocą 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 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.

startNetLogToDisk

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

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.

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 logowanie jest aktywne, ta metoda jest ignorowana.

boolean logAll

true, aby uwzględnić w dzienniku podstawowe zdarzenia, pliki cookie użytkownika, dane logowania i wszystkie przesłane bajty. Ta opcja wiąże się z ryzykiem 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 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.

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 logowanie jest aktywne, ta metoda jest ignorowana.

boolean logAll

true, aby uwzględnić w dzienniku podstawowe zdarzenia, pliki cookie użytkownika, dane logowania i wszystkie przesłane bajty. Ta opcja wiąże się z ryzykiem 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.