commit	6258bb8183757d12ef2260ac4a18a7665c0ca4c4	[log] [tgz]
author	Chris Howey <chris@howey.me>	Sat Oct 19 15:48:14 2013
committer	Chris Howey <chris@howey.me>	Sat Oct 19 15:48:14 2013
tree	7d4151cd361116c944ce1f8308e6d2e073f62eca
parent	ba28565193315641e3c44fea039f24fb5d4b239e [diff]

tree: 7d4151cd361116c944ce1f8308e6d2e073f62eca

README.md

File system notifications for Go

Cross platform, works on:

Windows
Linux
BSD
OSX

Example:

package main

import (
	"log"

	"github.com/howeyc/fsnotify"
)

func main() {
	watcher, err := fsnotify.NewWatcher()
	if err != nil {
		log.Fatal(err)
	}

	done := make(chan bool)

	// Process events
	go func() {
		for {
			select {
			case ev := <-watcher.Event:
				log.Println("event:", ev)
			case err := <-watcher.Error:
				log.Println("error:", err)
			}
		}
	}()

	err = watcher.Watch("testDir")
	if err != nil {
		log.Fatal(err)
	}

	<-done

	/* ... do stuff ... */
	watcher.Close()
}

For each event:

Name
IsCreate()
IsDelete()
IsModify()
IsRename()

Notes:

When a file is renamed to another directory is it still being watched?
- No (it shouldn't be, unless you are watching where it was moved to).
When I watch a directory, are all subdirectories watched as well?
- No, you must add watches for any directory you want to watch.
Do I have to watch the Error and Event channels in a separate goroutine?
- As of now, yes. Looking into making this single-thread friendly.
There are OS-specific limits as to how many watches can be created:
- Linux: /proc/sys/fs/inotify/max_user_watches contains the limit, reaching this limit results in a “no space left on device” error.
- BSD / OSX: sysctl variables “kern.maxfiles” and “kern.maxfilesperproc”, reaching these limits results in a “too many open files” error.