com.alipay.disruptor

接口 Sequencer

所有超级接口:

Cursored, Sequenced

所有已知实现类:

AbstractSequencer, MultiProducerSequencer, SingleProducerSequencer

public interface Sequencer
extends Cursored, Sequenced

Coordinates claiming sequences for access to a data structure while tracking dependent Sequences

字段概要

字段

限定符和类型	字段和说明
static long	INITIAL_CURSOR_VALUE Set to -1 as sequence starting point

方法概要

方法

限定符和类型	方法和说明
void	addGatingSequences(Sequence... gatingSequences) Add the specified gating sequences to this instance of the Disruptor.
void	claim(long sequence) Claim a specific sequence.
long	getHighestPublishedSequence(long nextSequence, long availableSequence) Get the highest sequence number that can be safely read from the ring buffer.
long	getMinimumSequence() Get the minimum sequence value from all of the gating sequences added to this ringBuffer.
boolean	isAvailable(long sequence) Confirms if a sequence is published and the event is available for use; non-blocking.
SequenceBarrier	newBarrier(Sequence... sequencesToTrack) Create a new SequenceBarrier to be used by an EventProcessor to track which messages are available to be read from the ring buffer given a list of sequences to track.
<T> EventPoller<T>	newPoller(DataProvider<T> provider, Sequence... gatingSequences)
boolean	removeGatingSequence(Sequence sequence) Remove the specified sequence from this sequencer.

从接口继承的方法 com.alipay.disruptor.Cursored

getCursor

从接口继承的方法 com.alipay.disruptor.Sequenced

getBufferSize, hasAvailableCapacity, next, next, publish, publish, remainingCapacity, tryNext, tryNext

字段详细资料

INITIAL_CURSOR_VALUE

static final long INITIAL_CURSOR_VALUE

Set to -1 as sequence starting point

另请参阅:

常量字段值

方法详细资料

claim

void claim(long sequence)

Claim a specific sequence. Only used if initialising the ring buffer to a specific value.

参数:

sequence - The sequence to initialise too.

isAvailable

boolean isAvailable(long sequence)

Confirms if a sequence is published and the event is available for use; non-blocking.

参数:

sequence - of the buffer to check

返回:

true if the sequence is available for use, false if not

addGatingSequences

void addGatingSequences(Sequence... gatingSequences)

Add the specified gating sequences to this instance of the Disruptor. They will safely and atomically added to the list of gating sequences.

参数:

gatingSequences - The sequences to add.

removeGatingSequence

boolean removeGatingSequence(Sequence sequence)

Remove the specified sequence from this sequencer.

参数:

sequence - to be removed.

返回:

true if this sequence was found, false otherwise.

newBarrier

SequenceBarrier newBarrier(Sequence... sequencesToTrack)

Create a new SequenceBarrier to be used by an EventProcessor to track which messages are available to be read from the ring buffer given a list of sequences to track.

参数:

sequencesToTrack - sequencesToTrack

返回:

A sequence barrier that will track the specified sequences.

另请参阅:

SequenceBarrier

getMinimumSequence

long getMinimumSequence()

Get the minimum sequence value from all of the gating sequences added to this ringBuffer.

返回:

The minimum gating sequence or the cursor sequence if no sequences have been added.

getHighestPublishedSequence

long getHighestPublishedSequence(long nextSequence,
                               long availableSequence)

Get the highest sequence number that can be safely read from the ring buffer. Depending on the implementation of the Sequencer this call may need to scan a number of values in the Sequencer. The scan will range from nextSequence to availableSequence. If there are no available values >= nextSequence the return value will be nextSequence - 1. To work correctly a consumer should pass a value that it 1 higher than the last sequence that was successfully processed.

参数:

nextSequence - The sequence to start scanning from.

availableSequence - The sequence to scan to.

返回:

The highest value that can be safely read, will be at least nextSequence - 1.

newPoller

<T> EventPoller<T> newPoller(DataProvider<T> provider,
                           Sequence... gatingSequences)