hinotify-bytestring: Haskell binding to inotify, using ByteString filepaths

This is a package candidate release! Here you can preview how this package release will appear once published to the main package index (which can be accomplished via the 'maintain' link below). Please note that once a package has been published to the main package index it cannot be undone! Please consult the package uploading documentation for more information.

[maintain] [Publish]

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. Filepaths are represented as ByteStrings.

[Skip to Readme]

Properties

Versions	0.3.8.1, 0.3.8.1
Change log	CHANGELOG.md
Dependencies	base (>=4.5.0.0 && <5), bytestring, containers, directory, unix [details]
License	BSD-3-Clause
Author	Lennart Kolmodin
Maintainer	Julian Ospald <hasufell@posteo.de>
Category	System
Home page	https://github.com/hasufell/hinotify-bytestring.git
Source repo	head: git clone git://github.com/hasufell/hinotify-bytestring.git
Uploaded	by maerwald at 2016-05-01T02:15:39Z

Modules

[Index]

System
- System.INotify

Downloads

hinotify-bytestring-0.3.8.1.tar.gz [browse] (Cabal source package)
Package description (as included in the package)

Maintainer's Corner

Package maintainers

maerwald

For package maintainers and hackage trustees

edit package information

Readme for hinotify-bytestring-0.3.8.1

[back to package description]

hinotify-bytestring: inotify for Haskell using ByteString for filepaths

About

hinotify-bytestring, 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-bytestring.

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
         -> ByteString       -- file/directory to watch
         -> (Event -> IO ()) -- event handler
         -> IO WatchDescriptor
removeWatch :: WatchDescriptor -> IO ()

A sample program:

{-# LANGUAGE OverloadedStrings #-}

import System.Posix.Env.ByteString
import System.IO

import System.INotify

main :: IO ()
main = do
  inotify <- initINotify
  print inotify
  home <- getEnvDefault "HOME" "/home"
  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:

git clone https://github.com/hasufell/hinotify-bytestring.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.