Skip to content

Commit

Permalink
Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
adamw committed Jan 5, 2024
1 parent b88e116 commit a5b80c2
Showing 1 changed file with 5 additions and 6 deletions.
11 changes: 5 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,14 @@
# jox

Fast and Scalable Channels in Java.

Designed to be used with [Project Loom](https://openjdk.org/projects/loom/).
Fast and Scalable Channels in Java. Designed to be used with Java 21+ and virtual threads,
see [Project Loom](https://openjdk.org/projects/loom/).

Inspired by the "Fast and Scalable Channels in Kotlin Coroutines" [paper](https://arxiv.org/abs/2211.04986), and
the [Kotlin implementation](https://github.com/Kotlin/kotlinx.coroutines/blob/master/kotlinx-coroutines-core/common/src/channels/BufferedChannel.kt).

Articles:

* [Announcing jox: Fast and Scalable Channels in Java](https://softwaremill.com/announcing-jox-fast-and-scalable-channels-in-java/).
* [Announcing jox: Fast and Scalable Channels in Java](https://softwaremill.com/announcing-jox-fast-and-scalable-channels-in-java/)

## Dependencies

Expand Down Expand Up @@ -46,8 +45,8 @@ import com.softwaremill.jox.Channel;
class Demo1 {
public static void main(String[] args) throws InterruptedException {
// creates a rendezvous channel
// (buffer of size 0 - a sender & receiver must meet to pass a value)
var ch = new Channel<Integer>(0);
// (a sender & receiver must meet to pass a value: as if the buffer had size 0)
var ch = new Channel<Integer>();

Thread.ofVirtual().start(() -> {
try {
Expand Down

1 comment on commit a5b80c2

@github-actions
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Performance Alert ⚠️

Possible performance regression was detected for benchmark.
Benchmark result of this commit is worse than the previous benchmark result exceeding threshold 1.20.

Benchmark suite Current: a5b80c2 Previous: 5d2095a Ratio
com.softwaremill.jox.SelectBenchmark.channel 356.9499857352263 ns/op 224.42621859743005 ns/op 1.59
com.softwaremill.jox.RendezvousKotlinBenchmark.sendReceiveUsingDefaultDispatcher 247.26772502063488 ns/op 142.68464331587302 ns/op 1.73

This comment was automatically generated by workflow using github-action-benchmark.

CC: @adamw

Please sign in to comment.