watcher

Documentation

Overview

Package watcher implements filesystem notification,.

Index

• Constants
• func DefaultIgnorePathFn(path string) bool
• func SetWatchDelay(delay time.Duration)
• type FileEvent
  • func (fe *FileEvent) String() string
• type Watcher
  • func NewWatcher(bufferSize int) (watcher *Watcher, err error)
  • func (w *Watcher) Close() error
  • func (w *Watcher) GetErrorChan() chan error
  • func (w *Watcher) GetEventChan() chan *FileEvent
  • func (w *Watcher) SetIgnorePathFn(fn func(string) bool)
  • func (w *Watcher) Start()
  • func (w *Watcher) WatchRecursive(path string) error

Constants

const (
	// NONE means no event, initial state.
	NONE = iota
	// CREATED means file was created.
	CREATED
	// DELETED means file was deleted.
	DELETED
	// MODIFIED means file was modified.
	MODIFIED
	// PERM means changed permissions
	PERM
	// NOEXIST means file does not exist.
	NOEXIST
	// NOPERM means no permissions for the file (see const block comment).
	NOPERM
	// INVALID means any type of error not represented above.
	INVALID
)

const (
	// IgnoreThresholdRange is the amount of time in ns to ignore when
	// receiving watch events for the same file
	IgnoreThresholdRange = 50 * 1000000 // convert to ms
)

Functions

func DefaultIgnorePathFn

func DefaultIgnorePathFn(path string) bool

DefaultIgnorePathFn checks whether a path is ignored. Currently defaults to hidden files on *nix systems, ie they start with a ".".

func SetWatchDelay

func SetWatchDelay(delay time.Duration)

SetWatchDelay sets the watch delay

Types

type FileEvent

type FileEvent struct {
	Event    int
	Path     string
	UnixNano int64
}

FileEvent is a wrapper around github.com/howeyc/fsnotify.FileEvent

func (*FileEvent) String

func (fe *FileEvent) String() string

String returns an eye friendly version of this event.

type Watcher

type Watcher struct {
	*fswatch.Watcher
	Event chan *FileEvent
	Error chan error
	//default ignore all file start with "."
	IgnorePathFn func(path string) bool
	//default is nil,if is nil ,error send through Error chan,if is not nil,error handle by this func
	ErrorHandler func(err error)
	// contains filtered or unexported fields
}

Watcher is a wrapper around which adds some additional features:

- recursive directory watch - buffer to even chan - even time

Original work from https://github.com/bronze1man/kmg

func NewWatcher

func NewWatcher(bufferSize int) (watcher *Watcher, err error)

NewWatcher creates an instance of watcher.

func (*Watcher) Close

func (w *Watcher) Close() error

Close closes the watcher channels.

func (*Watcher) GetErrorChan

func (w *Watcher) GetErrorChan() chan error

GetErrorChan gets error chan.

func (*Watcher) GetEventChan

func (w *Watcher) GetEventChan() chan *FileEvent

GetEventChan gets event chan.

func (*Watcher) SetIgnorePathFn

func (w *Watcher) SetIgnorePathFn(fn func(string) bool)

SetIgnorePathFn sets the function which determines if a path should be skipped when watching.

func (*Watcher) Start

func (w *Watcher) Start()

Start starts the watcher

func (*Watcher) WatchRecursive

func (w *Watcher) WatchRecursive(path string) error

WatchRecursive watches a directory recursively. If a dir is created within directory it is also watched.