# CronetEngine


```
abstract class CronetEngine
```

<br />

Known direct subclasses [CronetEngineBase](https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/impl/CronetEngineBase)

|---|---|
| `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/impl/CronetEngineBase` |   |

Known indirect subclasses [JavaCronetEngine](https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/impl/JavaCronetEngine)

|---|---|
| `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/impl/JavaCronetEngine` | `https://developer.android.com/reference/java/net/HttpURLConnection.html` backed CronetEngine. |

*** ** * ** ***

An engine to process `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/UrlRequest`s, which uses the best HTTP stack available on the current platform. An instance of this class can be created using `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/CronetEngine.Builder`.

## Summary

| ### Nested types |
|---|
| `class https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/CronetEngine.Builder` A builder for `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/CronetEngine`s, which allows runtime configuration of ` CronetEngine`. |
| `abstract class https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/CronetEngine.Builder.LibraryLoader` **This class is deprecated.** System.loadLibrary was unreliable on minSDK \<= 23, and this method was used to provide alternative, more reliable loaders. <br /> |

| ### Constants |
|---|---|
| `const https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html` | `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/CronetEngine#ACTIVE_REQUEST_COUNT_UNKNOWN() = -1` The value of the active request count is unknown |
| `const https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html` | `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/CronetEngine#CONNECTION_METRIC_UNKNOWN() = -1` The value of a connection metric is unknown. |
| `const https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html` | `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/CronetEngine#EFFECTIVE_CONNECTION_TYPE_2G() = 3` The estimate of the effective connection type is 2G. |
| `const https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html` | `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/CronetEngine#EFFECTIVE_CONNECTION_TYPE_3G() = 4` The estimate of the effective connection type is 3G. |
| `const https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html` | `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/CronetEngine#EFFECTIVE_CONNECTION_TYPE_4G() = 5` The estimate of the effective connection type is 4G. |
| `const https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html` | `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/CronetEngine#EFFECTIVE_CONNECTION_TYPE_OFFLINE() = 1` The device is offline. |
| `const https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html` | `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/CronetEngine#EFFECTIVE_CONNECTION_TYPE_SLOW_2G() = 2` The estimate of the effective connection type is slow 2G. |
| `const https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html` | `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/CronetEngine#EFFECTIVE_CONNECTION_TYPE_UNKNOWN() = 0` The estimate of the effective connection type is unknown. |
| `const https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html` | `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/CronetEngine#UNBIND_NETWORK_HANDLE() = -1` The value to be used to undo any previous network binding. |

| ### Public constructors |
|---|
| `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/CronetEngine#CronetEngine()()` |

