CronetEngine.Builder

const val HTTP_CACHE_DISABLED = 0: Int

Параметр для отключения HTTP-кэширования. Некоторые данные могут временно храниться в памяти. Передается в enableHttpCache .

const val HTTP_CACHE_DISK = 3: Int

Параметр для включения кэширования на диске, включая данные HTTP. Перед передачей этой константы в enableHttpCache необходимо вызвать setStoragePath .

const val HTTP_CACHE_DISK_NO_HTTP = 2: Int

Параметр для включения кэширования на диске, за исключением данных HTTP. Перед передачей этой константы в enableHttpCache необходимо вызвать setStoragePath .

const val HTTP_CACHE_IN_MEMORY = 1: Int

Параметр для включения кэширования HTTP-данных в оперативной памяти, включая HTTP-данные. Передается в enableHttpCache .

Builder(context: Context!)

Создает объект Builder , который упрощает создание CronetEngine . Конфигурация по умолчанию включает HTTP/2 и QUIC, но отключает HTTP-кэширование.

fun addPublicKeyPins(
    hostName: String!,
    pinsSha256: (Mutable)Set<ByteArray!>!,
    includeSubdomains: Boolean,
    expirationDate: Date!
): CronetEngine.Builder!

Закрепляет набор открытых ключей для заданного хоста. Закрепив набор открытых ключей ( pinsSha256 ), требуется аутентификация с hostName , использующим сертификат с открытым ключом из этого набора. Приложение может закрепить открытый ключ корневого сертификата, любого из промежуточных сертификатов или сертификата конечного узла. Аутентификация завершится неудачей, и защищенная связь не будет установлена, если ни один из открытых ключей не присутствует в цепочке сертификатов хоста, даже если хост попытается аутентифицироваться с помощью сертификата, разрешенного хранилищем доверенных сертификатов устройства.

Многократный вызов этого метода с одним и тем же именем хоста приводит к переопределению ранее установленных контактов для хоста.

Более подробная информация о привязке открытого ключа содержится в RFC 7469 .

fun addQuicHint(host: String!, port: Int, alternatePort: Int): CronetEngine.Builder!

Добавляет подсказку о том, что host поддерживает QUIC. Обратите внимание, что для использования преимущества установления соединения с нулевым временем отклика (0-RTT) между сессиями необходим enableHttpCache ( HTTP_CACHE_DISK ).

fun build(): CronetEngine!

Создайте объект CronetEngine , используя конфигурацию этого построителя.

fun enableBrotli(value: Boolean): CronetEngine.Builder!

Определяет, включено ли сжатие Brotli . Если включено, Brotli будет упоминаться в заголовках запроса Accept-Encoding. По умолчанию отключено.

fun enableHttp2(value: Boolean): CronetEngine.Builder!

Определяет, включен ли протокол HTTP/2 . По умолчанию — включен.

fun enableHttpCache(cacheMode: Int, maxSize: Long): CronetEngine.Builder!

Включает или отключает кэширование HTTP-данных и другой информации, такой как информация о сервере QUIC.

fun enableNetworkQualityEstimator(value: Boolean): CronetEngine.Builder!

Включает в себя оценщик качества сети, который собирает и передает данные об измерениях времени кругового пути (RTT) и пропускной способности на различных уровнях сетевого стека. После включения оценщика можно добавлять слушателей RTT и пропускной способности с помощью addRttListener и addThroughputListener , а удалять с помощью removeRttListener и removeThroughputListener . Оценщик использует память и ЦП только в включенном состоянии.

fun enablePublicKeyPinningBypassForLocalTrustAnchors(value: Boolean): CronetEngine.Builder!

Включает или отключает обход блокировки привязки открытого ключа для локальных доверенных якорей. Отключение обхода для локальных доверенных якорей крайне не рекомендуется, поскольку это может помешать приложению взаимодействовать с закрепленными хостами. Например, пользователь может захотеть направлять весь трафик через прокси-сервер с поддержкой SSL, изменив настройки прокси-сервера устройства и добавив сертификат прокси в список локальных доверенных якорей. Отключение обхода, скорее всего, помешает приложению отправлять какой-либо трафик на закрепленные хосты. Для получения дополнительной информации см. раздел «Как блокировка ключа взаимодействует с локальными прокси-серверами и фильтрами?» по адресу https://www.chromium.org/Home/chromium-security/security-faq

