ktor-client-okhttp/io.ktor.client.engine.okhttp/OkHttpConfig

OkHttpConfig

class OkHttpConfig : HttpClientEngineConfig(source)

A configuration for the OkHttp client engine.

Report a problem

Constructors

OkHttpConfig

constructor()

Properties

clientCacheSize

var clientCacheSize: Int

Specifies the size of cache that keeps recently used OkHttpClient instances. Set this property to 0 to disable caching.

dispatcher

var dispatcher: CoroutineDispatcher?

duplexStreamingEnabled

var duplexStreamingEnabled: Boolean

Specifies if duplex streaming is enabled for the OkHttpClient. Setting this to true allows clients to send and receive data simultaneously using bidirectional streaming (HTTP/2 only).

pipelining

var pipelining: Boolean

preconfigured

var preconfigured: OkHttpClient?

Allows you to specify a preconfigured OkHttpClient instance.

proxy

var proxy: ProxyConfig?

threadsCount

var ~~threadsCount~~: Int

webSocketFactory

var webSocketFactory: WebSocket.Factory?

Specifies the WebSocket.Factory used to create a WebSocket instance. Otherwise, OkHttpClient is used directly.

Functions

addInterceptor

fun addInterceptor(interceptor: Interceptor)

Adds an Interceptor to the OkHttp client.

addNetworkInterceptor

fun addNetworkInterceptor(interceptor: Interceptor)

Adds a network Interceptor to the OkHttp client.

config

fun config(block: OkHttpClient.Builder.() -> Unit)

Configures OkHttpClient using OkHttpClient.Builder.