| ### Public functions |
|---|---|
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html` | `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/CronetEngine#addRequestFinishedListener(org.chromium.net.RequestFinishedInfo.Listener)(listener: https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/RequestFinishedInfo.Listener!)` Registers a listener that gets called after the end of each request with the request info. |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html` | `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/CronetEngine#addRttListener(org.chromium.net.NetworkQualityRttListener)(listener: https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/NetworkQualityRttListener!)` Registers a listener that gets called whenever the network quality estimator witnesses a sample round trip time. |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html` | `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/CronetEngine#addThroughputListener(org.chromium.net.NetworkQualityThroughputListener)(listener: https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/NetworkQualityThroughputListener!)` Registers a listener that gets called whenever the network quality estimator witnesses a sample throughput measurement. |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html` | `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/CronetEngine#bindToNetwork(long)(networkHandle: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)` Binds the engine to the specified network handle. |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html` | `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/CronetEngine#configureNetworkQualityEstimatorForTesting(boolean,boolean,boolean)( useLocalHostRequests: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html, useSmallerResponses: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html, disableOfflineCheck: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html )` Configures the network quality estimator for testing. |
| `abstract https://developer.android.com/reference/java/net/URLStreamHandlerFactory.html!` | `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/CronetEngine#createURLStreamHandlerFactory()()` Creates a `https://developer.android.com/reference/java/net/URLStreamHandlerFactory.html` to handle HTTP and HTTPS traffic. |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html` | `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/CronetEngine#getActiveRequestCount()()` Returns the number of active requests. |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html` | `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/CronetEngine#getDownstreamThroughputKbps()()` Returns the downstream throughput estimate (in kilobits per second) computed by the network quality estimator. |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html` | `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/CronetEngine#getEffectiveConnectionType()()` Returns an estimate of the effective connection type computed by the network quality estimator. |
| `abstract https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte/index.html>!` | `[getGlobalMetricsDeltas](https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/CronetEngine#getGlobalMetricsDeltas())()` **This function is deprecated.** In modern versions of Cronet, this will always return an empty array. <br /> |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html` | `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/CronetEngine#getHttpRttMs()()` Returns the HTTP RTT estimate (in milliseconds) computed by the network quality estimator. |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html` | `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/CronetEngine#getTransportRttMs()()` Returns the transport RTT estimate (in milliseconds) computed by the network quality estimator. |
| `abstract https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html!` | `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/CronetEngine#getVersionString()()` |
| `abstract https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/UrlRequest.Builder!` | `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/CronetEngine#newUrlRequestBuilder(java.lang.String,org.chromium.net.UrlRequest.Callback,java.util.concurrent.Executor)( url: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html!, callback: https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/UrlRequest.Callback!, executor: https://developer.android.com/reference/java/util/concurrent/Executor.html! )` Creates a builder for `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/UrlRequest`. |
| `abstract https://developer.android.com/reference/java/net/URLConnection.html!` | `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/CronetEngine#openConnection(java.net.URL)(url: https://developer.android.com/reference/java/net/URL.html!)` Establishes a new connection to the resource specified by the `https://developer.android.com/reference/java/net/URL.html``url`. |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html` | `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/CronetEngine#removeRequestFinishedListener(org.chromium.net.RequestFinishedInfo.Listener)(listener: https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/RequestFinishedInfo.Listener!)` Removes a finished request listener. |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html` | `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/CronetEngine#removeRttListener(org.chromium.net.NetworkQualityRttListener)(listener: https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/NetworkQualityRttListener!)` Removes a listener of round trip times if previously registered with `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/CronetEngine#addRttListener(org.chromium.net.NetworkQualityRttListener)`. |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html` | `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/CronetEngine#removeThroughputListener(org.chromium.net.NetworkQualityThroughputListener)(listener: https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/NetworkQualityThroughputListener!)` Removes a listener of throughput. |
| `abstract https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html` | `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/CronetEngine#shutdown()()` Shuts down the `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/CronetEngine` if there are no active requests, otherwise throws an exception. |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html` | `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/CronetEngine#startNetLogToDisk(java.lang.String,boolean,int)(dirPath: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html!, logAll: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html, maxSize: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` Starts NetLog logging to a specified directory with a bounded size. |
| `abstract https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html` | `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/CronetEngine#startNetLogToFile(java.lang.String,boolean)(fileName: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html!, logAll: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` Starts NetLog logging to a file. |
| `abstract https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html` | `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/CronetEngine#stopNetLog()()` Stops NetLog logging and flushes file to disk. |

## Constants

### ACTIVE_REQUEST_COUNT_UNKNOWN

```
const val ACTIVE_REQUEST_COUNT_UNKNOWN = -1: Int
```

The value of the active request count is unknown

### CONNECTION_METRIC_UNKNOWN

```
const val CONNECTION_METRIC_UNKNOWN = -1: Int
```

The value of a connection metric is unknown.

### EFFECTIVE_CONNECTION_TYPE_2G

```
const val EFFECTIVE_CONNECTION_TYPE_2G = 3: Int
```

The estimate of the effective connection type is 2G.

| See also |
|---|---|
| `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/CronetEngine#getEffectiveConnectionType()` |   |

### EFFECTIVE_CONNECTION_TYPE_3G

```
const val EFFECTIVE_CONNECTION_TYPE_3G = 4: Int
```

The estimate of the effective connection type is 3G.

| See also |
|---|---|
| `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/CronetEngine#getEffectiveConnectionType()` |   |

### EFFECTIVE_CONNECTION_TYPE_4G

```
const val EFFECTIVE_CONNECTION_TYPE_4G = 5: Int
```

The estimate of the effective connection type is 4G.

| See also |
|---|---|
| `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/CronetEngine#getEffectiveConnectionType()` |   |

### EFFECTIVE_CONNECTION_TYPE_OFFLINE

```
const val EFFECTIVE_CONNECTION_TYPE_OFFLINE = 1: Int
```

The device is offline.

| See also |
|---|---|
| `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/CronetEngine#getEffectiveConnectionType()` |   |

### EFFECTIVE_CONNECTION_TYPE_SLOW_2G

```
const val EFFECTIVE_CONNECTION_TYPE_SLOW_2G = 2: Int
```

