simbot-extension-continuous-session/love.forte.simbot.extension.continuous.session/ContinuousSession

ContinuousSession

interface ContinuousSession<T, R> : ContinuousSessionProvider<T, R> , ContinuousSessionReceiver<T, R> (source)

组合 ContinuousSessionProvider 和 ContinuousSessionReceiver 的 session 类型。

Inherited properties

coroutineContext

abstract override val coroutineContext: CoroutineContext

ContinuousSessionReceiver 作为 CoroutineScope 的协程上下文。其中不会包含 Job。

abstract val isActive: Boolean

是否处于活跃状态。

abstract val isCancelled: Boolean

是否由于 cancel 而完成。

abstract val isCompleted: Boolean

是否已经完成。

Inherited functions

abstract suspend fun await(): SessionContinuation<T, R>

等待 ContinuousSessionProvider 的下一次推送结果，并将此结果和推送]ContinuousSessionProvider.push 处的挂起点打包为 SessionContinuation，并在稍后通过 SessionContinuation.resume 或 SessionContinuation.resumeWithException 恢复。

abstract suspend fun await(result: R): T

等待 ContinuousSessionProvider 的下一次推送，并在接收到时恢复一个结果 result。

abstract suspend fun await(result: (T) -> R): T

等待 ContinuousSessionProvider 的下一次推送，并在接收到时恢复一个由 result 计算的结果。

open fun cancel()

abstract fun cancel(cause: Throwable?)

关闭对应的 session。关闭后会同时将对应的 session 从对应的 ContinuousSessionContext 中移除。

abstract suspend fun join()

挂起直到 session 完成任务或被关闭。

abstract override fun onCompletion(handle: OnCompletion)

注册一个当 session 完成任务后执行的回调 handle。也可以通过此回调得知被终止时的异常。

abstract suspend fun push(value: T): R

推送一个事件到对应的 ContinuousSessionReceiver 中并挂起直到将其消费或被关闭。