simbot-component-kook-stdlib/love.forte.simbot.kook.stdlib/BotConfiguration

BotConfiguration

class BotConfiguration(source)

Bot 使用的配置。

Author

ForteScarlet

Constructors

BotConfiguration

constructor()

Types

Companion

object Companion

EngineConfiguration

@Serializable

data class EngineConfiguration(var pipelining: Boolean? = null)

针对 HttpClientEngineConfig 中的通用默认属性的配置。

TimeoutConfiguration

@Serializable

data class TimeoutConfiguration(var connectTimeoutMillis: Long? = null, var requestTimeoutMillis: Long? = null, var socketTimeoutMillis: Long? = null)

api请求的统一超时时间配置。

Properties

clientEngine

var clientEngine: HttpClientEngine?

配置bot内部要使用的client Engine。

clientEngineConfig

var clientEngineConfig: BotConfiguration.EngineConfiguration?

针对 HttpClientEngineConfig 中的通用默认属性的配置。

clientEngineFactory

var clientEngineFactory: HttpClientEngineFactory<*>?

配置bot内部要使用的client Engine factory。

connectTimeoutMillis

var connectTimeoutMillis: Long?

HTTP API 请求的连接超时时间。

coroutineContext

var coroutineContext: CoroutineContext

为bot提供一个 CoroutineContext。如果其中存在 kotlinx.coroutines.Job, 则会作为 parent job。

isCompress

var isCompress: Boolean

设置bot进行连接的时候使用要使用压缩数据。

isNormalEventProcessAsync

var isNormalEventProcessAsync: Boolean

SubscribeSequence.NORMAL 类型的事件处理器是否在异步中执行。默认为 true。当为 false 时, SubscribeSequence.NORMAL 的表现效果将会与 SubscribeSequence.PREPARE 基本类似。

requestTimeoutMillis

var requestTimeoutMillis: Long?

HTTP API 请求的请求超时时间。

socketTimeoutMillis

var socketTimeoutMillis: Long?

HTTP API 请求的请求超时时间。

timeout

var timeout: BotConfiguration.TimeoutConfiguration?

api请求的超时配置。如果为null则不会在 httpClient 中安装 io.ktor.client.plugins.HttpTimeout。

wsConnectTimeout

var wsConnectTimeout: Long

ws连接超时时间，单位 ms 。默认为 DEFAULT_WS_CONNECT_TIMEOUT.

wsEngine

var wsEngine: HttpClientEngine?

配置bot内部要使用的 ws 连接用的 client Engine。

wsEngineConfig

var wsEngineConfig: BotConfiguration.EngineConfiguration?

针对 HttpClientEngineConfig 中的通用默认属性的配置。

wsEngineFactory

var wsEngineFactory: HttpClientEngineFactory<*>?

配置bot内部要使用的 ws Engine factory。

Functions

disableTimeout

fun disableTimeout()

禁用超时配置。

Inherited functions

engine

inline fun BotConfiguration.engine(init: Boolean = true, block: BotConfiguration.EngineConfiguration.() -> Unit)

配置 BotConfiguration.clientEngineConfig。

timeout

inline fun BotConfiguration.timeout(init: Boolean = true, block: BotConfiguration.TimeoutConfiguration.() -> Unit)

配置 BotConfiguration.timeout。