org.agrona.concurrent

Class ControllableIdleStrategy

java.lang.Object

org.agrona.concurrent.ControllableIdleStrategy

All Implemented Interfaces:

IdleStrategy

public class ControllableIdleStrategy
extends java.lang.Object
implements IdleStrategy

Field Summary

Fields

Modifier and Type	Field and Description
static int	BUSY_SPIN
static int	NOOP
static int	NOT_CONTROLLED
static int	PARK
static int	YIELD

Constructor Summary

Constructors

Constructor and Description
ControllableIdleStrategy(StatusIndicatorReader statusIndicatorReader)

Method Summary

Modifier and Type	Method and Description
void	idle() Perform current idle action (e.g.
void	idle(int workCount) Idle based on current status indication value
void	reset() Reset the internal state in preparation for entering an idle state again.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

NOT_CONTROLLED

public static final int NOT_CONTROLLED

See Also:

Constant Field Values

NOOP

public static final int NOOP

See Also:

Constant Field Values

BUSY_SPIN

public static final int BUSY_SPIN

See Also:

Constant Field Values

YIELD

public static final int YIELD

See Also:

Constant Field Values

PARK

public static final int PARK

See Also:

Constant Field Values

Constructor Detail

ControllableIdleStrategy

public ControllableIdleStrategy(StatusIndicatorReader statusIndicatorReader)

Method Detail

idle

public void idle(int workCount)

Idle based on current status indication value

Specified by:

idle in interface IdleStrategy

Parameters:

workCount - performed in last duty cycle.

See Also:

IdleStrategy.idle(int)

idle

public void idle()

Perform current idle action (e.g. nothing/yield/sleep). To be used in conjunction with IdleStrategy.reset() to clear internal state when idle period is over (or before it begins). Callers are expected to follow this pattern:

 
 while (isRunning)
 {
   if (!hasWork())
   {
     idleStrategy.reset();
     while (!hasWork())
     {
       if (!isRunning)
       {
         return;
       }
       idleStrategy.idle();
     }
   }
   doWork();
 }
 
 

Specified by:

idle in interface IdleStrategy

reset

public void reset()

Reset the internal state in preparation for entering an idle state again.

Specified by:

reset in interface IdleStrategy

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object