模块 wjybxx.commons.disruptor

程序包 cn.wjybxx.disruptor

类 RingBufferEventSequencer<E>

java.lang.Object

cn.wjybxx.disruptor.RingBufferEventSequencer<E>

所有已实现的接口:

DataProvider<E>, EventSequencer<E>

public class RingBufferEventSequencer<E>
extends Object
implements EventSequencer<E>

作者:

wjybxx date - 2024/1/17

嵌套类概要

嵌套类

修饰符和类型	类	说明
static class	RingBufferEventSequencer.Builder<E>

字段概要

从接口继承的字段 cn.wjybxx.disruptor.EventSequencer

UNBOUNDED_CAPACITY

构造器概要

构造器

构造器	说明
RingBufferEventSequencer(RingBufferEventSequencer.Builder<E> builder)

方法概要

修饰符和类型	方法	说明
void	addGatingBarriers(SequenceBarrier... gatingBarriers)	添加一个网关屏障 -- 消费链最末端的消费者屏障
int	capacity()	数据结构大小 1.如果为【无界】数据结构，则返回-1； 2.如果为【有界】数据结构，则返回真实值。
final E	consumerGet(long sequence)	该接口用于优化消费者查询数据
void	consumerSet(long sequence, E data)	该接口用于消费者覆盖数据(通常用于删除数据) 1.当使用无界队列需要即时清理内存时使用。
final E	get(long sequence)	根据指定序号获取data 该接口可用于生产者和消费者获取数据，但对于非固定大小的数据结构而言，可能有较长的查询路径。
RingBuffer<E>	getBuffer()
boolean	hasAvailableCapacity(int requiredCapacity)
ConsumerBarrier	newMultiConsumerBarrier(int workerCount, SequenceBarrier... barriersToTrack)	创建一个【多消费者】的屏障 -- 使用自定义等待策略
ConsumerBarrier	newMultiConsumerBarrier(int workerCount, WaitStrategy waitStrategy, SequenceBarrier... barriersToTrack)	创建一个【多消费者】的屏障 -- 使用自定义等待策略
static <E> RingBufferEventSequencer.Builder<E>	newMultiProducer()	多线程生产者builder
static <E> RingBufferEventSequencer.Builder<E>	newMultiProducer(EventFactory<? extends E> factory)	多线程生产者builder
ConsumerBarrier	newSingleConsumerBarrier(SequenceBarrier... barriersToTrack)	创建一个【单消费者】的屏障 -- 使用默认的等待策略
ConsumerBarrier	newSingleConsumerBarrier(WaitStrategy waitStrategy, SequenceBarrier... barriersToTrack)	创建一个【单消费者】的屏障 -- 使用自定义等待策略
static <E> RingBufferEventSequencer.Builder<E>	newSingleProducer()	单线程生产者builder
static <E> RingBufferEventSequencer.Builder<E>	newSingleProducer(EventFactory<? extends E> factory)	单线程生产者builder
long	next()
long	next(int n)
long	nextInterruptibly()
long	nextInterruptibly(int n)
ProducerBarrier	producerBarrier()	获取生产者屏障 -- 生产者发布数据
final E	producerGet(long sequence)	该接口用于优化生产者查询数据
void	producerSet(long sequence, E data)	该接口用于生产者填充数据 1.
void	publish(long sequence)
void	publish(long lo, long hi)
long	remainingCapacity()	当前剩余容量 1.并不一定具有价值，因为多线程模型下查询容器的当前大小时，它反映的总是一个旧值。
boolean	removeGatingBarrier(SequenceBarrier gatingBarrier)	移除一个网关屏障 -- 消费链最末端的消费者屏障
Sequencer	sequencer()	获取序号生成器 -- 用于特殊需求
long	tryNext()
long	tryNext(int n)
long	tryNext(int n, long timeout, TimeUnit unit)

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

RingBufferEventSequencer

public RingBufferEventSequencer(RingBufferEventSequencer.Builder<E> builder)

方法详细资料

getBuffer

public RingBuffer<E> getBuffer()

get

public final E get(long sequence)

从接口复制的说明: DataProvider

根据指定序号获取data 该接口可用于生产者和消费者获取数据，但对于非固定大小的数据结构而言，可能有较长的查询路径。

指定者:

get 在接口中 DataProvider<E>

producerGet

public final E producerGet(long sequence)

从接口复制的说明: DataProvider

该接口用于优化生产者查询数据

指定者:

producerGet 在接口中 DataProvider<E>

consumerGet

public final E consumerGet(long sequence)

从接口复制的说明: DataProvider

该接口用于优化消费者查询数据

指定者:

consumerGet 在接口中 DataProvider<E>

producerSet

public void producerSet(long sequence,
 E data)

从接口复制的说明: DataProvider

该接口用于生产者填充数据 1. 当拷贝既有数据成本较高时可替换既有对象 2. set不提供特殊的内存语义，因此只应该生产者调用

指定者:

producerSet 在接口中 DataProvider<E>

consumerSet

public void consumerSet(long sequence,
 E data)

从接口复制的说明: DataProvider

该接口用于消费者覆盖数据(通常用于删除数据) 1.当使用无界队列需要即时清理内存时使用。 2.set不提供特殊的内存语义，因此只应该由末尾的消费者调用

