puppetlabs.trapperkeeper.services.protocols.filesystem-watch-service
Eventclj
Schema for an event on a file watched by this service.
Schema for an event on a file watched by this service.
FilesystemWatchServicecljprotocol
create-watcherclj
(create-watcher this)(create-watcher this options)Returns a Watcher which can be used to initiate watching of a directory on the filesystem. Available options are:
- :recursive (true | false) - If true, callbacks will be invoked when dir or any file underneath dir, including files within nested directories of dir, changes. If false, callbacks will be invoked when any file inside of dir changes. Note that on some implementations, modifying the contents of a directory is considered a change to the directory itself (platform-specific)
Returns a Watcher which can be used to initiate watching of a directory on
the filesystem. Available options are:
* :recursive (true | false) - If true, callbacks will be invoked when dir or any file
underneath dir, including files within nested directories of
dir, changes. If false, callbacks will be invoked when any
file inside of dir changes. Note that on some implementations,
modifying the contents of a directory is considered a change
to the directory itself (platform-specific)Watchercljprotocol
add-callback!clj
(add-callback! this callback)Adds a callback to a Watcher. The callback will be invoked when any watched directories change. The callback will be passed a sequence of Events as its only argument. The exact events passed to the callback are unspecified, left up to the implementation, and possibly platform-dependent; however, the following events are guaranteed to be passed to the callback
- an event of :type :create with :path p, when a file is created at path p
- an event of :type :modify with :path p, when the contents of a file at path p are modified
- an event of :type :delete with :path p, when a file is deleted at path p
Note that, for any of those particular changes, there may also be additional events passed to the callback, such as events on a parent directory of a changed file.
Adds a callback to a Watcher. The callback will be invoked when any watched directories change. The callback will be passed a sequence of Events as its only argument. The exact events passed to the callback are unspecified, left up to the implementation, and possibly platform-dependent; however, the following events are guaranteed to be passed to the callback * an event of :type :create with :path p, when a file is created at path p * an event of :type :modify with :path p, when the contents of a file at path p are modified * an event of :type :delete with :path p, when a file is deleted at path p Note that, for any of those particular changes, there may also be additional events passed to the callback, such as events on a parent directory of a changed file.
add-watch-dir!clj
(add-watch-dir! this dir)(add-watch-dir! this dir options)Given a directory on the filesystem, initiate watching of dir. The watcher's callbacks will be invoked when dir changes. Available options are:
- :recursive true - [deprecated] If true, callbacks will be invoked when dir or any file
underneath dir changes. Passing options to this function is deprecated -
pass
recursiveoption to create-watcher function of the FilesystemWatchService protocol instead.
When dir is deleted, the behavior is unspecified, left up to the implementation, and may be platform-specific.
Given a directory on the filesystem, initiate watching of dir. The
watcher's callbacks will be invoked when dir changes. Available options are:
* :recursive true - [deprecated] If true, callbacks will be invoked when dir or any file
underneath dir changes. Passing options to this function is deprecated -
pass `recursive` option to create-watcher function of the
FilesystemWatchService protocol instead.
When dir is deleted, the behavior is unspecified, left up to the
implementation, and may be platform-specific.cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close