Kaptos/xyz.mcxross.kaptos.client/ClientConfig

ClientConfig

Constructors

constructor(followRedirects: Boolean = true, followSslRedirects: Boolean = true, connectTimeoutMillis: Long = 10000, readTimeoutMillis: Long = 10000, writeTimeoutMillis: Long = 10000, proxy: String? = null, agent: String = "Kaptos/Android", likeAgent: UserAgent? = null, retryOnServerErrors: Int = 0, maxRetries: Int = 0, cache: Boolean = false)

constructor(followRedirects: Boolean = true, agent: String = "Kaptos/Darwin", likeAgent: UserAgent? = null, requestTimeout: Long = 10000, retryOnServerErrors: Int = 0, maxRetries: Int = 0, cache: Boolean = false, proxy: String? = null)

constructor(pipelining: Boolean = false, pipelineMaxSize: Int = 20, followRedirects: Boolean = true, maxConnectionsPerRoute: Int = 100, maxConnectionsCount: Int = 1000, connectTimeoutMillis: Long = 10000, keepAliveTime: Long = 5000, connectAttempts: Int = 5, retryOnServerErrors: Int = 0, maxRetries: Int = 0, cache: Boolean = false, agent: String = "Kaptos/JVM", likeAgent: UserAgent? = null, requestTimeout: Long = 10000, connectTimeout: Long = 10000, proxy: String? = null)

Types

Companion

actual object Companion

expect object Companion

actual object Companion

Properties

agent

var agent: String

Specifies the agent the node sees. Default is Kaptos.

var agent: String

Specifies the user agent. Default is Kaptos.

var agent: String

Specifies the user agent. Default is Kaptos.

cache

var cache: Boolean

Enables or disables caching. Default is false.

var cache: Boolean

Enables or disables caching. Default is false.

var cache: Boolean

Enables or disables caching. Default is false.

connectAttempts

var connectAttempts: Int

Specifies the number of connect attempts. Default is 5.

connectTimeout

var connectTimeout: Long

Specifies a timeout for establishing a connection with a node.

connectTimeoutMillis

var connectTimeoutMillis: Long

Specifies the connection timeout in milliseconds. Default is 10000.

var connectTimeoutMillis: Long

Specifies the connect timeout in milliseconds. Default is 10000L.

followRedirects

var followRedirects: Boolean

Specifies whether the client should follow redirects. Default is true.

var followRedirects: Boolean

Specifies whether the client should follow redirects. Default is true.

var followRedirects: Boolean

Specifies whether the client should follow redirects. Default is true.

followSslRedirects

var followSslRedirects: Boolean

Specifies whether the client should follow SSL redirects. Default is true.

keepAliveTime

var keepAliveTime: Long

Specifies the keep alive time in milliseconds. Default is 5000L.

likeAgent

var likeAgent: UserAgent?

Use a like agent. If this is set, the agent field will be ignored.

var likeAgent: UserAgent?

Use a like agent. If this is set, the agent field will be ignored.

var likeAgent: UserAgent?

Use a like agent. If this is set, the agent field will be ignored.

maxConnectionsCount

var maxConnectionsCount: Int

Specifies the maximum number of connections used to make requests. Default is 1000.

maxConnectionsPerRoute

var maxConnectionsPerRoute: Int

Specifies the maximum number of connections per route. Default is 100.

maxRetries

var maxRetries: Int

Specifies how many times the client should retry on connection errors. Default is 0.

var maxRetries: Int

Specifies how many times the client should retry on connection errors. Default is 0.

var maxRetries: Int

Specifies how many times the client should retry on connection errors. Default is 0.

pipelineMaxSize

var pipelineMaxSize: Int

Specifies the maximum size of the pipeline. Default is 20.

pipelining

var pipelining: Boolean

Specifies whether the client should use pipelining. Default is false.

proxy

var proxy: String?

Specifies the proxy to use. Default is null.

var proxy: String?

Specifies the proxy to use. Default is null.

var proxy: String?

Specifies a proxy for the client to use.

readTimeoutMillis

var readTimeoutMillis: Long

Specifies the read timeout in milliseconds. Default is 10000.

requestTimeout

var requestTimeout: Long

Specifies a timeout for a whole HTTP call, from sending a request to receiving a response.

var requestTimeout: Long

Specifies a timeout for a whole HTTP call, from sending a request to receiving a response.

retryOnServerErrors

var retryOnServerErrors: Int

Specifies how many times the client should retry on server errors. Default is 0.

var retryOnServerErrors: Int

Specifies how many times the client should retry on server errors. Default is 0.

var retryOnServerErrors: Int

Specifies how many times the client should retry on server errors. Default is 0.

writeTimeoutMillis

var writeTimeoutMillis: Long

Specifies the write timeout in milliseconds. Default is 10000.