Ksui/xyz.mcxross.ksui.client/ClientConfig

ClientConfig

expect class ClientConfig
actual class ClientConfig
actual class ClientConfig
actual class ClientConfig
actual class ClientConfig

Constructors

Link copied to clipboard
constructor(followRedirects: Boolean = true, likeAgent: UserAgent? = null, agent: String = "Ksui/Js", requestTimeout: Long = 10000, retryOnServerErrors: Int = -1, maxRetries: Int = -1, 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 = -1, maxRetries: Int = -1, cache: Boolean = false, agent: String = "Ksui/JVM", likeAgent: UserAgent? = null, requestTimeout: Long = 10000, connectTimeout: Long = 10000, proxy: String? = null)
constructor(followRedirects: Boolean = true, agent: String = "Ksui/Linux", likeAgent: <Error class: unknown class>? = null, retryOnServerErrors: Int = -1, maxRetries: Int = -1, requestTimeout: Long = 10000, connectTimeout: Long = 10000, proxy: String? = null, cache: Boolean = true)
constructor(followRedirects: Boolean = true, agent: String = "Ksui/Win", likeAgent: UserAgent? = null, requestTimeout: Long = 10000, connectTimeout: Long = 10000, retryOnServerErrors: Int = -1, maxRetries: Int = -1, cache: Boolean = false, proxy: String? = null)

Types

Link copied to clipboard
expect object Companion
actual object Companion
actual object Companion
actual object Companion
actual object Companion

Properties

agent
Link copied to clipboard
var agent: String

Specifies the user agent. Default is Ksui/Js.

var agent: String

Specifies the user agent. Default is Ksui.

var agent: String

Specifies the user agent. Default is Ksui.

var agent: String

Specifies the user agent. Default is Ksui/Win.

cache
Link copied to clipboard
var cache: Boolean

Enables or disables caching. Default is false.

var cache: Boolean

Enables or disables caching. Default is false.

var cache: Boolean

Specifies whether the client should cache responses. Default is true.

var cache: Boolean

Enables or disables caching. Default is false.

Link copied to clipboard
var connectAttempts: Int

Specifies the number of connect attempts. Default is 5.

connectTimeout
Link copied to clipboard
var connectTimeout: Long

Specifies a timeout for establishing a connection with a node.

var connectTimeout: Long

Specifies a timeout for establishing a connection with a node.

var connectTimeout: Long

Specifies a timeout for establishing a connection with a node.

Link copied to clipboard
var connectTimeoutMillis: Long

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

followRedirects
Link copied to clipboard
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.

var followRedirects: Boolean

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

Link copied to clipboard
var keepAliveTime: Long

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

likeAgent
Link copied to clipboard
var likeAgent: UserAgent?

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

var likeAgent: UserAgent?

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

var likeAgent: <Error class: unknown class>?

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.

Link copied to clipboard
var maxConnectionsCount: Int

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

Link copied to clipboard
var maxConnectionsPerRoute: Int

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

maxRetries
Link copied to clipboard
var maxRetries: Int

Specifies how many times the client should retry on connection errors. Default is -1, which means no retries.

var maxRetries: Int

Specifies how many times the client should retry on connection errors. Default is -1, which means no retries.

var maxRetries: Int

Specifies how many times the client should retry on connection errors. Default is -1, which means no retries.

var maxRetries: Int

Specifies how many times the client should retry on connection errors. Default is -1, which means no retries.

Link copied to clipboard
var pipelineMaxSize: Int

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

Link copied to clipboard
var pipelining: Boolean

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

proxy
Link copied to clipboard
var proxy: String?

Specifies the proxy to use. Default is null.

var proxy: String?

Specifies a proxy for the client to use.

var proxy: String?

Specifies the maximum number of connections the client can have.

var proxy: String?

Specifies the proxy to use. Default is null.

requestTimeout
Link copied to clipboard
var requestTimeout: Long

Specifies the request timeout in milliseconds. Default is 10000.

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.

var requestTimeout: Long

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

retryOnServerErrors
Link copied to clipboard
var retryOnServerErrors: Int

Specifies how many times the client should retry on server errors. Default is -1, which means no retries.

var retryOnServerErrors: Int

Specifies how many times the client should retry on server errors. Default is -1, which means no retries.

var retryOnServerErrors: Int

Specifies how many times the client should retry on server errors. Default is -1, which means no retries.

var retryOnServerErrors: Int

Specifies how many times the client should retry on server errors. Default is -1, which means no retries.