ktor-client-apache/io.ktor.client.engine.apache/ApacheEngineConfig

ApacheEngineConfig

class ApacheEngineConfig : HttpClientEngineConfig

Configuration for Apache implementation of HttpClientEngineFactory.

Constructors

ApacheEngineConfig

fun ApacheEngineConfig()

Functions

customizeClient

fun customizeClient(block: HttpAsyncClientBuilder.() -> Unit)

Customizes a HttpAsyncClientBuilder in the specified block.

customizeRequest

fun customizeRequest(block: RequestConfig.Builder.() -> Unit)

Customizes a RequestConfig.Builder in the specified block.

Properties

connectionRequestTimeout

var connectionRequestTimeout: Int

Max milliseconds for the connection manager to start a request - default 20 seconds. A value of 0 represents infinite, while -1 represents system's default value.

connectTimeout

var connectTimeout: Int

Max milliseconds to establish an HTTP connection - default 10 seconds. A value of 0 represents infinite, while -1 represents system's default value.

customClient

var customClient: HttpAsyncClientBuilder.() -> HttpAsyncClientBuilder

Custom processor for HttpAsyncClientBuilder.

customRequest

var customRequest: RequestConfig.Builder.() -> RequestConfig.Builder

Custom processor for RequestConfig.Builder.

followRedirects

var followRedirects: Boolean = false

Whether or not, it will follow Location headers. false by default. It uses the default number of redirects defined by Apache's HttpClient that is 50.

pipelining

var pipelining: Boolean

proxy

var proxy: ProxyConfig?

response

~~val~~ ~~response~~: Nothing

socketTimeout

var socketTimeout: Int

Max milliseconds between TCP packets - default 10 seconds. A value of 0 represents infinite, while -1 represents system's default value.

sslContext

var sslContext: SSLContext? = null

Optional Java's SSLContext allowing to set custom keys, trust manager or custom source for secure random data

threadsCount

var threadsCount: Int