annotation class SuspendTrans(val blockingBaseName: String = "", val blockingSuffix: String = "Blocking", val blockingAsProperty: Boolean = false, val asyncBaseName: String = "", val asyncSuffix: String = "Async", val asyncAsProperty: Boolean = false, val reserveBaseName: String = "", val reserveSuffix: String = "Reserve", val reserveAsProperty: Boolean = false)

SuspendTransProperty

@Target(allowedTargets = [AnnotationTarget.FUNCTION, AnnotationTarget.CLASS])

annotation class SuspendTransProperty(val blockingBaseName: String = "", val blockingSuffix: String = "", val blockingAsProperty: Boolean = true, val asyncBaseName: String = "", val asyncSuffix: String = "Async", val asyncAsProperty: Boolean = true, val reserveBaseName: String = "", val reserveSuffix: String = "Reserve", val reserveAsProperty: Boolean = false, val jsPromiseBaseName: String = "", val jsPromiseSuffix: String = "Async", val jsPromiseAsProperty: Boolean = false)

用于代表同时标记 love.forte.plugin.suspendtrans.annotation.JvmBlocking 和 love.forte.plugin.suspendtrans.annotation.JvmAsync 的整合性注解。

Properties

DefaultAsyncContext

@InternalSimbotAPI

val DefaultAsyncContext: CoroutineContext

默认的异步调用（Java异步，例如 CompletableFuture 或 runInAsync）上下文。

DefaultAsyncDispatcher

@InternalSimbotAPI

val DefaultAsyncDispatcher: CoroutineDispatcher

如果 DefaultAsyncDispatcherOrNull 为 null，得到 Dispatchers.Default, 否则得到 DefaultAsyncDispatcherOrNull的值。

DefaultAsyncDispatcherOrNull

@InternalSimbotAPI

val DefaultAsyncDispatcherOrNull: CoroutineDispatcher?

使用在非协程环境下的异步API（例如 runInAsync ）中的默认调度器。会在首次被获取的时候进行实例化。

DefaultBlockingContext

@InternalSimbotAPI

val DefaultBlockingContext: CoroutineContext

在 runInBlocking 中使用的默认上下文实例。

DefaultBlockingDispatcher

@InternalSimbotAPI

val DefaultBlockingDispatcher: CoroutineDispatcher

如果 DefaultBlockingDispatcherOrNull 为 null，得到 Dispatchers.IO, 否则使用 DefaultBlockingDispatcherOrNull 的值。

DefaultBlockingDispatcherOrNull

@InternalSimbotAPI

val DefaultBlockingDispatcherOrNull: CoroutineDispatcher?

使用在阻塞API（例如 runInBlocking ）或非Java协程环境中的默认调度器。会在首次被获取的时候进行实例化。

VirtualThreadDispatcher

@ExperimentalSimbotAPI

val VirtualThreadDispatcher: CoroutineDispatcher

使用 Executors.newVirtualThreadPerTaskExecutor 构建的全局虚拟线程“线程池”。如果不支持虚拟线程则会抛出 UnsupportedOperationException。

Functions

asReserve

@InternalSimbotAPI

fun <T> asReserve(scope: CoroutineScope? = null, context: CoroutineContext? = null, block: suspend () -> T): SuspendReserve<T>

@InternalSimbotAPI

fun <T> asReserve(scope: CoroutineScope? = null, context: CoroutineContext? = null, block: suspend () -> T): SuspendReserve<T>

将 block 包装为 SuspendReserve. scope 如果为 null 则会使用 GlobalScope。

runInAsync

@InternalSimbotAPI

fun <T> runInAsync(block: suspend CoroutineScope.() -> T): CompletableFuture<T>

执行一个异步函数，得到 CompletableFuture. 默认情况下会使用 GlobalScope 作为调度作用域。

@InternalSimbotAPI

fun <T> runInAsync(scope: CoroutineScope, context: CoroutineContext = EmptyCoroutineContext, block: suspend CoroutineScope.() -> T): CompletableFuture<T>

执行一个异步函数，得到 CompletableFuture.

runInBlocking

fun <T> runInBlocking(context: CoroutineContext = DefaultBlockingContext, block: suspend CoroutineScope.() -> T): T

在simbot中提供的 runBlocking 包装。

runInNoScopeBlocking

fun <T> runInNoScopeBlocking(context: CoroutineContext = DefaultBlockingContext, block: suspend () -> T): T

在simbot中提供的 runBlocking 包装。

runInNoScopeTimeoutBlocking

fun <T> runInNoScopeTimeoutBlocking(timeout: Long, context: CoroutineContext = DefaultBlockingContext, block: suspend () -> T): T

如果超时，则抛出 TimeoutException.

runInPromise

@DelicateCoroutinesApi

@InternalSimbotAPI

inline fun <T> runInPromise(context: CoroutineContext = EmptyCoroutineContext, crossinline block: suspend CoroutineScope.() -> T): Promise<T>

使用 GlobalScope 执行一个异步函数，得到 Promise.

@InternalSimbotAPI

inline fun <T> runInPromise(scope: CoroutineScope, context: CoroutineContext = EmptyCoroutineContext, crossinline block: suspend CoroutineScope.() -> T): Promise<T>

执行一个异步函数，得到 Promise.

runInTimeoutBlocking

fun <T> runInTimeoutBlocking(timeout: Long, context: CoroutineContext = DefaultBlockingContext, block: suspend CoroutineScope.() -> T): T

如果超时，则抛出 TimeoutCancellationException.

setRunInBlockingStrategy

@ExperimentalSimbotAPI

fun setRunInBlockingStrategy(strategy: RunInBlockingStrategy)

设置一个 runInBlocking 函数的实际调度逻辑。

setRunInNoScopeBlockingStrategy

@ExperimentalSimbotAPI

fun setRunInNoScopeBlockingStrategy(strategy: RunInNoScopeBlockingStrategy)

设置一个 runInNoScopeBlocking 函数的实际调度逻辑。