FileMaestro/net.exoad.filemaestro.shared/FolderWatchdog

FolderWatchdog

A thin wrapper on top of java.nio.file.WatchService in the JDK to allow for easier controls with the maestro daemon in watching directory changes using a dedicated thread to avoid blocking.

A lot of the implementation is "inspired" from the official examples

Properties

foldersWatching

val foldersWatching: Collection<Path>

foldersWatchingCount

val foldersWatchingCount: Int

Functions

attachGlobalListener

fun attachGlobalListener(listener: (path: Path, newFile: Path) -> Unit)

detachGlobalListener

fun detachGlobalListener()

isRunning

fun isRunning(): Boolean

isSubscribed

fun isSubscribed(folder: Path): Boolean

isWatching

fun isWatching(path: Path): Boolean

fun register()

Initializes the service to start and prepares it for start to be called.

start

fun start()

Actually start polling for updates from the list of registered paths to watch in a separate thread.

stop

fun stop()

Stops the service and the associated thread.

stopWatching

fun stopWatching(folder: Path)

The watch key and also any potential listeners are removed

fun subscribe(folder: Path, listener: (newFile: Path) -> Unit)

subscribeIfNot

fun subscribeIfNot(folder: Path, listener: (newFile: Path) -> Unit)

unregister

fun unregister()

Removes everything and should be called after stop

unsubscribe

fun unsubscribe(folder: Path)

Removes the listener for folder if applicable.

watch

fun watch(path: Path)

Schedules a new folder provided by path to be watched by this service.

watchIfNot

fun watchIfNot(path: Path)

Calls watch on path if the watchdog isn't already watching path