simbot-api/love.forte.simbot.application

Package-level declarations

Types

AbstractApplicationBuilder

abstract class AbstractApplicationBuilder : ApplicationBuilder

ApplicationBuilder 的基础抽象实现。

AbstractApplicationEventRegistrar

abstract class AbstractApplicationEventRegistrar : ApplicationEventRegistrar

ApplicationEventRegistrar 的基础抽象实现。

AbstractApplicationFactoryConfigurer

abstract class AbstractApplicationFactoryConfigurer<C : ApplicationBuilder, AER : ApplicationEventRegistrar, DC : EventDispatcherConfiguration>(val configConfigurers: MutableList<ConfigurerFunction<C>> = mutableListOf(), val applicationEventRegistrarConfigurations: MutableList<ConfigurerFunction<AER>> = mutableListOf(), val eventDispatcherConfigurers: MutableList<ConfigurerFunction<DC>> = mutableListOf(), val componentFactoriesConfigurator: ComponentFactoriesConfigurator = ComponentFactoriesConfigurator(), val pluginFactoriesConfigurator: PluginFactoriesConfigurator = PluginFactoriesConfigurator()) : ApplicationFactoryConfigurer<C, AER, DC>

ApplicationFactoryConfigurer 的基础抽象实现，提供大部分DSL配置能力的简单实现。

Application

interface Application : CoroutineScope, LifecycleAware, CompletionAware

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

ApplicationBuilder

interface ApplicationBuilder

用于构建 Application 的构建器，同时也提供针对 ApplicationConfiguration 基础属性的配置能力。

ApplicationConfiguration

interface ApplicationConfiguration

一个 Application 所需的最基础的配置信息内容。

ApplicationEventHandler

sealed interface ApplicationEventHandler

针对一些不同的 ApplicationLaunchStage 的事件处理器的统一类型。

ApplicationEventRegistrar

interface ApplicationEventRegistrar

Application 事件注册器。

ApplicationFactory

interface ApplicationFactory<out A : Application, C : ApplicationBuilder, L : ApplicationLauncher<A>, AER : ApplicationEventRegistrar, DC : EventDispatcherConfiguration>

用于构建一个 ApplicationFactory 的工厂。

ApplicationFactoryConfigurer

interface ApplicationFactoryConfigurer<C : ApplicationBuilder, AER : ApplicationEventRegistrar, DC : EventDispatcherConfiguration> : ComponentInstaller, PluginInstaller

构建 Application 配置阶段的 DSL API 配置器。

ApplicationFactoryConfigurerDSL

@DslMarker

annotation class ApplicationFactoryConfigurerDSL

DSL marker for ApplicationFactoryConfigurer

ApplicationLaunchBlockingFailureException

class ApplicationLaunchBlockingFailureException : RuntimeException

ApplicationLauncher

interface ApplicationLauncher<out A : Application>

Application 的预处理启动器。当执行 ApplicationLauncher.launch 时会构建并启动 Application。

ApplicationLaunchStage

sealed class ApplicationLaunchStage<H : ApplicationEventHandler>

Application 在启动过程中的一些阶段类型。

ApplicationLaunchStages

interface ApplicationLaunchStages

一组 ApplicationLaunchStage 和各对应的处理器集。

JAsyncApplicationLauncher

fun interface JAsyncApplicationLauncher<out A : Application>

Application 的预处理启动器。当执行 ApplicationLauncher.launch 时会构建并启动 Application。

JAsyncSuspendApplicationEventHandler

fun interface JAsyncSuspendApplicationEventHandler<in C>

针对一些不同的 ApplicationLaunchStage 的事件异步处理器。

JBlockingApplicationLauncher

fun interface JBlockingApplicationLauncher<out A : Application>

Application 的预处理启动器。当执行 ApplicationLauncher.launch 时会构建并启动 Application。

JBlockingSuspendApplicationEventHandler

fun interface JBlockingSuspendApplicationEventHandler<in C>

针对一些不同的 ApplicationLaunchStage 的事件阻塞处理器。

NormalApplicationEventHandler

fun interface NormalApplicationEventHandler<in C> : ApplicationEventHandler

针对一些不同的 ApplicationLaunchStage 的普通事件处理器。

SuspendApplicationEventHandler

fun interface SuspendApplicationEventHandler<in C> : ApplicationEventHandler

针对一些不同的 ApplicationLaunchStage 的事件可挂起处理器。

Functions

applicationLaunchStages

fun applicationLaunchStages(map: Map<ApplicationLaunchStage<*>, Iterable<ApplicationEventHandler>>): ApplicationLaunchStages

通过一个 Map 构建得到 ApplicationLaunchStages

launchApplication

inline suspend fun <A : Application, C : AbstractApplicationBuilder, L : ApplicationLauncher<A>, AER : ApplicationEventRegistrar, DC : EventDispatcherConfiguration> launchApplication(factory: ApplicationFactory<A, C, L, AER, DC>, crossinline configurer: ApplicationFactoryConfigurer<C, AER, DC>.() -> Unit = {}): A

构建一个 Application 并启动它。

launchApplicationAsync

@JvmOverloads

fun <A : Application, C : AbstractApplicationBuilder, L : ApplicationLauncher<A>, AER : ApplicationEventRegistrar, DC : EventDispatcherConfiguration> launchApplicationAsync(factory: ApplicationFactory<A, C, L, AER, DC>, configurer: ConfigurerFunction<ApplicationFactoryConfigurer<C, AER, DC>>? = null): Async<A>

@JvmOverloads

fun <A : Application, C : AbstractApplicationBuilder, L : ApplicationLauncher<A>, AER : ApplicationEventRegistrar, DC : EventDispatcherConfiguration> launchApplicationAsync(scope: CoroutineScope, factory: ApplicationFactory<A, C, L, AER, DC>, configurer: ConfigurerFunction<ApplicationFactoryConfigurer<C, AER, DC>>? = null): Async<A>

构建一个 Application 并异步地启动它。

launchApplicationBlocking

@JvmOverloads

fun <A : Application, C : AbstractApplicationBuilder, L : ApplicationLauncher<A>, AER : ApplicationEventRegistrar, DC : EventDispatcherConfiguration> launchApplicationBlocking(factory: ApplicationFactory<A, C, L, AER, DC>, configurer: ConfigurerFunction<ApplicationFactoryConfigurer<C, AER, DC>>? = null): A

构建一个 Application 并阻塞地启动它。

Inherited functions

asCompletableFuture

fun Application.asCompletableFuture(): CompletableFuture<Unit>

将 Application 转作 CompletableFuture。

invokeOnEach

inline fun <H : ApplicationEventHandler> ApplicationLaunchStages.invokeOnEach(stage: ApplicationLaunchStage<H>, block: H.() -> Unit)

Find and invoke handlers form stage

joinWith

inline suspend fun <T : Application> T.joinWith(block: T.() -> Unit)

执行完 block 后挂起当前 Application。

listeners

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

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

onCancelled

fun ApplicationEventRegistrar.onCancelled(handler: NormalApplicationEventHandler<Application>)

Add a handler for ApplicationLaunchStage.Cancelled.

onLaunch

fun ApplicationEventRegistrar.onLaunch(handler: SuspendApplicationEventHandler<Application>)

Add a handler for ApplicationLaunchStage.Launch.

onRequestCancel

fun ApplicationEventRegistrar.onRequestCancel(handler: NormalApplicationEventHandler<Application>)

Add a handler for ApplicationLaunchStage.RequestCancel.