Fixes #284 Add support for Thread.onSpinWait() while spinning

README.md

@@ -1,4 +1,7 @@
-[![Coverage Status](https://coveralls.io/repos/github/JCTools/JCTools/badge.svg?branch=master)](https://coveralls.io/github/JCTools/JCTools?branch=master) [![Build Status](https://travis-ci.org/JCTools/JCTools.svg?branch=master)](https://travis-ci.org/JCTools/JCTools) [![Gitter](https://badges.gitter.im/JCTools/JCTools.svg)](https://gitter.im/JCTools/JCTools?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
+[![Total alerts](https://img.shields.io/lgtm/alerts/g/JCTools/JCTools.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/JCTools/JCTools/alerts/)
+[![Coverage Status](https://coveralls.io/repos/github/JCTools/JCTools/badge.svg?branch=master)](https://coveralls.io/github/JCTools/JCTools?branch=master)
+[![Build Status](https://travis-ci.org/JCTools/JCTools.svg?branch=master)](https://travis-ci.org/JCTools/JCTools)
+[![Gitter](https://badges.gitter.im/JCTools/JCTools.svg)](https://gitter.im/JCTools/JCTools?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
 
 JCTools
 ==========
@@ -18,7 +21,8 @@ the JDK:
 
 There's more to come and contributions/suggestions are most welcome. JCTools has enjoyed support from the community
 and contributions in the form of issues/tests/documentation/code have helped it grow.
-JCTools offers excellent performance at a reasonable price (FREE! under the Apache 2.0 License). It's stable and in use by such distinguished frameworks as Netty, RxJava and others. JCTools is also used by commercial products to great result.
+JCTools offers excellent performance at a reasonable price (FREE! under the Apache 2.0 License). It's stable and in
+use by such distinguished frameworks as Netty, RxJava and others. JCTools is also used by commercial products to great result.
 
 Get it NOW!
 ==========
@@ -27,7 +31,7 @@ Add the latest version as a dependency using Maven:
         <dependency>
             <groupId>org.jctools</groupId>
             <artifactId>jctools-core</artifactId>
-            <version>2.1.1</version>
+            <version>3.0.0</version>
         </dependency>
 ```
 
@@ -44,11 +48,11 @@ And setup the following dependency:
         <dependency>
             <groupId>com.github.JCTools.JCTools</groupId>
             <artifactId>jctools-core</artifactId>
-            <version>v2.1.1</version>
+            <version>v3.0.0</version>
         </dependency>
 ```
 
-You can also depend on latest snapshot from this repository (live on the edge) by setting the version to '2.2-SNAPSHOT'.
+You can also depend on latest snapshot from this repository (live on the edge) by setting the version to '3.0.1-SNAPSHOT'.
 
 
 Build it from source

RELEASE-NOTES.md

@@ -1,3 +1,33 @@
+3.0.0
+=========
+This is a major version as there are some minor API breaking changes which may effect users. Please apply with care and provide feedback. The breaking changes:
+
+Removed MpscLinkedQueue7 and MpscLinkedQueue8 and consolidate into parent. This removes the need for the builder method on MpscLinkedQueue.
+Deprecated QueueFactory and spec package classes. These are not used by any users AFAICT and are only used for testing internally.
+Removed some internal classes and reduced visibility of internal utilities where practical. The @InternalAPI tagging annotation is also used more extensively to discourage dependency.
+We also have some great new queues for y'all to try:
+- #226: XADD unbounded mpsc/mpmc queue: highly scalable linked array queues
+ (from @franz1981)
+- New blocking consumer MPSC (with contributions and bug fixes from @njhill)
+
+Bug fixes:
+- #209: On Arm7, non-volatile long can have unaligned address leading to error
+- #216: Size of SpscGrowableArrayQueue can exceeds max capacity (from @franz1981 PR #218)
+- #241: Protect the producer index in case of OutOfMemoryError (from @franz1981)
+- #244: Long NBHM AssertionError when replacing missing key (thanks @fvlad for reporting and @cliffclick for assistance and review)
+- Fix argument checks on fill/drain methods
+- Fix LGTM warning, potential int overflow bug b467d29, 15d944c, 6367951
+
+Improvements:
+- Don't mark generated linked atomic queues as final (from @kay 9db418c)
+- #211: Implement batching methods on MpmcArrayQueue (from @franz1981)
+- #228: Iterator for MpscArrayQueue and MpscUnboundedArrayQueue (PR #229 from @srdo)
+- Iterator support also available for the *ArrayQueue classes
+- #208: MpscLinkedAtomicQueue can be made not final
+- #237: Add scale to exception message to help debug netty/netty#8916 (from @johnou)
+
+Many other improvements to testing, javadoc, formatting were made with some contributions from @Hearen @JanStureNielsen @nastra thanks!
+
 2.1.2
 =========
 - PR #202 : Fix NBHM bug in remove/replace where ref equality was used to report val match instead of equals (thanks @henri-tremblay)

jctools-benchmarks/pom.xml

@@ -4,7 +4,7 @@
     <parent>
         <groupId>org.jctools</groupId>
         <artifactId>jctools-parent</artifactId>
-        <version>3.0-SNAPSHOT</version>
+        <version>3.0.1-SNAPSHOT</version>
     </parent>
 
     <artifactId>jctools-benchmarks</artifactId>

jctools-benchmarks/src/main/java/org/jctools/jmh/baseline/QueueOfferPoll.java

@@ -21,9 +21,9 @@
 
 /**
  * Measure cost of offer/poll on single thread.
- * 
+ *
  * @author nitsanw
- * 
+ *
  */
 @State(Scope.Thread)
 @BenchmarkMode(Mode.AverageTime)
@@ -39,7 +39,7 @@ public class QueueOfferPoll {
     @Param(value = "1")
     int burstSize;
     Queue<Integer> q;
-    
+
     @Setup(Level.Trial)
     public void createQ() {
         q = QueueByTypeFactory.createQueue(qType, qCapacity);
@@ -51,7 +51,7 @@ public int offerAndPollLoops() {
         for (int i = 0; i < burstSize; i++) {
             q.offer(DUMMY_MESSAGE);
         }
-        Integer result = null;
+        Integer result = DUMMY_MESSAGE;
         for (int i = 0; i < burstSize; i++) {
             result = q.poll();
         }