Skip to content

Latest commit

 

History

History
63 lines (41 loc) · 1.79 KB

readme.md

File metadata and controls

63 lines (41 loc) · 1.79 KB
Raw

Jasyncfio

Build

Jasyncfio provides an asynchronous file I/O API based on the Linux io_uring interface.

Jasyncfio Features

  • Fully asynchronous io_uring based file I/O API
  • API comes in two kinds: Buffered and Direct I/O
  • API for linear access to file (depends on your file system)
  • Using a wide range of io_uring features such as polling, registered buffers/files

Examples

EventExecutor eventExecutor = EventExecutor.initDefault();

CompletableFuture<AsyncFile> asyncFileCompletableFuture = AsyncFile.open(Paths.get("path/to/file"), eventExecutor);
AsyncFile file = asyncFileCompletableFuture.get();

ByteBuffer byteBuffer = ByteBuffer.allocateDirect(1024);
CompletableFuture<Integer> readCompletableFuture = file.read(byteBuffer);

Integer readBytes = readCompletableFuture.get();

If you want to dive deeper, there are more examples with explanations on the wiki.

Download

Releases are available at Maven Central.

Since the library uses native code, it is necessary to specify the classifier. At the moment there are releases only for linux-amd64, there are plans to support linux-arm64.

Requirements

  • Linux Kernel >= 5.11
  • Java >= 8

Maven

<dependency>
    <groupId>one.jasyncfio</groupId>
    <artifactId>jasyncfio</artifactId>
    <version>0.0.8</version>
    <classifier>linux-amd64</classifier>
</dependency>

Gradle Groovy DSL

implementation 'one.jasyncfio:jasyncfio:0.0.8:linux-amd64'

Gradle Kotlin DSL

implementation("one.jasyncfio:jasyncfio:0.0.8:linux-amd64")