fun enableQuic(value: Boolean): CronetEngine.Builder!

Определяет, включен ли протокол QUIC . По умолчанию — включен. Если QUIC включен, на сервер отправляется идентификатор пользовательского агента QUIC, содержащий имя приложения и версию Cronet.

fun getDefaultUserAgent(): String!

Формирует строку User-Agent, включающую название и версию приложения, версию сборки системы, модель и идентификатор, а также версию Cronet.

@ConnectionMigrationOptions.Experimental
fun setConnectionMigrationOptions(
    connectionMigrationOptions: ConnectionMigrationOptions!
): CronetEngine.Builder!

Настраивает поведение миграции соединений. Для получения более подробной информации см. документацию по ConnectionMigrationOptions и отдельным методам ConnectionMigrationOptions.Builder .

Актуально только при включенной функции enableQuic .

@DnsOptions.Experimental
fun setDnsOptions(dnsOptions: DnsOptions!): CronetEngine.Builder!

Настраивает поведение поиска имени хоста. Для получения более подробной информации см. документацию по DnsOptions и отдельным методам DnsOptions.Builder .

Актуально только при включенной функции enableQuic .

fun setLibraryLoader(loader: CronetEngine.Builder.LibraryLoader!): CronetEngine.Builder!

Задает объект LibraryLoader , который будет использоваться для загрузки нативной библиотеки. Если не задан, библиотека будет загружена с помощью loadLibrary .

fun setProxyOptions(proxyOptions: ProxyOptions): CronetEngine.Builder!

Настраивает поведение проксирования. Это влияет различными способами на установление соединений, UrlRequest и BidirectionalStream . Для получения более подробной информации обратитесь к документации Proxy .

Это не следует путать с конфигурацией прокси-сервера, установленной пользователем, или с конфигурацией корпоративного профиля, или (скорее всего) с автоматической настройкой сети (например, протоколом автоматического обнаружения веб-прокси). Обычно это называется «системной» конфигурацией прокси-сервера. Если она присутствует, соблюдение системной конфигурации прокси-сервера часто является обязательным условием для получения локального и/или интернет-соединения. CronetEngine уже обрабатывает системную конфигурацию прокси-сервера внутри себя.

Конфигурации прокси, определенные через этот API, называются конфигурациями прокси «приложения». Конфигурации прокси приложения и системы являются отдельными и, что наиболее важно, различаются. В настоящее время конфигурации прокси приложения и системы являются взаимоисключающими: указание ProxyOptions переопределяет конфигурацию системного прокси, если она присутствует. Это может вызвать проблемы с подключением в некоторых сценариях, где присутствует конфигурация системного прокси. В таких сценариях пользователи могут остаться без доступа к интернету, если ProxyOptions не настроен с окончательным, null , резервным значением. См. документацию по ProxyOptions .

@QuicOptions.Experimental
fun setQuicOptions(quicOptions: QuicOptions!): CronetEngine.Builder!

Настраивает поведение Cronet при использовании QUIC. Для получения более подробной информации см. документацию по QuicOptions и отдельным методам QuicOptions.Builder .

Актуально только при включенной функции enableQuic .

fun setStoragePath(value: String!): CronetEngine.Builder!

Задает каталог для кэширования HTTP-трафика и хранения файлов cookie. Каталог должен существовать.

ПРИМЕЧАНИЕ: Не используйте один и тот же каталог хранения более чем с одним CronetEngine одновременно. Одновременный доступ к каталогу хранения несколькими устройствами CronetEngine не поддерживается.

fun setThreadPriority(priority: Int): CronetEngine.Builder!

Устанавливает приоритет потока для внутреннего потока Cronet.

fun setUserAgent(userAgent: String!): CronetEngine.Builder!

Переопределяет заголовок User-Agent для всех запросов. Явно заданный заголовок User-Agent (установленный с помощью addHeader ) переопределит значение, установленное с помощью этой функции.

protected val mParsedExperimentalOptions: JSONObject!

JSON-представление экспериментальных вариантов.