ktor-client-core/io.ktor.client.plugins/HttpTimeout/HttpTimeoutCapabilityConfiguration

HttpTimeoutCapabilityConfiguration

class HttpTimeoutCapabilityConfiguration

An HttpTimeout extension configuration that is used during installation.

Constructors

fun HttpTimeoutCapabilityConfiguration(requestTimeoutMillis: Long? = null, connectTimeoutMillis: Long? = null, socketTimeoutMillis: Long? = null)

Creates a new instance of HttpTimeoutCapabilityConfiguration.

Types

Companion

object Companion

Functions

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

Properties

connectTimeoutMillis

var connectTimeoutMillis: Long?

Specifies a connection timeout in milliseconds. The connection timeout is the time period in which a client should establish a connection with a server.

requestTimeoutMillis

var requestTimeoutMillis: Long?

Specifies a request timeout in milliseconds. The request timeout is the time period required to process an HTTP call: from sending a request to receiving a response.

socketTimeoutMillis

var socketTimeoutMillis: Long?

Specifies a socket timeout (read and write) in milliseconds. The socket timeout is the maximum time of inactivity between two data packets when exchanging data with a server.