4.14.0-SNAPSHOT

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

Package-level declarations

Types

AbstractContinuousSessionContext

abstract class AbstractContinuousSessionContext<T, R>(coroutineContext: CoroutineContext) : ContinuousSessionContext<T, R>

针对 ContinuousSessionContext 的基础抽象实现类。

fun interface AsyncInSession<C, T, R> : InSession<C, T, R>

以异步的API构造 InSession 实例。可通过 InSessions.async 构造。

fun interface BlockInSession<C, T, R> : InSession<C, T, R>

以阻塞的API构造 InSession 实例。可通过 InSessions.block 构造。

ConflictSessionKeyException

class ConflictSessionKeyException(message: String?) : IllegalArgumentException

冲突的 session key.

ContinuousSession

interface ContinuousSession<C, T, R> : ContinuousSessionProvider<C, T, R> , ContinuousSessionReceiver<C, T, R>

组合 ContinuousSessionProvider 和 ContinuousSessionReceiver 的 session 类型。

ContinuousSessionContext

interface ContinuousSessionContext<T, R>

持续会话(continuous session)管理器，用于承载一组 ContinuousSessionProvider 和 ContinuousSessionReceiver 的上下文。用于构建与管理 ContinuousSession。

ContinuousSessionKey

interface ContinuousSessionKey<C>

A Key for ContinuousSession.

ContinuousSessionProvider

interface ContinuousSessionProvider<C, in T, out R> : CompletionAware

一组 Session 的元素之一，用来向 ContinuousSessionReceiver 推送事件 T 并获悉结果 R 的“供应者”。

ContinuousSessionReceiver

interface ContinuousSessionReceiver<C, out T, R> : CoroutineScope

一组 Session 的元素之一，用来在异步中接收 ContinuousSessionProvider 推送的事件 T 并根据此事件为其返回结果 R。

EventContinuousSessionContext

interface EventContinuousSessionContext : ContinuousSessionContext<Event, EventResult> , Plugin

以事件为中心的 ContinuousSessionContext 子类型。

EventContinuousSessionContextConfiguration

class EventContinuousSessionContextConfiguration

EventContinuousSessionContext.Factory 使用的配置类。

ExperimentalContinuousSessionAPI

annotation class ExperimentalContinuousSessionAPI

fun interface InSession<C, T, R>

使用于 ContinuousSessionContext.session 中的 receiver 逻辑函数。

fun interface MonoInSession<C, T, R> : InSession<C, T, R>

以响应式风格 (Mono) 的API构造 InSession 实例。可通过 InSessions.mono 构造。

MultipleAwaitResult

sealed class MultipleAwaitResult<T>

ReplacedBecauseOfConflictSessionKeyException

class ReplacedBecauseOfConflictSessionKeyException(message: String?) : IllegalStateException

因出现冲突的 session key 而被替换

SessionAwaitOnFailureException

class SessionAwaitOnFailureException : IllegalStateException

当使用 ContinuousSessionProvider.push 推送成功、但是在 ContinuousSessionReceiver.await 过程中出现异常时（例如构造返回给 push 的结果时出现异常）则此异常会使用 SessionAwaitOnFailureException 进行包装。

SessionCompletedWithoutResumeException

class SessionCompletedWithoutResumeException : IllegalStateException

当 Session 已经结束、但是某个 continuation 并未被恢复时，使用此异常恢复它。如果 session 的结束伴随着异常，此异常会记录在 cause 中。

SessionContinuation

interface SessionContinuation<C, out T, in R> : ContinuousSessionReceiver.Received<C, T>

ContinuousSessionReceiver.await 的返回值类型，可用来获取到本次等待到的推送结果，并向其恢复一个结果或异常。

SessionPushOnFailureException

class SessionPushOnFailureException : IllegalStateException

当使用 ContinuousSessionProvider.push 推送失败时，会将异常包装在 SessionPushOnFailureException.cause 中。

UnitContinuousSessionKey

class UnitContinuousSessionKey : ContinuousSessionKey<Unit>

A ContinuousSessionKey for Unit.

Functions

@JvmName(name = "async")

fun <C, T, R> asyncInSession(function: AsyncInSession<C, T, R>): InSession<C, T, R>

Java 友好 API，用于构造一个异步风格的 InSession 实例。

@JvmName(name = "block")

fun <C, T, R> blockInSession(context: CoroutineContext? = null, function: BlockInSession<C, T, R>): InSession<C, T, R>

Java 友好 API，用于构造一个阻塞风格的 InSession 实例。

ContinuousSessionContext

@JvmName(name = "createContinuousSessionContext")

fun <T, R> ContinuousSessionContext(coroutineContext: CoroutineContext): ContinuousSessionContext<T, R>

创建一个 ContinuousSessionContext 的基础实现类型。

createSimpleSessionContinuation

fun <C, T, R> createSimpleSessionContinuation(context: C, value: T, continuation: CancellableContinuation<R>, handle: DisposableHandle? = null): SessionContinuation<C, T, R>

构建一个基于 CancellableContinuation 实现的 SessionContinuation 实例。

@JvmName(name = "mono")

fun <C, T, R> monoInSession(function: MonoInSession<C, T, R>): InSession<C, T, R>

Java 友好 API，用于构造一个响应式风格 (Mono) 的 InSession 实例。

Inherited functions

suspend fun <C, T, R> ContinuousSessionReceiver<C, T, R>.awaitValue(result: R): T

suspend fun <C, T, R> ContinuousSessionReceiver<C, T, R>.awaitValue(result: (ContinuousSessionReceiver.Received<C, T>) -> R): T

inline suspend fun <C, T, R> ContinuousSessionReceiver<C, T, R>.awaitWith(block: (C, T) -> R)

multipleAwaitWith

inline suspend fun <C, T, R> ContinuousSessionReceiver<C, T, R>.multipleAwaitWith(block: MultipleAwaitResult.Factory.(C, T) -> MultipleAwaitResult<R>): R

进行多轮次处理。如果 block 的返回值类型不是 MultipleAwaitResult.Valid, 则 multipleAwaitWith 会继续 await 直到得到 MultipleAwaitResult.Valid 结果或产生了异常。

suspend fun <T, R> ContinuousSessionProvider<Unit, T, R>.push(value: T): R

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