NuProcess Documentation

Benchmarks are executed using the benchmark.sh script located in the ./benchmark directory. To run a standard quick benchmark, navigate to the directory and execute the script with the quick argument.

cd ./benchmark
./benchmark.sh quick

Before running the JMH benchmarks, you must ensure that the primary NuProcess library is built and installed in your local Maven repository. Run the following command from the project root:

mvn clean install

NuProcess provides different versions based on your Java runtime.

For Java 25 or newer, use version 4.x. For Java versions prior to 25, use the JNA-based 3.x release.

Note that versions 1.0.0 and above contain breaking API changes from 0.9.7.

<!-- For Java 25+ -->
<dependency>
    <groupId>com.zaxxer</groupId>
    <artifactId>nuprocess</artifactId>
    <version>4.0.0</version>
    <scope>compile</scope>
</dependency>

<!-- For Java < 25 -->
<dependency>
    <groupId>com.zaxxer</groupId>
    <artifactId>nuprocess</artifactId>
    <version>3.0.0</version>
    <scope>compile</scope>
</dependency>

The following options are available for the benchmark.sh script:

• clean: Recompile the benchmark.
• -t <threads>: Execute JMH with the specified number of threads.
• quick: A "quick" run of the benchmark; fewer iterations and forks.
• medium: A "medium" run of the benchmark; more iterations and forks.
• long: A "long" run of the benchmark; maximum iterations and forks.
• profile: Start JMH such as to allow attaching JProfiler (MacOS).
• debug: Start JMH such as to allow the attachment of a debugger.

The benchmark.sh script supports several flags to control the execution environment, thread count, and benchmark duration/depth.

benchmark.sh [clean] [-t <threads>] [quick|medium|long|profile|debug]