github-repos/mirai
1
0
Fork 0
mirror of https://github.com/mamoe/mirai.git synced 2025-01-31 03:22:36 +08:00
Code Issues Packages Projects Releases Wiki Activity

Enhance nextEvent and nextEventOrNull: add filter

Browse Source
This commit is contained in:
Him188 2020-08-18 22:37:26 +08:00
parent 4703095f46
commit 3340651998
1 changed files with 17 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
mirai-core/src/commonMain/kotlin/net.mamoe.mirai/event/nextEvent.kt
View File

@ -15,50 +15,57 @@ import kotlinx.coroutines.*
import net.mamoe.mirai.Bot
import net.mamoe.mirai.event.events.BotEvent
import net.mamoe.mirai.utils.PlannedRemoval
import net.mamoe.mirai.utils.SinceMirai
import kotlin.coroutines.resume
import kotlin.jvm.JvmSynthetic
import kotlin.reflect.KClass
/**
* 挂起当前协程, 直到监听到事件 [E] 的广播, 返回这个事件实例.
* 挂起当前协程, 直到监听到事件 [E] 的广播并通过 [filter], 返回这个事件实例.
*
* @param timeoutMillis 超时. 单位为毫秒. `-1` 为不限制.
* @param filter 过滤器. 返回 `true` 时表示得到了需要的实例. 返回 `false` 时表示继续监听
*
* @see subscribe 普通地监听一个事件
* @see syncFromEvent 挂起当前协程, 并尝试从事件中同步一个值
*
* @throws TimeoutCancellationException 在超时后抛出.
*/
@SinceMirai("1.2.0")
@JvmSynthetic
public suspend inline fun <reified E : Event> nextEvent(
timeoutMillis: Long = -1,
priority: Listener.EventPriority = EventPriority.MONITOR
priority: Listener.EventPriority = EventPriority.MONITOR,
crossinline filter: E.(E) -> Boolean = { true }
): E {
require(timeoutMillis == -1L || timeoutMillis > 0) { "timeoutMillis must be -1 or > 0" }
return withTimeoutOrCoroutineScope(timeoutMillis) {
nextEventImpl(E::class, this, priority)
nextEventImpl(E::class, this, priority, filter)
}
}
/**
* 挂起当前协程, 直到监听到事件 [E] 的广播, 返回这个事件实例.
* 挂起当前协程, 直到监听到事件 [E] 的广播并通过 [filter], 返回这个事件实例.
*
* @param timeoutMillis 超时. 单位为毫秒. `-1` 为不限制.
* @param filter 过滤器. 返回 `true` 时表示得到了需要的实例. 返回 `false` 时表示继续监听
*
* @see subscribe 普通地监听一个事件
* @see syncFromEvent 挂起当前协程, 并尝试从事件中同步一个值
*
* @return 事件实例, 在超时后返回 `null`
*/
@SinceMirai("1.2.0")
@JvmSynthetic
public suspend inline fun <reified E : Event> nextEventOrNull(
timeoutMillis: Long,
priority: Listener.EventPriority = EventPriority.MONITOR
priority: Listener.EventPriority = EventPriority.MONITOR,
crossinline filter: E.(E) -> Boolean = { true }
): E? {
return withTimeoutOrNull(timeoutMillis) {
nextEventImpl(E::class, this, priority)
nextEventImpl(E::class, this, priority, filter)
}
}
@ -92,9 +99,12 @@ public suspend inline fun <reified E : BotEvent> Bot.nextEvent(
internal suspend inline fun <E : Event> nextEventImpl(
eventClass: KClass<E>,
coroutineScope: CoroutineScope,
priority: Listener.EventPriority
priority: Listener.EventPriority,
crossinline filter: E.(E) -> Boolean
): E = suspendCancellableCoroutine { cont ->
coroutineScope.subscribe(eventClass, priority = priority) {
if (!filter(this, this)) return@subscribe ListeningStatus.LISTENING
try {
cont.resume(this)
} catch (e: Exception) {