README
¶
fswatch
fswatch is a go library for watching file system changes to does not depend on inotify.
Motivation
Why not use inotify? Even though there are great libraries like fsnotify that offer cross platform file system change notifications - the approach breaks when you want to watch a lot of files or folder.
For example the default ulimit for Mac OS is set to 512. If you need to watch more files you have to increase the ulimit for open files per process. And this sucks.
Usage
Watching a single file
If you want to watch a single file use the NewFileWatcher function to create a new file watcher:
go func() {
fileWatcher := fswatch.NewFileWatcher("Some-file").Start()
for fileWatcher.IsRunning() {
select {
case <-fileWatcher.Modified:
go func() {
// file changed. do something.
}()
case <-fileWatcher.Moved:
go func() {
// file moved. do something.
}()
}
}
}()
Watching a folder
To watch a whole folder for new, modified or deleted files you can use the NewFolderWatcher function.
Parameters:
- The directory path
- A flag indicating whether the folder shall be watched recursively
- An expression which decides which files are skipped
go func() {
recurse := true
skipNoFile := func(path string) bool {
return false
}
folderWatcher := fswatch.NewFolderWatcher("some-directory", recurse, skipNoFile).Start()
for folderWatcher.IsRunning() {
select {
case <-folderWatcher.Change:
go func() {
// some file changed, was added, moved or deleted.
}()
}
}
}()
Build Status
Contribute
If you have an idea
- how to reliably increase the limit for the maximum number of open files from within the application
- how to overcome the limitations of inotify without having to resort to checking the files for changes over and over again
- or how to make the existing code more efficient
please send me a message or a pull request. All contributions are welcome.
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type FileWatcher ¶
type FileWatcher struct {
Modified chan bool
Moved chan bool
Stopped chan bool
// contains filtered or unexported fields
}
func NewFileWatcher ¶
func NewFileWatcher(filePath string) *FileWatcher
func (*FileWatcher) IsRunning ¶
func (fileWatcher *FileWatcher) IsRunning() bool
func (*FileWatcher) SetFile ¶
func (fileWatcher *FileWatcher) SetFile(filePath string)
func (*FileWatcher) Start ¶
func (fileWatcher *FileWatcher) Start() *FileWatcher
func (*FileWatcher) Stop ¶
func (fileWatcher *FileWatcher) Stop() *FileWatcher
func (*FileWatcher) String ¶
func (fileWatcher *FileWatcher) String() string
type FolderChange ¶
type FolderChange struct {
// contains filtered or unexported fields
}
func (*FolderChange) Moved ¶
func (folderChange *FolderChange) Moved() []string
func (*FolderChange) New ¶
func (folderChange *FolderChange) New() []string
func (*FolderChange) String ¶
func (folderChange *FolderChange) String() string
func (*FolderChange) TimeStamp ¶
func (folderChange *FolderChange) TimeStamp() time.Time
type FolderWatcher ¶
type FolderWatcher struct {
Change chan *FolderChange
Stopped chan bool
// contains filtered or unexported fields
}
func NewFolderWatcher ¶
func NewFolderWatcher(folderPath string, recurse bool, skipFile func(path string) bool) *FolderWatcher
func (*FolderWatcher) IsRunning ¶
func (folderWatcher *FolderWatcher) IsRunning() bool
func (*FolderWatcher) Start ¶
func (folderWatcher *FolderWatcher) Start() *FolderWatcher
func (*FolderWatcher) Stop ¶
func (folderWatcher *FolderWatcher) Stop() *FolderWatcher
func (*FolderWatcher) String ¶
func (folderWatcher *FolderWatcher) String() string
Source Files