Package com.lmax.disruptor

Class PhasedBackoffWaitStrategy

  • All Implemented Interfaces:
    WaitStrategy
    public final class PhasedBackoffWaitStrategy
extends java.lang.Object
implements WaitStrategy

    Phased wait strategy for waiting EventProcessors on a barrier.

    This strategy can be used when throughput and low-latency are not as important as CPU resource. Spins, then yields, then waits using the configured fallback WaitStrategy.

    • Constructor Detail

      • PhasedBackoffWaitStrategy

        public PhasedBackoffWaitStrategy​(long spinTimeout,
                                 long yieldTimeout,
                                 java.util.concurrent.TimeUnit units,
                                 WaitStrategy fallbackStrategy)

    • Method Detail

      • withLock

        public static PhasedBackoffWaitStrategy withLock​(long spinTimeout,
                                                 long yieldTimeout,
                                                 java.util.concurrent.TimeUnit units)
        Block with wait/notifyAll semantics

      • withLiteLock

        public static PhasedBackoffWaitStrategy withLiteLock​(long spinTimeout,
                                                     long yieldTimeout,
                                                     java.util.concurrent.TimeUnit units)
        Block with wait/notifyAll semantics

      • withSleep

        public static PhasedBackoffWaitStrategy withSleep​(long spinTimeout,
                                                  long yieldTimeout,
                                                  java.util.concurrent.TimeUnit units)
        Block by sleeping in a loop

      • waitFor

        public long waitFor​(long sequence,
                    Sequence cursor,
                    Sequence dependentSequence,
                    SequenceBarrier barrier)
             throws AlertException,
                    java.lang.InterruptedException,
                    TimeoutException
        Description copied from interface: WaitStrategy
        Wait for the given sequence to be available. It is possible for this method to return a value less than the sequence number supplied depending on the implementation of the WaitStrategy. A common use for this is to signal a timeout. Any EventProcessor that is using a WaitStrategy to get notifications about message becoming available should remember to handle this case. The BatchEventProcessor explicitly handles this case and will signal a timeout if required.
        Specified by:
        waitFor in interface WaitStrategy
        Parameters:
        sequence - to be waited on.
        cursor - the main sequence from ringbuffer. Wait/notify strategies will need this as it's the only sequence that is also notified upon update.
        dependentSequence - on which to wait.
        barrier - the processor is waiting on.
        Returns:
        the sequence that is available which may be greater than the requested sequence.
        Throws:
        AlertException - if the status of the Disruptor has changed.
        java.lang.InterruptedException - if the thread is interrupted.
        TimeoutException