hinotify: Haskell binding to inotify

[ bsd3, library, system ] [ Propose Tags ] [ Report a vulnerability ]

This library provides a wrapper to the Linux Kernel's inotify feature, allowing applications to subscribe to notifications when a file is accessed or modified.

[Skip to Readme]

Modules

[Index] [Quick Jump]

System
- System.INotify

Downloads

hinotify-0.4.tar.gz [browse] (Cabal source package)
Package description (revised from the package)

Note: This package has metadata revisions in the cabal description newer than included in the tarball. To unpack the package including the revisions, use 'cabal get'.

Maintainer's Corner

Package maintainers

DonaldStewart, LennartKolmodin, thomasjm

For package maintainers and hackage trustees

edit package information

Candidates

No Candidates

Versions [RSS]	0.1, 0.2, 0.3, 0.3.1, 0.3.2, 0.3.3, 0.3.4, 0.3.5, 0.3.6, 0.3.7, 0.3.8, 0.3.8.1, 0.3.9, 0.3.10, 0.4, 0.4.1, 0.4.2 (info)
Change log	CHANGELOG.md
Dependencies	async (>=2 && <3), base (>=4.5.0.0 && <4.20.0.0), bytestring, containers, unix [details]
License	BSD-3-Clause
Author	Lennart Kolmodin
Maintainer	Lennart Kolmodin <kolmodin@gmail.com>
Uploaded	by LennartKolmodin at 2018-08-09T12:01:36Z
Revised	Revision 1 made by thomasjm at 2025-02-24T10:32:46Z
Category	System
Home page	https://github.com/kolmodin/hinotify.git
Source repo	head: git clone git://github.com/kolmodin/hinotify.git
Distributions	Arch:0.4.2, Debian:0.4, Fedora:0.4.2, FreeBSD:0.3.8.1, LTSHaskell:0.4.2, NixOS:0.4.2, Stackage:0.4.2, openSUSE:0.4.2
Reverse Dependencies	21 direct, 227 indirect [details]
Downloads	77126 total (48 in the last 30 days)
Rating	(no votes yet) [estimated by Bayesian average]
Your Rating	λ λ λ
Status	Docs available [build log] Last success reported on 2018-08-09 [all 1 reports]

Readme for hinotify-0.4

[back to package description]

hinotify: inotify for Haskell

About

hinotify, a library to inotify which has been part of the Linux kernel since 2.6.13.

inotify provides file system event notification, simply add a watcher to a file or directory and get an event when it is accessed or modified.

This module is named hinotify.

See example code in the examples directory, distributed with the source code.

News

hinotify 0.3.7

Bug fix: When registerering a new watch on a path which is already watched, don't overwrite the event listener from the previous watch.

hinotify 0.3.2

Make each WatchDescriptor contain its INotify. Changes to the function types:

 -removeWatch :: INotify -> WatchDescriptor -> IO ()
 +removeWatch :: WatchDescriptor -> IO ()

Fix typo in declaration of Deleted in data Event;

 - { isDirecotry :: Bool
 + { isDirectory :: Bool

hinotify 0.3.1

Use inotify.h from glibc rather than from the linux headers, as recommended upstream.

hinotify 0.3

Compiles with GHC 6.12, GHC 6.10.4, GHC 6.8.2 and GHC 6.6.1

hinotify 0.2

Updates to the API
- Function names is now in semiCamelCase
- Restructure event parameters to make it more consistent
Small test suit in tests/
Compiles with GHC 6.8.2 and GHC 6.6.1
Requires Cabal 1.2

hinotify 0.1 : Initial release

API

The API basically consists of:

initINotify :: IO INotify
addWatch :: INotify
         -> [EventVariety]   -- different events to listen on
         -> FilePath         -- file/directory to watch
         -> (Event -> IO ()) -- event handler
         -> IO WatchDescriptor
removeWatch :: WatchDescriptor -> IO ()

A sample program:

import System.Directory
import System.IO

import System.INotify

main :: IO ()
main = do
  inotify <- initINotify
  print inotify
  home <- getHomeDirectory
  wd <- addWatch
          inotify
          [Open,Close,Access,Modify,Move]
          home
          print
  print wd
  putStrLn "Listens to your home directory. Hit enter to terminate."
  getLine
  removeWatch wd

Download

The code is available via the homepage, and via darcs:

git clone https://github.com/kolmodin/hinotify.git

The API is available online.

I'm most grateful for feedback on the API, and what else you might have to suggest.

Author

Lennart Kolmodin

kolmodin at gmail.com

Legal

This software is released under a BSD-style license. See LICENSE for more details.