Package org.agrona.concurrent
Class NoOpIdleStrategy
java.lang.Object
org.agrona.concurrent.NoOpIdleStrategy
- All Implemented Interfaces:
IdleStrategy
Low-latency idle strategy to be employed in loops that do significant work on each iteration such that any
work in the idle strategy would be wasteful.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
Name to be returned fromalias()
.static final NoOpIdleStrategy
As there is no instance state then this object can be used to save on allocation. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionalias()
Simple name by which the strategy can be identified.void
idle()
Note: this implementation will result in no safepoint poll once inlined.void
idle
(int workCount) Note: this implementation will result in no safepoint poll once inlined.void
reset()
Reset the internal state in preparation for entering an idle state again.toString()
-
Field Details
-
ALIAS
Name to be returned fromalias()
.- See Also:
-
INSTANCE
As there is no instance state then this object can be used to save on allocation.
-
-
Constructor Details
-
NoOpIdleStrategy
public NoOpIdleStrategy()
-
-
Method Details
-
idle
public void idle(int workCount) Note: this implementation will result in no safepoint poll once inlined.Perform current idle action (e.g. nothing/yield/sleep). This method signature expects users to call into it on every work 'cycle'. The implementations may use the indication "workCount > 0" to reset internal backoff state. This method works well with 'work' APIs which follow the following rules:
- 'work' returns a value larger than 0 when some work has been done
- 'work' returns 0 when no work has been done
- 'work' may return error codes which are less than 0, but which amount to no work has been done
Callers are expected to follow this pattern:
while (isRunning) { idleStrategy.idle(doWork()); }
- Specified by:
idle
in interfaceIdleStrategy
- Parameters:
workCount
- performed in last duty cycle.
-
idle
public void idle()Note: this implementation will result in no safepoint poll once inlined.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 interfaceIdleStrategy
-
reset
public void reset()Reset the internal state in preparation for entering an idle state again.- Specified by:
reset
in interfaceIdleStrategy
-
alias
Simple name by which the strategy can be identified.- Specified by:
alias
in interfaceIdleStrategy
- Returns:
- simple name by which the strategy can be identified.
-
toString
-