The estimate of the effective connection type is slow 2G.

| See also |
|---|---|
| `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/CronetEngine#getEffectiveConnectionType()` |   |

### EFFECTIVE_CONNECTION_TYPE_UNKNOWN

```
const val EFFECTIVE_CONNECTION_TYPE_UNKNOWN = 0: Int
```

The estimate of the effective connection type is unknown.

| See also |
|---|---|
| `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/CronetEngine#getEffectiveConnectionType()` |   |

### UNBIND_NETWORK_HANDLE

```
const val UNBIND_NETWORK_HANDLE = -1: Long
```

The value to be used to undo any previous network binding.

## Public constructors

### CronetEngine

```
CronetEngine()
```

## Public functions

### addRequestFinishedListener

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

Registers a listener that gets called after the end of each request with the request info.

The listener is called on an `https://developer.android.com/reference/java/util/concurrent/Executor.html` provided by the listener.

| Parameters |
|---|---|
| `listener: https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/RequestFinishedInfo.Listener!` | the listener for finished requests. |

### addRttListener

```
fun addRttListener(listener: NetworkQualityRttListener!): Unit
```

Registers a listener that gets called whenever the network quality estimator witnesses a sample round trip time. This must be called after `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/CronetEngine.Builder#enableNetworkQualityEstimator(boolean)`, and with throw an exception otherwise. Round trip times may be recorded at various layers of the network stack, including TCP, QUIC, and at the URL request layer. The listener is called on the `https://developer.android.com/reference/java/util/concurrent/Executor.html` that is passed to `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/CronetEngine.Builder#enableNetworkQualityEstimator(boolean)`.

| Parameters |
|---|---|
| `listener: https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/NetworkQualityRttListener!` | the listener of round trip times. |

### addThroughputListener

```
fun addThroughputListener(listener: NetworkQualityThroughputListener!): Unit
```

Registers a listener that gets called whenever the network quality estimator witnesses a sample throughput measurement. This must be called after `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/CronetEngine.Builder#enableNetworkQualityEstimator(boolean)`. Throughput observations are computed by measuring bytes read over the active network interface at times when at least one URL response is being received. The listener is called on the `https://developer.android.com/reference/java/util/concurrent/Executor.html` that is passed to `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/CronetEngine.Builder#enableNetworkQualityEstimator(boolean)`.

| Parameters |
|---|---|
| `listener: https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/NetworkQualityThroughputListener!` | the listener of throughput. |

### bindToNetwork

```
fun bindToNetwork(networkHandle: Long): Unit
```

Binds the engine to the specified network handle. All requests created through this engine will use the network associated to this handle. If this network disconnects all requests will fail, the exact error will depend on the stage of request processing when the network disconnects. Network handles can be obtained through `Network#getNetworkHandle`. Only available starting from Android Marshmallow.

| Parameters |
|---|---|
| `networkHandle: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html` | the network handle to bind the engine to. Specify `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/CronetEngine#UNBIND_NETWORK_HANDLE()` to unbind. |

### configureNetworkQualityEstimatorForTesting

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

Configures the network quality estimator for testing. This must be called before round trip time and throughput listeners are added, and after the network quality estimator has been enabled.

| Parameters |
|---|---|
| `useLocalHostRequests: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html` | include requests to localhost in estimates. |
| `useSmallerResponses: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html` | include small responses in throughput estimates. |
| `disableOfflineCheck: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html` | when set to true, disables the device offline checks when computing the effective connection type or when writing the prefs. |

### createURLStreamHandlerFactory

```
abstract fun createURLStreamHandlerFactory(): URLStreamHandlerFactory!
```

Creates a `https://developer.android.com/reference/java/net/URLStreamHandlerFactory.html` to handle HTTP and HTTPS traffic. An instance of this class can be installed via `https://developer.android.com/reference/java/net/URL.html#setURLStreamHandlerFactory(java.net.URLStreamHandlerFactory)` thus using this CronetEngine by default for all requests created via openConnection.

Cronet does not use certain HTTP features provided via the system:

- the HTTP cache installed via `https://developer.android.com/reference/android/net/http/HttpResponseCache.html#install(java.io.File, long)`
- the HTTP authentication method installed via `https://developer.android.com/reference/java/net/Authenticator.html#setDefault(java.net.Authenticator)`
- the HTTP cookie storage installed via `https://developer.android.com/reference/java/net/CookieHandler.html#setDefault(java.net.CookieHandler)`

