From baa3c2109ec06c48d65229079d3a4d2f69472fcf Mon Sep 17 00:00:00 2001
From: Him188 <Him188@mamoe.net>
Date: Fri, 6 Mar 2020 10:17:36 +0800
Subject: [PATCH] Use Channel.UNLIMITED as a default capacity for
`CoroutineScope.incoming`
---
.../kotlin/net.mamoe.mirai/event/subscribeMessages.kt | 5 ++++-
1 file changed, 4 insertions(+), 1 deletion(-)
diff --git a/mirai-core/src/commonMain/kotlin/net.mamoe.mirai/event/subscribeMessages.kt b/mirai-core/src/commonMain/kotlin/net.mamoe.mirai/event/subscribeMessages.kt
index d6cacba04..503592fc6 100644
--- a/mirai-core/src/commonMain/kotlin/net.mamoe.mirai/event/subscribeMessages.kt
+++ b/mirai-core/src/commonMain/kotlin/net.mamoe.mirai/event/subscribeMessages.kt
@@ -160,13 +160,16 @@ inline fun <R> Bot.subscribeFriendMessages(
*
* @param capacity 同 [Channel] 的参数, 参见 [Channel.Factory] 中的常量.
*
+ * @see capacity 默认无限大小. 详见 [Channel.Factory] 中的常量 [Channel.UNLIMITED], [Channel.CONFLATED], [Channel.RENDEZVOUS].
+ * 请谨慎使用 [Channel.RENDEZVOUS]: 在 [Channel] 未被 [接收][Channel.receive] 时他将会阻塞事件处理
+ *
* @see subscribeFriendMessages
* @see subscribeMessages
* @see subscribeGroupMessages
*/
inline fun <reified E : Event> CoroutineScope.incoming(
coroutineContext: CoroutineContext = EmptyCoroutineContext,
- capacity: Int = Channel.RENDEZVOUS
+ capacity: Int = Channel.UNLIMITED
): ReceiveChannel<E> {
return Channel<E>(capacity).apply {
subscribeAlways<E>(coroutineContext) {