CronetEngine

const val ACTIVE_REQUEST_COUNT_UNKNOWN = -1: Int

Значение счетчика активных запросов неизвестно.

const val CONNECTION_METRIC_UNKNOWN = -1: Int

Значение метрики соединения неизвестно.

const val EFFECTIVE_CONNECTION_TYPE_2G = 3: Int

По оценкам, эффективный тип подключения — 2G.

const val EFFECTIVE_CONNECTION_TYPE_3G = 4: Int

По оценкам, эффективный тип подключения — 3G.

const val EFFECTIVE_CONNECTION_TYPE_4G = 5: Int

По оценкам, эффективный тип подключения — 4G.

const val EFFECTIVE_CONNECTION_TYPE_OFFLINE = 1: Int

Устройство отключено от сети.

const val EFFECTIVE_CONNECTION_TYPE_SLOW_2G = 2: Int

Оценка эффективного типа соединения показывает медленный 2G.

const val EFFECTIVE_CONNECTION_TYPE_UNKNOWN = 0: Int

Оценка эффективного типа соединения неизвестна.

const val UNBIND_NETWORK_HANDLE = -1: Long

Значение, которое будет использоваться для отмены любой предыдущей сетевой привязки.

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

Регистрирует обработчик событий, который вызывается после завершения каждого запроса с информацией о запросе.

Слушатель вызывается для объекта java.util.concurrent.Executor , предоставленного слушателем.

fun addRttListener(listener: NetworkQualityRttListener!): Unit

Регистрирует обработчик событий, который вызывается всякий раз, когда оценщик качества сети фиксирует время кругового пути. Этот обработчик должен вызываться после enableNetworkQualityEstimator , в противном случае — генерировать исключение. Время кругового пути может записываться на различных уровнях сетевого стека, включая TCP, QUIC и уровень запроса URL. Обработчик событий вызывается для объекта java.util.concurrent.Executor , переданного в enableNetworkQualityEstimator .

fun addThroughputListener(listener: NetworkQualityThroughputListener!): Unit

Регистрирует слушатель, который вызывается всякий раз, когда оценщик качества сети фиксирует выборочное измерение пропускной способности. Этот вызов должен быть выполнен после enableNetworkQualityEstimator . Наблюдения за пропускной способностью вычисляются путем измерения количества байтов, прочитанных через активный сетевой интерфейс в моменты, когда получен хотя бы один ответ на URL-адрес. Слушатель вызывается для объекта java.util.concurrent.Executor , переданного в enableNetworkQualityEstimator .

fun bindToNetwork(networkHandle: Long): Unit

Привязывает движок к указанному сетевому дескриптору. Все запросы, созданные через этот движок, будут использовать сеть, связанную с этим дескриптором. Если эта сеть отключается, все запросы завершатся с ошибкой; точная ошибка будет зависеть от стадии обработки запроса в момент отключения сети. Сетевые дескрипторы можно получить с помощью Network#getNetworkHandle . Доступно только начиная с Android Marshmallow.

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

Настраивает средство оценки качества сети для тестирования. Этот вызов необходимо выполнить до добавления слушателей времени кругового пути и пропускной способности, а также после включения средства оценки качества сети.

abstract fun createURLStreamHandlerFactory(): URLStreamHandlerFactory!

Создает объект URLStreamHandlerFactory для обработки HTTP и HTTPS-трафика. Экземпляр этого класса можно установить с помощью setURLStreamHandlerFactory таким образом, по умолчанию для всех запросов, создаваемых через openConnection, будет использоваться этот CronetEngine.

Cronet не использует некоторые функции HTTP, предоставляемые системой:

• HTTP-кэш устанавливается с помощью HttpResponseCache.install()
• метод HTTP-аутентификации, установленный с помощью setDefault
• хранилище HTTP-cookie, установленное с помощью setDefault

Хотя Cronet поддерживает и поощряет запросы с использованием протокола HTTPS, Cronet не предоставляет поддержку API HttpsURLConnection . Отсутствие поддержки также включает в себя невозможность использования некоторых функций HTTPS, предоставляемых системой:

• Верификатор имени хоста HTTPS, устанавливаемый через HttpsURLConnection.setDefaultHostnameVerifier()
• Фабрика HTTPS-сокетов устанавливается с помощью HttpsURLConnection.setDefaultSSLSocketFactory()

