simbot-api/love.forte.simbot.ability/Switchable

Switchable

interface Switchable : DelayableCoroutineScope

可开关的。

此接口提供 start、cancel 等相关开始、关闭的操作。

对于开关操作，在执行了 cancel 之后将不允许二次开启。

Author

ForteScarlet

Functions

cancel

abstract suspend fun cancel(reason: Throwable? = null): Boolean

关闭操作.

cancelAsync

@Api4J

open fun cancelAsync(): CompletableFuture<Boolean>

cancelBlocking

@Api4J

open fun cancelBlocking(): Boolean

delay

@Api4J

open fun delay(duration: JavaDuration, runnable: Runnable): DelayableCompletableFuture<Void?>

延时 duration 时间后执行回调函数 runnable，得到一个 DelayableCompletableFuture。

@Api4J

open fun delay(millis: Long, runnable: Runnable): DelayableCompletableFuture<Void?>

延迟 millis 毫秒后执行 runnable，得到一个 DelayableCompletableFuture。

@Api4J

open fun delay(time: Long, timeUnit: TimeUnit, runnable: Runnable): DelayableCompletableFuture<Void?>

延迟时间单位为 timeUnit 的 time 时长后执行 runnable，得到一个 DelayableCompletableFuture。

delayAndCompute

@Api4J

open fun <V> delayAndCompute(duration: JavaDuration, supplier: Supplier<V>): DelayableCompletableFuture<V>

延迟 duration 时间后，执行 supplier，并将 supplier 得到结果通过得到的 DelayableCompletableFuture 向下传递。

@Api4J

open fun <V> delayAndCompute(millis: Long, supplier: Supplier<V>): DelayableCompletableFuture<V>

延迟 millis 毫秒的时长后执行 supplier，并将 supplier 得到结果通过得到的 DelayableCompletableFuture 向下传递。

@Api4J

open fun <V> delayAndCompute(time: Long, timeUnit: TimeUnit, supplier: Supplier<V>): DelayableCompletableFuture<V>

延迟时间单位为 timeUnit 的 time 时长后执行 supplier，并将 supplier 得到结果通过得到的 DelayableCompletableFuture 向下传递。

start

abstract suspend fun start(): Boolean

启动操作.

Properties

coroutineContext

abstract val coroutineContext: CoroutineContext

isActive

abstract val isActive: Boolean

是否正在运行，即启动后尚未关闭。

isCancelled

abstract val isCancelled: Boolean

是否已经被取消。

isStarted

abstract val isStarted: Boolean

是否已经启动过了。

Inheritors

Survivable

Extensions

applicationLauncher

fun <A : Application> CoroutineScope.applicationLauncher(create: suspend () -> A): ApplicationLauncher<A>

通过一个协程作用域并提供构建函数来得到一个 ApplicationLauncher 实例。

effectedFlowItems

inline fun <T> CoroutineScope.effectedFlowItems(crossinline block: suspend FlowCollector<T>.() -> Unit): Items<T>

以构建 Flow 的方式构建 Items.

effectedItemsByFlow

inline fun <T> CoroutineScope.effectedItemsByFlow(crossinline flowFactory: () -> Flow<T>): Items<T>

提供 CoroutineScope 和构建 Flow 的函数 flowFactory 来构建 Items.

flowItems

inline fun <T> CoroutineScope.flowItems(crossinline block: suspend FlowCollector<T>.(Items.PreprocessingProperties) -> Unit): Items<T>

以构建 Flow 的方式构建 Items.

itemsByFlow

inline fun <T> CoroutineScope.itemsByFlow(crossinline flowFactory: (Items.PreprocessingProperties) -> Flow<T>): Items<T>

提供 CoroutineScope 和构建 Flow 的函数 flowFactory 来构建 Items.

lazyValue

fun <T> CoroutineScope.lazyValue(init: Boolean = false, initializer: suspend () -> T): LazyValue<T>

produceItems

inline fun <T> CoroutineScope.produceItems(context: CoroutineContext = EmptyCoroutineContext, capacity: Int = 0, crossinline block: suspend ProducerScope<T>.(Items.PreprocessingProperties) -> Unit): Items<T>

通过 produce 构建 ChannelIterator 来得到一个 Items 实例。