NoOpIdleStrategy doc improvement.

real-logic · Oct 24, 2024 · 7585646 · 7585646
1 parent df476c7
commit 7585646
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/agrona/src/main/java/org/agrona/concurrent/NoOpIdleStrategy.java b/agrona/src/main/java/org/agrona/concurrent/NoOpIdleStrategy.java
@@ -18,6 +18,15 @@
 /**
  * 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.
+ * <p>
+ * The NoOpIdleStrategy should be used with care:
+ * <ol>
+ *     <li>It could increase power consumption.</li>
+ *     <li>The increased power consumption could lead to thermal throttling causing an overall performance drop.</li>
+ *     <li>It could consume resources that otherwise would be used by the hyper-sibling.</li>
+ *     <li>It could lead to a memory order violation at the end of the loop causing a pipeline reset.</li>
+ * </ol>
+ * The {@link BusySpinIdleStrategy} might be a better alternative in some scenario's.
  */
 public final class NoOpIdleStrategy implements IdleStrategy
 {