fun getActiveRequestCount(): Int

Возвращает количество активных запросов.

Запрос становится "активным" в методе UrlRequest.start(), если этот метод не вызывает исключение. Он становится неактивным, когда все коллбэки возвращают управление и в будущем невозможно запустить дополнительные коллбэки. На практике это означает, что запрос становится неактивным после того, как метод onSucceeded/onCanceled/onFailed вернет управление и все обработчики завершения запроса вернут управление. Для получения дополнительной информации см. жизненный цикл запросов Cronet .

fun getDownstreamThroughputKbps(): Int

Возвращает оценку пропускной способности нисходящего потока (в килобитах в секунду), вычисленную оценщиком качества сети. Если значение недоступно, установите значение CONNECTION_METRIC_UNKNOWN . Этот метод необходимо вызывать после enableNetworkQualityEstimator , в противном случае будет сгенерировано исключение.

fun getEffectiveConnectionType(): Int

Возвращает оценку эффективного типа соединения, вычисленную с помощью оценщика качества сети. Вызовите enableNetworkQualityEstimator , чтобы начать вычисление этого значения.

fun getHttpRttMs(): Int

Возвращает оценку времени кругового обхода HTTP (в миллисекундах), вычисленную оценщиком качества сети. Если значение недоступно, установите значение CONNECTION_METRIC_UNKNOWN . Этот метод необходимо вызывать после enableNetworkQualityEstimator , в противном случае будет сгенерировано исключение.

fun getTransportRttMs(): Int

Возвращает оценку времени кругового обхода (в миллисекундах), вычисленную оценщиком качества сети. Если значение недоступно, установите значение CONNECTION_METRIC_UNKNOWN . Этот метод необходимо вызывать после enableNetworkQualityEstimator , в противном случае будет сгенерировано исключение.

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

Создаёт конструктор для UrlRequest . Все обратные вызовы для сгенерированных объектов UrlRequest будут вызываться в потоках executor . executor не должен запускать задачи в потоке, вызывающем execute чтобы предотвратить блокировку сетевых операций и возникновение исключений во время завершения работы.

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

Устанавливает новое соединение с ресурсом, указанным в URL url .

Примечание: реализация java.net.HttpURLConnection в Cronet имеет определенные ограничения, подробности см. createURLStreamHandlerFactory .

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

Удаляет обработчик завершенного запроса.

fun removeRttListener(listener: NetworkQualityRttListener!): Unit

Удаляет слушатель времени кругового пути, если он ранее был зарегистрирован с помощью addRttListener . Этот метод следует вызывать после добавления NetworkQualityRttListener , чтобы прекратить получение наблюдений.

fun removeThroughputListener(listener: NetworkQualityThroughputListener!): Unit

Удаляет слушатель пропускной способности. Этот метод следует вызывать после добавления NetworkQualityThroughputListener с помощью addThroughputListener , чтобы прекратить получение наблюдений.

abstract fun shutdown(): Unit

При отсутствии активных запросов CronetEngine отключает его, в противном случае генерирует исключение.

Вызов невозможен в сетевом потоке — в потоке, в котором Cronet вызывает Executor (который отличается от потока, в котором Executor вызывает обратные вызовы). Может блокировать выполнение до тех пор, пока не будут очищены все ресурсы CronetEngine .

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

Запускает запись логов NetLog в указанный каталог с ограниченным размером. NetLog будет содержать события, генерируемые всеми работающими CronetEngines. NetLog полезен для отладки. После остановки записи логов stopNetLog данные будут записаны в файл netlog.json в dirPath . Если запись логов прервана, вы можете вручную объединить файлы, находящиеся в подкаталоге .inprogress, используя: https://chromium.googlesource.com/chromium/src/+/main/net/tools/stitch_net_log_files.py. Журнал можно просмотреть в браузере Chrome, перейдя по адресу chrome://net-internals/#import.

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

Запускает запись логов NetLog в файл. Файл NetLog будет содержать события, генерируемые всеми работающими устройствами CronetEngines. Файл NetLog полезен для отладки. Файл можно просмотреть в браузере Chrome, перейдя по адресу chrome://net-internals/#import

abstract fun stopNetLog(): Unit

Останавливает запись в NetLog и записывает файл на диск. Если сеанс записи не запущен, этот вызов игнорируется.