simbot-api/love.forte.simbot.application/Application

Application

interface Application : CoroutineScope, LifecycleAware, CompletionAware(source)

一个 simbot application. Application 可以代表为一个或一组组件、插件在一起运行的单位。

Author

ForteScarlet

Properties

botManagers

abstract val botManagers: BotManagers

当前 Application 中注册地所有 BotManager 集。通常来讲 botManagers 中的内容是 plugins 的子集。

components

abstract val components: Components

当前 Application 中注册的所有组件集。

configuration

abstract val configuration: ApplicationConfiguration

构建 Application 提供并得到的最终配置信息。

coroutineContext

abstract override val coroutineContext: CoroutineContext

Application 作为一个协程作用域的上下文信息。应当必然包含一个描述生命周期的任务 Job。

eventDispatcher

abstract val eventDispatcher: EventDispatcher

当前 Application 持有的事件调度器。

plugins

abstract val plugins: Plugins

当前 Application 中注册的所有插件集。

Inherited properties

isActive

abstract val isActive: Boolean

当前是否处于活跃、运行或尚未结束的状态。

isCompleted

abstract val isCompleted: Boolean

当前是否已经完成、已经结束。

Functions

cancel

open fun cancel()

abstract fun cancel(reason: Throwable?)

申请关闭当前 Application。

join

abstract suspend fun join()

挂起 Application 直到调用 cancel 且其内部完成了关闭 Job 的操作后。

Inherited functions

asCompletableFuture

fun Application.asCompletableFuture(): CompletableFuture<Unit>

将 Application 转作 CompletableFuture。

listeners

inline fun Application.listeners(block: EventListenerRegistrar.() -> Unit)

在 block 中操作 EventListenerRegistrar 来注册事件处理器。是通过 Application 注册事件处理器的DSL风格简化API。

onCompletion

abstract fun onCompletion(handle: OnCompletion)

当目标完成时执行注册的回调函数。