CronetEngine.Builder

const val HTTP_CACHE_DISABLED = 0: Int

Setting to disable HTTP cache. Some data may still be temporarily stored in memory. Passed to enableHttpCache.

const val HTTP_CACHE_DISK = 3: Int

Setting to enable on-disk cache, including HTTP data. setStoragePath must be called prior to passing this constant to enableHttpCache.

const val HTTP_CACHE_DISK_NO_HTTP = 2: Int

Setting to enable on-disk cache, excluding HTTP data. setStoragePath must be called prior to passing this constant to enableHttpCache.

const val HTTP_CACHE_IN_MEMORY = 1: Int

Setting to enable in-memory HTTP cache, including HTTP data. Passed to enableHttpCache.

Builder(context: Context!)

Constructs a Builder object that facilitates creating a CronetEngine. The default configuration enables HTTP/2 and QUIC, but disables the HTTP cache.

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

Pins a set of public keys for a given host. By pinning a set of public keys, pinsSha256, communication with hostName is required to authenticate with a certificate with a public key from the set of pinned ones. An app can pin the public key of the root certificate, any of the intermediate certificates or the end-entry certificate. Authentication will fail and secure communication will not be established if none of the public keys is present in the host's certificate chain, even if the host attempts to authenticate with a certificate allowed by the device's trusted store of certificates.

Calling this method multiple times with the same host name overrides the previously set pins for the host.

More information about the public key pinning can be found in RFC 7469.

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

Adds hint that host supports QUIC. Note that enableHttpCache (HTTP_CACHE_DISK) is needed to take advantage of 0-RTT connection establishment between sessions.

fun build(): CronetEngine!

Build a CronetEngine using this builder's configuration.

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

Sets whether Brotli compression is enabled. If enabled, Brotli will be advertised in Accept-Encoding request headers. Defaults to disabled.

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

Sets whether HTTP/2 protocol is enabled. Defaults to enabled.

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

Enables or disables caching of HTTP data and other information like QUIC server information.

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

Enables the network quality estimator, which collects and reports measurements of round trip time (RTT) and downstream throughput at various layers of the network stack. After enabling the estimator, listeners of RTT and throughput can be added with addRttListener and addThroughputListener and removed with removeRttListener and removeThroughputListener. The estimator uses memory and CPU only when enabled.

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

Enables or disables public key pinning bypass for local trust anchors. Disabling the bypass for local trust anchors is highly discouraged since it may prohibit the app from communicating with the pinned hosts. E.g., a user may want to send all traffic through an SSL enabled proxy by changing the device proxy settings and adding the proxy certificate to the list of local trust anchor. Disabling the bypass will most likely prevent the app from sending any traffic to the pinned hosts. For more information see 'How does key pinning interact with local proxies and filters?' at https://www.chromium.org/Home/chromium-security/security-faq

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

Sets whether QUIC protocol is enabled. Defaults to enabled. If QUIC is enabled, then QUIC User Agent Id containing application name and Cronet version is sent to the server.

fun getDefaultUserAgent(): String!

Constructs a User-Agent string including application name and version, system build version, model and id, and Cronet version.

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

Configures the behavior of connection migration. For more details, see documentation of ConnectionMigrationOptions and the individual methods of ConnectionMigrationOptions.Builder.

Only relevant if enableQuic is enabled.

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

Configures the behavior of hostname lookup. For more details, see documentation of DnsOptions and the individual methods of DnsOptions.Builder.

Only relevant if enableQuic is enabled.

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

Sets a LibraryLoader to be used to load the native library. If not set, the library will be loaded using loadLibrary.

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

Configures proxying behavior. This affects, in different ways: connections establishment, UrlRequest and BidirectionalStream. For more details, refer to the documentation of Proxy.

This is not to be confused with proxy configuration that have been set up by: the user; or some enterprise profile configuration, or (most likely) some network autoconfiguration (e.g., Web Proxy Auto-Discovery Protocol). This is usually referred to as "system" proxy configuration. If present, respecting the system proxy configuration is often a requirement to obtain local and/or internet connectivity. CronetEngine already handles the system proxy configuration internally.

A proxy configuration defined via this API are refererred to as "app" proxy configuration. App and system proxy configuration are separate and, most importantly, differ. Currently, app and system proxy configurations are mutually exclusive: specifying ProxyOptions overrides the system proxy configuration, if present. This might cause connectivity problems in some scenarios where a system proxy configuration is present. In such scenarios, users might end up with no internet access, unless ProxyOptions has been configured with a final, null, fallback. Refer to ProxyOptions documentation.

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

Configures the behavior of Cronet when using QUIC. For more details, see documentation of QuicOptions and the individual methods of QuicOptions.Builder.

Only relevant if enableQuic is enabled.

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

Sets directory for HTTP Cache and Cookie Storage. The directory must exist.

NOTE: Do not use the same storage directory with more than one CronetEngine at a time. Access to the storage directory does not support concurrent access by multiple CronetEngines.

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

Sets the thread priority of Cronet's internal thread.

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

Overrides the User-Agent header for all requests. An explicitly set User-Agent header (set using addHeader) will override a value set using this function.

protected val mParsedExperimentalOptions: JSONObject!

JSON representation of the experimental options.