Class | FChange::Watcher |
In: |
lib/vendor/windows/lib/rb-fchange/watcher.rb
|
Parent: | Object |
Watchers monitor a single path for changes, specified by {FChange::Notifier#watch event flags}. A watcher is usually created via \{Notifier#watch}.
One {Notifier} may have many {Watcher}s. The Notifier actually takes care of the checking for events, via \{Notifier#run run} or \{Notifier#process process}. The main purpose of having Watcher objects is to be able to disable them using \{close}.
flags | [R] |
The {FChange::Notifier#watch flags}
specifying the events that this Watcher is
watching for, and potentially some options as well.
@return [Array<Symbol>] |
id | [R] |
The id for this Watcher. Used to retrieve this
Watcher from {Notifier#watchers}.
@private @return [Fixnum] |
notifier | [R] |
The {Notifier} that this Watcher belongs to.
@return [Notifier] |
path | [R] |
The path that this Watcher is watching.
@return [String] |
recursive | [R] | @private @return [Boolean] |
@private @see Notifier#watch
Disables this Watcher, so that it doesn‘t fire any more events.
@raise [SystemCallError] if the watch fails to be disabled for some reason