CLIENT UNBLOCK

语法
CLIENT UNBLOCK client-id [TIMEOUT | ERROR]
可用版本
Redis 开源版 5.0.0
时间复杂度
O(log N),其中 N 是客户端连接数
ACL 类别
@admin, @slow, @dangerous, @connection,

此命令可以从不同的连接中解除被阻塞操作(例如 BRPOPXREADWAIT)阻塞的客户端。

默认情况下,客户端解除阻塞的方式与命令达到超时时相同,但是如果传递一个附加的(可选)参数,则可以指定解除阻塞的行为,该行为可以是 TIMEOUT(默认)或 ERROR。如果指定 ERROR,则行为是解除客户端阻塞并返回客户端被强制解除阻塞的错误。具体来说,客户端将收到以下错误:

-UNBLOCKED client unblocked via CLIENT UNBLOCK

注意:当然,通常不能保证错误文本保持不变,但错误代码将保持为 -UNBLOCKED

此命令在通过有限数量的连接监视许多键时特别有用。例如,我们可能希望使用 XREAD 监视多个流,而不会使用超过 N 个连接。然而,在某些时候,消费者进程会收到通知,告知还有一个流键需要监视。为了避免使用更多连接,最好的行为是停止连接池中某个连接的阻塞命令,添加新键,然后再次发出阻塞命令。

为了实现此行为,使用以下模式。进程使用一个额外的控制连接,以便在需要时发送 CLIENT UNBLOCK 命令。同时,在其他连接上运行阻塞操作之前,进程运行 CLIENT ID 以获取与该连接关联的 ID。当需要添加新键或不再监视某个键时,通过在控制连接中发送 CLIENT UNBLOCK 来中止相关的连接阻塞命令。阻塞命令将返回,并最终可以重新发出。

此示例展示了在 Redis 流上下文中的应用,但此模式具有通用性,可应用于其他情况。

示例

Connection A (blocking connection):
> CLIENT ID
2934
> BRPOP key1 key2 key3 0
(client is blocked)

... Now we want to add a new key ...

Connection B (control connection):
> CLIENT UNBLOCK 2934
1

Connection A (blocking connection):
... BRPOP reply with timeout ...
NULL
> BRPOP key1 key2 key3 key4 0
(client is blocked again)

RESP2/RESP3 回复

以下之一

  • 整数回复:如果客户端成功解除阻塞,则为 1
  • 整数回复:如果客户端未解除阻塞,则为 0

评价此页面
回到顶部 ↑