com.lmax.disruptor

Class ProcessingSequenceBarrier

java.lang.Object

com.lmax.disruptor.ProcessingSequenceBarrier

All Implemented Interfaces:

SequenceBarrier

final class ProcessingSequenceBarrier
extends java.lang.Object
implements SequenceBarrier

SequenceBarrier handed out for gating EventProcessors on a cursor sequence and optional dependent EventProcessor(s), using the given WaitStrategy.

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	alerted
private Sequence	cursorSequence
private Sequence	dependentSequence
private Sequencer	sequencer
private WaitStrategy	waitStrategy

Constructor Summary

Constructors

Constructor and Description
ProcessingSequenceBarrier(Sequencer sequencer, WaitStrategy waitStrategy, Sequence cursorSequence, Sequence[] dependentSequences)

Method Summary

Modifier and Type	Method and Description
void	alert() Alert the EventProcessors of a status change and stay in this status until cleared.
void	checkAlert() Check if an alert has been raised and throw an AlertException if it has.
void	clearAlert() Clear the current alert status.
long	getCursor() Get the current cursor value that can be read.
boolean	isAlerted() The current alert status for the barrier.
long	waitFor(long sequence) Wait for the given sequence to be available for consumption.

Methods inherited from class java.lang.Object

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

Field Detail

waitStrategy

private final WaitStrategy waitStrategy

dependentSequence

private final Sequence dependentSequence

alerted

private volatile boolean alerted

cursorSequence

private final Sequence cursorSequence

sequencer

private final Sequencer sequencer

Constructor Detail

ProcessingSequenceBarrier

public ProcessingSequenceBarrier(Sequencer sequencer,
                                 WaitStrategy waitStrategy,
                                 Sequence cursorSequence,
                                 Sequence[] dependentSequences)

Method Detail

waitFor

public long waitFor(long sequence)
             throws AlertException,
                    java.lang.InterruptedException,
                    TimeoutException

Description copied from interface: SequenceBarrier

Wait for the given sequence to be available for consumption.

Specified by:

waitFor in interface SequenceBarrier

Parameters:

sequence - to wait for

Returns:

the sequence up to which is available

Throws:

AlertException - if a status change has occurred for the Disruptor

java.lang.InterruptedException - if the thread needs awaking on a condition variable.

TimeoutException

getCursor

public long getCursor()

Description copied from interface: SequenceBarrier

Get the current cursor value that can be read.

Specified by:

getCursor in interface SequenceBarrier

Returns:

value of the cursor for entries that have been published.

isAlerted

public boolean isAlerted()

Description copied from interface: SequenceBarrier

The current alert status for the barrier.

Specified by:

isAlerted in interface SequenceBarrier

Returns:

true if in alert otherwise false.

alert

public void alert()

Description copied from interface: SequenceBarrier

Alert the EventProcessors of a status change and stay in this status until cleared.

Specified by:

alert in interface SequenceBarrier

clearAlert

public void clearAlert()

Description copied from interface: SequenceBarrier

Clear the current alert status.

Specified by:

clearAlert in interface SequenceBarrier

checkAlert

public void checkAlert()
                throws AlertException

Description copied from interface: SequenceBarrier

Check if an alert has been raised and throw an AlertException if it has.

Specified by:

checkAlert in interface SequenceBarrier

Throws:

AlertException - if alert has been raised.