While Cronet supports and encourages requests using the HTTPS protocol, Cronet does not provide support for the `https://developer.android.com/reference/javax/net/ssl/HttpsURLConnection.html` API. This lack of support also includes not using certain HTTPS features provided via the system:

- the HTTPS hostname verifier installed via `https://developer.android.com/reference/javax/net/ssl/HttpsURLConnection.html#setDefaultHostnameVerifier(javax.net.ssl.HostnameVerifier)`
- the HTTPS socket factory installed via `https://developer.android.com/reference/javax/net/ssl/HttpsURLConnection.html#setDefaultSSLSocketFactory(javax.net.ssl.SSLSocketFactory)`

| Returns |
|---|---|
| `https://developer.android.com/reference/java/net/URLStreamHandlerFactory.html!` | an `https://developer.android.com/reference/java/net/URLStreamHandlerFactory.html` instance implemented by this CronetEngine. |

### getActiveRequestCount

```
fun getActiveRequestCount(): Int
```

Returns the number of active requests.

A request becomes "active" in UrlRequest.start(), assuming that method does not throw an exception. It becomes inactive when all callbacks have returned and no additional callbacks can be triggered in the future. In practice, that means the request is inactive once onSucceeded/onCanceled/onFailed has returned and all request finished listeners have returned. [Cronet requests's lifecycle](https://developer.android.com/guide/topics/connectivity/cronet/lifecycle) for more information.

### getDownstreamThroughputKbps

```
fun getDownstreamThroughputKbps(): Int
```

Returns the downstream throughput estimate (in kilobits per second) computed by the network quality estimator. Set to `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/CronetEngine#CONNECTION_METRIC_UNKNOWN()` if the value is unavailable. This must be called after `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/CronetEngine.Builder#enableNetworkQualityEstimator(boolean)`, and will throw an exception otherwise.

| Returns |
|---|---|
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html` | Estimate of the downstream throughput in kilobits per second. |

### getEffectiveConnectionType

```
fun getEffectiveConnectionType(): Int
```

Returns an estimate of the effective connection type computed by the network quality estimator. Call `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/CronetEngine.Builder#enableNetworkQualityEstimator(boolean)` to begin computing this value.

| Returns |
|---|---|
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html` | the estimated connection type. The returned value is one of `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/CronetEngine#EFFECTIVE_CONNECTION_TYPE_UNKNOWN()`. |

### getGlobalMetricsDeltas

```
abstract fun [getGlobalMetricsDeltas](https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/CronetEngine#getGlobalMetricsDeltas())(): ByteArray<Byte>!
```

> [!CAUTION]
> **This function is deprecated.**   
>
> In modern versions of Cronet, this will always return an empty array. In older versions, this used to return a serialized protobuf containing metrics data.

### getHttpRttMs

```
fun getHttpRttMs(): Int
```

Returns the HTTP RTT estimate (in milliseconds) computed by the network quality estimator. Set to `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/CronetEngine#CONNECTION_METRIC_UNKNOWN()` if the value is unavailable. This must be called after `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/CronetEngine.Builder#enableNetworkQualityEstimator(boolean)`, and will throw an exception otherwise.

| Returns |
|---|---|
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html` | Estimate of the HTTP RTT in milliseconds. |

### getTransportRttMs

```
fun getTransportRttMs(): Int
```

Returns the transport RTT estimate (in milliseconds) computed by the network quality estimator. Set to `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/CronetEngine#CONNECTION_METRIC_UNKNOWN()` if the value is unavailable. This must be called after `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/CronetEngine.Builder#enableNetworkQualityEstimator(boolean)`, and will throw an exception otherwise.

| Returns |
|---|---|
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html` | Estimate of the transport RTT in milliseconds. |

### getVersionString

```
abstract fun getVersionString(): String!
```

| Returns |
|---|---|
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html!` | a human-readable version string of the engine. |

### newUrlRequestBuilder

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

Creates a builder for `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/UrlRequest`. All callbacks for generated `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/UrlRequest` objects will be invoked on `executor`'s threads. `executor` must not run tasks on the thread calling `https://developer.android.com/reference/java/util/concurrent/Executor.html#execute(java.lang.Runnable)` to prevent blocking networking operations and causing exceptions during shutdown.

| Parameters |
|---|---|
| `url: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html!` | URL for the generated requests. |
| `callback: https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/UrlRequest.Callback!` | callback object that gets invoked on different events. |
| `executor: https://developer.android.com/reference/java/util/concurrent/Executor.html!` | `https://developer.android.com/reference/java/util/concurrent/Executor.html` on which all callbacks will be invoked. |

### openConnection

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

Establishes a new connection to the resource specified by the `https://developer.android.com/reference/java/net/URL.html``url`.

**Note:** Cronet's `https://developer.android.com/reference/java/net/HttpURLConnection.html` implementation is subject to certain limitations, see `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/CronetEngine#createURLStreamHandlerFactory()` for details.

| Parameters |
|---|---|
| `url: https://developer.android.com/reference/java/net/URL.html!` | URL of resource to connect to. |

| Returns |
|---|---|
| `https://developer.android.com/reference/java/net/URLConnection.html!` | an `https://developer.android.com/reference/java/net/HttpURLConnection.html` instance implemented by this CronetEngine. |

| Throws |
|---|---|
| `https://developer.android.com/reference/java/io/IOException.html` | if an error occurs while opening the connection. |

### removeRequestFinishedListener

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

Removes a finished request listener.

| Parameters |
|---|---|
| `listener: https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/RequestFinishedInfo.Listener!` | the listener to remove. |

### removeRttListener

```
fun removeRttListener(listener: NetworkQualityRttListener!): Unit
```

Removes a listener of round trip times if previously registered with `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/CronetEngine#addRttListener(org.chromium.net.NetworkQualityRttListener)`. This should be called after a `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/NetworkQualityRttListener` is added in order to stop receiving observations.

| Parameters |
|---|---|
| `listener: https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/NetworkQualityRttListener!` | the listener of round trip times. |

### removeThroughputListener

```
fun removeThroughputListener(listener: NetworkQualityThroughputListener!): Unit
```

Removes a listener of throughput. This should be called after a `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/NetworkQualityThroughputListener` is added with `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/CronetEngine#addThroughputListener(org.chromium.net.NetworkQualityThroughputListener)` in order to stop receiving observations.

| Parameters |
|---|---|
| `listener: https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/NetworkQualityThroughputListener!` | the listener of throughput. |

### shutdown

```
abstract fun shutdown(): Unit
```

Shuts down the `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/CronetEngine` if there are no active requests, otherwise throws an exception.

Cannot be called on network thread - the thread Cronet calls into Executor on (which is different from the thread the Executor invokes callbacks on). May block until all the `
CronetEngine`'s resources have been cleaned up.

### startNetLogToDisk

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

Starts NetLog logging to a specified directory with a bounded size. The NetLog will contain events emitted by all live CronetEngines. The NetLog is useful for debugging. Once logging has stopped `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/CronetEngine#stopNetLog()`, the data will be written to netlog.json in `dirPath`. If logging is interrupted, you can stitch the files found in .inprogress subdirectory manually using: https://chromium.googlesource.com/chromium/src/+/main/net/tools/stitch_net_log_files.py. The log can be viewed using a Chrome browser navigated to chrome://net-internals/#import.

| Parameters |
|---|---|
| `dirPath: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html!` | the directory where the netlog.json file will be created. dirPath must already exist. NetLog files must not exist in the directory. If actively logging, this method is ignored. |
| `logAll: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html` | `true` to include basic events, user cookies, credentials and all transferred bytes in the log. This option presents a privacy risk, since it exposes the user's credentials, and should only be used with the user's consent and in situations where the log won't be public. `false` to just include basic events. |
| `maxSize: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html` | the maximum total disk space in bytes that should be used by NetLog. Actual disk space usage may exceed this limit slightly. |

### startNetLogToFile

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

Starts NetLog logging to a file. The NetLog will contain events emitted by all live CronetEngines. The NetLog is useful for debugging. The file can be viewed using a Chrome browser navigated to chrome://net-internals/#import

| Parameters |
|---|---|
| `fileName: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html!` | the complete file path. It must not be empty. If the file exists, it is truncated before starting. If actively logging, this method is ignored. |
| `logAll: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html` | `true` to include basic events, user cookies, credentials and all transferred bytes in the log. This option presents a privacy risk, since it exposes the user's credentials, and should only be used with the user's consent and in situations where the log won't be public. `false` to just include basic events. |

### stopNetLog

```
abstract fun stopNetLog(): Unit
```

Stops NetLog logging and flushes file to disk. If a logging session is not in progress, this call is ignored.