com.neeve.util

Class UtlDisruptor

java.lang.Object

com.neeve.util.UtlDisruptor

public final class UtlDisruptor
extends Object

Utility class containing methods to work with disruptors.

This class IS supported for use by end users..

Constructor Summary

Constructors

Constructor and Description
UtlDisruptor()

Method Summary

Modifier and Type	Method and Description
static <T> com.lmax.disruptor.dsl.Disruptor<T>	createSingleConsumerDisruptor(com.lmax.disruptor.EventFactory<T> eventFactory, int size, ThreadFactory threadFactory, com.lmax.disruptor.dsl.ProducerType producerType, com.lmax.disruptor.WaitStrategy waitStrategy, com.lmax.disruptor.EventHandler<T> eventHandler) Create a single consumer disruptor
static com.lmax.disruptor.WaitStrategy	getWaitStrategy(String configuredWaitStrategy, boolean optimize) Get the WaitStrategy to use with a disruptor.
static com.lmax.disruptor.dsl.ProducerType	legacyClaimStrategyStrToProducerType(String claimStrategyStr) Convert a (legacy) claim strategy configuration string to a disruptor producer type
static String	toProducerTypeStr(com.lmax.disruptor.dsl.ProducerType producerType) Get a string representation for a disruptor producer type
static String	waitStrategyToStr(com.lmax.disruptor.WaitStrategy waitStrategy) Convert a disruptor wait strategy to a string

Methods inherited from class java.lang.Object

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

Constructor Detail

UtlDisruptor

public UtlDisruptor()

Method Detail

legacyClaimStrategyStrToProducerType

public static final com.lmax.disruptor.dsl.ProducerType legacyClaimStrategyStrToProducerType(String claimStrategyStr)

Convert a (legacy) claim strategy configuration string to a disruptor producer type

toProducerTypeStr

public static final String toProducerTypeStr(com.lmax.disruptor.dsl.ProducerType producerType)

Get a string representation for a disruptor producer type

getWaitStrategy

public static final com.lmax.disruptor.WaitStrategy getWaitStrategy(String configuredWaitStrategy,
                                                                    boolean optimize)
                                                             throws IllegalArgumentException

Get the WaitStrategy to use with a disruptor.

This call allows the platform to optimize disruptor wait strategy create based on the Optimization currently set for the runtime by 'nv.optimizefor' when the passed in value for optimize is true:

• When the config property 'nv.conservecpu=true' is set this method will always return a BlockingWaitStrategy to avoid spinning cores. This can be useful for test environments such as a user's workstation where spinning cores may be costly.
• When the config property 'nv.tuning.disablewaitstrategyoptimizations=true' is set this method will return the strategy corresponding to the configuredWaitStrategy passed in regardless of the value of the optimize parameter. If the configuredWaitStrategy is null, it will be set to Blocking. This is useful for applications that have manually configured wait strategies.
• Otherwise if optimize parameter is true and configuredWaitStrategy is null:
  • If #tuneForLatency() is true a BusySpinWaitStrategy is returned.
  • If #tuneForThroughput() is true a YieldingWaitStrategy is returned.

Parameters:

configuredWaitStrategy - The configured wait strategy which will be returned if the wait strategy isn't optimized. Must be one of Blocking, Sleeping, Yielding or BusySpin.

optimize - If true will optimize the configured wait strategy according to the 'nv.optimizefor' environment variable unless nv.tuning.disablewaitstrategyoptimizations=true has been set in which case such optimizations are disabled.

Returns:

A WaitStrategy for the given configuredWaitStrategy.

Throws:

IllegalArgumentException - if the configuredWaitStrategy is not one of Blocking, Sleeping, Yielding or BusySpin.

waitStrategyToStr

public static final String waitStrategyToStr(com.lmax.disruptor.WaitStrategy waitStrategy)

Convert a disruptor wait strategy to a string

createSingleConsumerDisruptor

public static final <T> com.lmax.disruptor.dsl.Disruptor<T> createSingleConsumerDisruptor(com.lmax.disruptor.EventFactory<T> eventFactory,
                                                                                          int size,
                                                                                          ThreadFactory threadFactory,
                                                                                          com.lmax.disruptor.dsl.ProducerType producerType,
                                                                                          com.lmax.disruptor.WaitStrategy waitStrategy,
                                                                                          com.lmax.disruptor.EventHandler<T> eventHandler)

Create a single consumer disruptor

Parameters:

eventFactory - The event factory to use

size - The disruptor size

threadFactory - The thread factory to use to create consumer thread

producerType - The producer type

waitStrategy - The wait strategy to use

eventHandler - The handler of the events passed through the disruptor