指定者:

consumerSet 在接口中 DataProvider<E>

capacity

public int capacity()

从接口复制的说明: EventSequencer

数据结构大小 1.如果为【无界】数据结构，则返回-1； 2.如果为【有界】数据结构，则返回真实值。

The capacity of the data structure to hold entries.

指定者:

capacity 在接口中 EventSequencer<E>

返回:

the size of the RingBuffer.

remainingCapacity

public long remainingCapacity()

从接口复制的说明: EventSequencer

当前剩余容量 1.并不一定具有价值，因为多线程模型下查询容器的当前大小时，它反映的总是一个旧值。 2.如果为【无界】数据结构，可能返回任意值（大于0），但建议返回Integer.MAX_VALUE。 3.如果为【有界】数据结构，则返回真实的值。

Get the remaining capacity for this sequencer.

指定者:

remainingCapacity 在接口中 EventSequencer<E>

返回:

The number of slots remaining.

sequencer

public Sequencer sequencer()

从接口复制的说明: EventSequencer

获取序号生成器 -- 用于特殊需求

指定者:

sequencer 在接口中 EventSequencer<E>

producerBarrier

public ProducerBarrier producerBarrier()

从接口复制的说明: EventSequencer

获取生产者屏障 -- 生产者发布数据

指定者:

producerBarrier 在接口中 EventSequencer<E>

addGatingBarriers

public void addGatingBarriers(SequenceBarrier... gatingBarriers)

从接口复制的说明: EventSequencer

添加一个网关屏障 -- 消费链最末端的消费者屏障

指定者:

addGatingBarriers 在接口中 EventSequencer<E>

removeGatingBarrier

public boolean removeGatingBarrier(SequenceBarrier gatingBarrier)

从接口复制的说明: EventSequencer

移除一个网关屏障 -- 消费链最末端的消费者屏障

指定者:

removeGatingBarrier 在接口中 EventSequencer<E>

newSingleConsumerBarrier

public ConsumerBarrier newSingleConsumerBarrier(SequenceBarrier... barriersToTrack)

从接口复制的说明: EventSequencer

创建一个【单消费者】的屏障 -- 使用默认的等待策略

指定者:

newSingleConsumerBarrier 在接口中 EventSequencer<E>

newSingleConsumerBarrier

public ConsumerBarrier newSingleConsumerBarrier(WaitStrategy waitStrategy,
 SequenceBarrier... barriersToTrack)

从接口复制的说明: EventSequencer

创建一个【单消费者】的屏障 -- 使用自定义等待策略

指定者:

newSingleConsumerBarrier 在接口中 EventSequencer<E>

newMultiConsumerBarrier

public ConsumerBarrier newMultiConsumerBarrier(int workerCount,
 SequenceBarrier... barriersToTrack)

从接口复制的说明: EventSequencer

创建一个【多消费者】的屏障 -- 使用自定义等待策略

指定者:

newMultiConsumerBarrier 在接口中 EventSequencer<E>

newMultiConsumerBarrier

public ConsumerBarrier newMultiConsumerBarrier(int workerCount,
 WaitStrategy waitStrategy,
 SequenceBarrier... barriersToTrack)

从接口复制的说明: EventSequencer

创建一个【多消费者】的屏障 -- 使用自定义等待策略

指定者:

newMultiConsumerBarrier 在接口中 EventSequencer<E>

hasAvailableCapacity

public boolean hasAvailableCapacity(int requiredCapacity)

指定者:

hasAvailableCapacity 在接口中 EventSequencer<E>

next

public long next()

指定者:

next 在接口中 EventSequencer<E>

next

public long next(int n)

指定者:

next 在接口中 EventSequencer<E>

tryNext

public long tryNext()

指定者:

tryNext 在接口中 EventSequencer<E>

tryNext

public long tryNext(int n)

指定者:

tryNext 在接口中 EventSequencer<E>

nextInterruptibly

public long nextInterruptibly()
                       throws InterruptedException

指定者:

nextInterruptibly 在接口中 EventSequencer<E>

抛出:

InterruptedException

nextInterruptibly

public long nextInterruptibly(int n)
                       throws InterruptedException

指定者:

nextInterruptibly 在接口中 EventSequencer<E>

抛出:

InterruptedException

tryNext

public long tryNext(int n,
 long timeout,
 TimeUnit unit)

指定者:

tryNext 在接口中 EventSequencer<E>

publish

public void publish(long sequence)

指定者:

publish 在接口中 EventSequencer<E>

publish

public void publish(long lo,
 long hi)

指定者:

publish 在接口中 EventSequencer<E>

newMultiProducer

public static <E>
RingBufferEventSequencer.Builder<E> newMultiProducer()

多线程生产者builder

newMultiProducer

public static <E>
RingBufferEventSequencer.Builder<E> newMultiProducer(EventFactory<? extends E> factory)

多线程生产者builder

newSingleProducer

public static <E>
RingBufferEventSequencer.Builder<E> newSingleProducer()

单线程生产者builder

newSingleProducer

public static <E>
RingBufferEventSequencer.Builder<E> newSingleProducer(EventFactory<? extends E> factory)

单线程生产者builder