模块 wjybxx.commons.disruptor
程序包 cn.wjybxx.disruptor

接口 ConsumerBarrier

所有超级接口:
SequenceBarrier
所有已知实现类:
MultiConsumerBarrier, SingleConsumerBarrier
public interface ConsumerBarrier extends SequenceBarrier
消费者序号屏障 1. 消费者屏障负责的是【当前消费者和生产者】、【当前消费者和前置消费者】之间的协调。
2. SequenceBarrier.dependentSequence()为【生产者的生产进度】和【前置消费者消费进度】之间的最小值。
3. 一个屏障关联一个ConsumerGroup，消费者组负责更新进度。
4. 消费者通过屏障检测终止信号，即停止以Barrier为单位。

接口差异的缘由

消费者与生产者不同，生产者明确知道自己要生产的数据数量，因此可以简单使用 tryNext(N) 申请序号； 而消费者并不知道可消费的数量，盲目调度tryNext(n)来申请序号可能导致阻塞 —— 另外，实时查询可消费序号会产生极高的开销。 安全的方式是每次只申请1个，但如果每次只申请一个，将大幅度限制消费者的吞吐量，会在申请序号上产生大量的开销。 因此，在接口层面的waitFor(long)为批量查询接口，多线程消费者内部的协调由用户自身实现。
作者:
wjybxx date - 2024/1/15

  • 方法详细资料

    • waitFor

      long waitFor(long sequence) throws TimeoutException, AlertException, InterruptedException
      等待给定的序号可消费

      警告：多生产者模式下该操作十分消耗性能，如果在waitFor获取sequence之后不完全消费， 而是每次消费一点，再拉取一点，则会在该操作上形成巨大的开销 —— 极端情况是每次拉取1个，性能将差到极致。 建议的的方式：先拉取到本地，然后在本地分批处理，避免频繁调用waitFor。

      参数:
      sequence - 等待消费的序号
      返回:
      当前可用的最大序号
      抛出:
      AlertException - if a status change has occurred for the Disruptor
      InterruptedException - if the thread needs awaking on a condition variable.
      TimeoutException - if a timeout occurs while waiting for the supplied sequence.

    • isAlerted

      boolean isAlerted()
      【当前屏障】是否收到了特殊信号
      返回:
      如果收到了终止信号，则返回true，否则返回false

    • alert

      void alert()
      通知屏障关联的生产者/消费者状态产生变化，该信号将保留至被清理 -- clearAlert()。 1. 该信号的作用类似于线程的中断信号，通常用于停止线程。 2. 用于其它目的时请慎重。

    • clearAlert

      void clearAlert()
      清除【屏障】的alert状态。

    • checkAlert

      void checkAlert() throws AlertException
      检查【屏障】的的alert状态，如果收到信号，则抛出AlertException。
      抛出:
      AlertException - if alert has been raised.

    • memberSequence

      Sequence memberSequence(int index)
      获取消费者成员的sequence (反转依赖)
      参数:
      index - 消费者索引