fnotify

Documentation

Index

• Constants
• type Notifier
  • func New(name string) *Notifier
  • func (n *Notifier) Close() error
  • func (n *Notifier) Notify(files []string, res chan<- string) error

Constants

const (
	// DefaultDebounce is how long to wait after a file change notification
	// before firing an event.
	DefaultDebounce = 250 * time.Millisecond

	// DefaultRemonitorDelay is how long to wait after a file is removed to see
	// if it will reappear and must be remonitored.
	DefaultRemonitorDelay = 500 * time.Millisecond
)

Types

type Notifier

type Notifier struct {
	Debounce       time.Duration
	RemonitorDelay time.Duration
	// contains filtered or unexported fields
}

A Notifier monitors files on a local filesystem for changes.

func New

func New(name string) *Notifier

New creates a file change notifier named name.

func (*Notifier) Close

func (n *Notifier) Close() error

Close shuts down the notifier asynchronously.

func (*Notifier) Notify

func (n *Notifier) Notify(files []string, res chan<- string) error

Notify synchronously watches the list of files for changes, writing changed filenames to res. Notify blocks unless monitoring fails, so it must be run in a goroutine.