Skip to content

README.md

Latest commit

 

History

History
128 lines (90 loc) · 4.02 KB

README.md

File metadata and controls

128 lines (90 loc) · 4.02 KB

FastFileWatch v0.1.0 [ALPHA] — High-Performance Native File Monitoring for Java

Status License: MIT Java Platform JitPack

⚡ A zero-latency file system monitoring module for the FastJava ecosystem. Real-time events for file creation, modification, and deletion via ReadDirectoryChangesW.

FastFileWatch provides instant notification of file system changes. By using direct Win32 API hooks, it eliminates the polling and latency associated with standard Java WatchService.

5–12× faster than Java's Float.parseFloat / Double.parseDouble. Zero-GC. SIMD-accelerated. Ryu-powered formatting. JSON/CSV/telemetry parsing without garbage collection overhead.

FastKeyboard Showcase

Table of Contents

Features

  • ⚡ Instant Events: Real-time notification via native Windows hooks.
  • 🔎 Low Overhead: Efficient monitoring without periodic polling.
  • 📦 Recursive Support: High-performance monitoring of entire directory trees.
  • 🚀 Raw Speed: Built for real-time indexing and automation tools.

Installation

Option 1: Maven (Recommended)

Add the JitPack repository and the dependencies to your pom.xml:

<repositories>
    <repository>
        <id>jitpack.io</id>
        <url>https://jitpack.io</url>
    </repository>
</repositories>
<dependencies>
   <dependency>
       <groupId>com.github.andrestubbe</groupId>
       <artifactId>fastfilewatch</artifactId>
       <version>v0.1.0</version>
   </dependency>
   <dependency>
       <groupId>com.github.andrestubbe</groupId>
       <artifactId>fastcore</artifactId>
       <version>v0.1.0</version>
   </dependency>
</dependencies>

Option 2: Gradle (via JitPack)

repositories {
    maven { url 'https://jitpack.io' }
}
dependencies {
    implementation 'com.github.andrestubbe:fastfilewatch:v0.1.0'
    implementation 'com.github.andrestubbe:fastcore:v0.1.0'
}

Option 3: Direct Download (No Build Tool)

Download the latest JARs directly to add them to your classpath:

  1. 📦 * *fastfilewatch-v0.1.0.jar ** (The Core Library)
  2. ⚙️ fastcore-v0.1.0.jar ( The Mandatory Native Loader)

Documentation

  • COMPILE.md: Full compilation guide (MSVC C++17 build chain + JNI Setup).
  • REFERENCE.md: Full API descriptions, border configurations, and codepoint index.
  • PHILOSOPHIE.md: The engineering rationale for zero-allocation performance.
  • ROADMAP.md: Future milestones and planned features.

Platform Support

Platform Status
Windows 10/11 ✅ Fully Supported
Linux 🚧 Planned
macOS 🚧 Planned

License

MIT License — See LICENSE file for details.

Related Projects

Part of the FastJava Ecosystem — Making the JVM faster. Small package. Maximum speed. Zero bloat. 🚀📋